pradosoft / prado

framework/Web/UI/WebControls/TStyle.php

Indentation +1 added lines, -1 removed lines

@@ -73,7 +73,7 @@
 	 */
 	public function __construct($style=null)
 	{
-    parent::__construct();
+	parent::__construct();
 		if($style!==null)
 			$this->copyFrom($style);
 	}

Doc Comments +4 added lines, -1 removed lines

@@ -228,7 +228,7 @@ 
 	}
 
 	/**
-	 * @return TDisplayStyle display style
+	 * @return string display style
 	 */
 	public function getDisplayStyle()
 	{
@@ -285,6 +285,7 @@ 
 	 * Sets custom style fields from a string.
 	 * Custom style fields will be overwritten by style fields explicitly defined.
 	 * @param string the custom style of the control
+	 * @param string $value
 	 */
 	public function setCustomStyle($value)
 	{
@@ -304,6 +305,8 @@ 
 	 * Style fields set by this method will overwrite those set by {@link setCustomStyle}.
 	 * @param string style field name
 	 * @param string style field value
+	 * @param string $name
+	 * @param string $value
 	 */
 	public function setStyleField($name,$value)
 	{

Spacing +32 added lines, -32 removed lines

@@ -53,16 +53,16 @@ 
 	protected function _getZappableSleepProps(&$exprops)
 	{
 		parent::_getZappableSleepProps($exprops);
-		if ($this->_fields===array())
-			$exprops[] = "\0Prado\Web\UI\WebControls\TStyle\0_fields";
+		if($this->_fields===array())
+			$exprops[]="\0Prado\Web\UI\WebControls\TStyle\0_fields";
 		if($this->_font===null)
-			$exprops[] = "\0Prado\Web\UI\WebControls\TStyle\0_font";
+			$exprops[]="\0Prado\Web\UI\WebControls\TStyle\0_font";
 		if($this->_class===null)
-			$exprops[] = "\0Prado\Web\UI\WebControls\TStyle\0_class";
-		if ($this->_customStyle===null)
-			$exprops[] = "\0Prado\Web\UI\WebControls\TStyle\0_customStyle";
-		if ($this->_displayStyle==='Fixed')
-			$exprops[] = "\0Prado\Web\UI\WebControls\TStyle\0_displayStyle";
+			$exprops[]="\0Prado\Web\UI\WebControls\TStyle\0_class";
+		if($this->_customStyle===null)
+			$exprops[]="\0Prado\Web\UI\WebControls\TStyle\0_customStyle";
+		if($this->_displayStyle==='Fixed')
+			$exprops[]="\0Prado\Web\UI\WebControls\TStyle\0_displayStyle";
 	}
 
 	/**
@@ -82,7 +82,7 @@ 
 	public function __clone()
 	{
 		if($this->_font!==null)
-			$this->_font = clone($this->_font);
+			$this->_font=clone($this->_font);
 	}
 
 	/**
@@ -90,7 +90,7 @@ 
 	 */
 	public function getBackColor()
 	{
-		return isset($this->_fields['background-color'])?$this->_fields['background-color']:'';
+		return isset($this->_fields['background-color']) ? $this->_fields['background-color'] : '';
 	}
 
 	/**
@@ -109,7 +109,7 @@ 
 	 */
 	public function getBorderColor()
 	{
-		return isset($this->_fields['border-color'])?$this->_fields['border-color']:'';
+		return isset($this->_fields['border-color']) ? $this->_fields['border-color'] : '';
 	}
 
 	/**
@@ -128,7 +128,7 @@ 
 	 */
 	public function getBorderStyle()
 	{
-		return isset($this->_fields['border-style'])?$this->_fields['border-style']:'';
+		return isset($this->_fields['border-style']) ? $this->_fields['border-style'] : '';
 	}
 
 	/**
@@ -148,7 +148,7 @@ 
 	 */
 	public function getBorderWidth()
 	{
-		return isset($this->_fields['border-width'])?$this->_fields['border-width']:'';
+		return isset($this->_fields['border-width']) ? $this->_fields['border-width'] : '';
 	}
 
 	/**
@@ -167,7 +167,7 @@ 
 	 */
 	public function getCssClass()
 	{
-		return $this->_class===null?'':$this->_class;
+		return $this->_class===null ? '' : $this->_class;
 	}
 
 	/**
@@ -201,7 +201,7 @@ 
 	 */
 	public function hasFont()
 	{
-		return $this->_font !== null;
+		return $this->_font!==null;
 	}
 
 	/**
@@ -209,20 +209,20 @@ 
 	 */
 	public function setDisplayStyle($value)
 	{
-		$this->_displayStyle = TPropertyValue::ensureEnum($value, 'Prado\\Web\\UI\\WebControls\\TDisplayStyle');
+		$this->_displayStyle=TPropertyValue::ensureEnum($value, 'Prado\\Web\\UI\\WebControls\\TDisplayStyle');
 		switch($this->_displayStyle)
 		{
 			case TDisplayStyle::None:
-				$this->_fields['display'] = 'none';
+				$this->_fields['display']='none';
 				break;
 			case TDisplayStyle::Dynamic:
-				$this->_fields['display'] = ''; //remove the display property
+				$this->_fields['display']=''; //remove the display property
 				break;
 			case TDisplayStyle::Fixed:
-				$this->_fields['visibility'] = 'visible';
+				$this->_fields['visibility']='visible';
 				break;
 			case TDisplayStyle::Hidden:
-				$this->_fields['visibility'] = 'hidden';
+				$this->_fields['visibility']='hidden';
 				break;
 		}
 	}
@@ -240,7 +240,7 @@ 
 	 */
 	public function getForeColor()
 	{
-		return isset($this->_fields['color'])?$this->_fields['color']:'';
+		return isset($this->_fields['color']) ? $this->_fields['color'] : '';
 	}
 
 	/**
@@ -259,7 +259,7 @@ 
 	 */
 	public function getHeight()
 	{
-		return isset($this->_fields['height'])?$this->_fields['height']:'';
+		return isset($this->_fields['height']) ? $this->_fields['height'] : '';
 	}
 
 	/**
@@ -278,7 +278,7 @@ 
 	 */
 	public function getCustomStyle()
 	{
-		return $this->_customStyle===null?'':$this->_customStyle;
+		return $this->_customStyle===null ? '' : $this->_customStyle;
 	}
 
 	/**
@@ -296,7 +296,7 @@ 
 	 */
 	public function getStyleField($name)
 	{
-		return isset($this->_fields[$name])?$this->_fields[$name]:'';
+		return isset($this->_fields[$name]) ? $this->_fields[$name] : '';
 	}
 
 	/**
@@ -305,7 +305,7 @@ 
 	 * @param string style field name
 	 * @param string style field value
 	 */
-	public function setStyleField($name,$value)
+	public function setStyleField($name, $value)
 	{
 		$this->_fields[$name]=$value;
 	}
@@ -332,7 +332,7 @@ 
 	 */
 	public function getWidth()
 	{
-		return isset($this->_fields['width'])?$this->_fields['width']:'';
+		return isset($this->_fields['width']) ? $this->_fields['width'] : '';
 	}
 
 	/**
@@ -364,7 +364,7 @@ 
 	{
 		if($style instanceof TStyle)
 		{
-			$this->_fields=array_merge($this->_fields,$style->_fields);
+			$this->_fields=array_merge($this->_fields, $style->_fields);
 			if($style->_class!==null)
 				$this->_class=$style->_class;
 			if($style->_customStyle!==null)
@@ -384,7 +384,7 @@ 
 	{
 		if($style instanceof TStyle)
 		{
-			$this->_fields=array_merge($style->_fields,$this->_fields);
+			$this->_fields=array_merge($style->_fields, $this->_fields);
 			if($this->_class===null)
 				$this->_class=$style->_class;
 			if($this->_customStyle===null)
@@ -402,18 +402,18 @@ 
 	{
 		if($this->_customStyle!==null)
 		{
-			foreach(explode(';',$this->_customStyle) as $style)
+			foreach(explode(';', $this->_customStyle) as $style)
 			{
-				$arr=explode(':',$style,2);
+				$arr=explode(':', $style, 2);
 				if(isset($arr[1]) && trim($arr[0])!=='')
-					$writer->addStyleAttribute(trim($arr[0]),trim($arr[1]));
+					$writer->addStyleAttribute(trim($arr[0]), trim($arr[1]));
 			}
 		}
 		$writer->addStyleAttributes($this->_fields);
 		if($this->_font!==null)
 			$this->_font->addAttributesToRender($writer);
 		if($this->_class!==null)
-			$writer->addAttribute('class',$this->_class);
+			$writer->addAttribute('class', $this->_class);
 	}
 
 	/**

framework/Caching/TCache.php

Doc Comments +9 added lines, -3 removed lines

@@ -109,7 +109,7 @@ 
 
 	/**
 	 * @param string a key identifying a value to be cached
-	 * @return sring a key generated from the provided key which ensures the uniqueness across applications
+	 * @return string a key generated from the provided key which ensures the uniqueness across applications
 	 */
 	protected function generateUniqueKey($key)
 	{
@@ -143,7 +143,7 @@ 
 	 * @param mixed the value to be cached
 	 * @param integer the number of seconds in which the cached value will expire. 0 means never expire.
 	 * @param ICacheDependency dependency of the cached item. If the dependency changes, the item is labeled invalid.
-	 * @return boolean true if the value is successfully stored into cache, false otherwise
+	 * @return null|boolean true if the value is successfully stored into cache, false otherwise
 	 */
 	public function set($id,$value,$expire=0,$dependency=null)
 	{
@@ -201,6 +201,7 @@ 
 	 * in {@link get()} already. So only the implementation of data retrieval
 	 * is needed.
 	 * @param string a unique key identifying the cached value
+	 * @param string $key
 	 * @return string the value stored in cache, false if the value is not in the cache or expired.
 	 */
 	abstract protected function getValue($key);
@@ -215,6 +216,8 @@ 
 	 * @param string the key identifying the value to be cached
 	 * @param string the value to be cached
 	 * @param integer the number of seconds in which the cached value will expire. 0 means never expire.
+	 * @param string $key
+	 * @param integer $expire
 	 * @return boolean true if the value is successfully stored into cache, false otherwise
 	 */
 	abstract protected function setValue($key,$value,$expire);
@@ -229,6 +232,8 @@ 
 	 * @param string the key identifying the value to be cached
 	 * @param string the value to be cached
 	 * @param integer the number of seconds in which the cached value will expire. 0 means never expire.
+	 * @param string $key
+	 * @param integer $expire
 	 * @return boolean true if the value is successfully stored into cache, false otherwise
 	 */
 	abstract protected function addValue($key,$value,$expire);
@@ -237,6 +242,7 @@ 
 	 * Deletes a value with the specified key from cache
 	 * This method should be implemented by child classes to delete the data from actual cache storage.
 	 * @param string the key of the value to be deleted
+	 * @param string $key
 	 * @return boolean if no error happens during deletion
 	 */
 	abstract protected function deleteValue($key);
@@ -280,7 +286,7 @@ 
 	 * Deletes the value with the specified key from cache
 	 * This method is required by the interface \ArrayAccess.
 	 * @param string the key of the value to be deleted
-	 * @return boolean if no error happens during deletion
+	 * @return boolean|null if no error happens during deletion
 	 */
 	public function offsetUnset($id)
 	{

Spacing +12 added lines, -12 removed lines

@@ -67,7 +67,7 @@ 
 			if($this->getApplication()->getCache()===null)
 				$this->getApplication()->setCache($this);
 			else
-				throw new TConfigurationException('cache_primary_duplicated',get_class($this));
+				throw new TConfigurationException('cache_primary_duplicated', get_class($this));
 		}
 	}
 
@@ -145,14 +145,14 @@ 
 	 * @param ICacheDependency dependency of the cached item. If the dependency changes, the item is labeled invalid.
 	 * @return boolean true if the value is successfully stored into cache, false otherwise
 	 */
-	public function set($id,$value,$expire=0,$dependency=null)
+	public function set($id, $value, $expire=0, $dependency=null)
 	{
-		if(empty($value) && $expire === 0)
+		if(empty($value) && $expire===0)
 			$this->delete($id);
 		else
 		{
-			$data=array($value,$dependency);
-			return $this->setValue($this->generateUniqueKey($id),$data,$expire);
+			$data=array($value, $dependency);
+			return $this->setValue($this->generateUniqueKey($id), $data, $expire);
 		}
 	}
 
@@ -165,12 +165,12 @@ 
 	 * @param ICacheDependency dependency of the cached item. If the dependency changes, the item is labeled invalid.
 	 * @return boolean true if the value is successfully stored into cache, false otherwise
 	 */
-	public function add($id,$value,$expire=0,$dependency=null)
+	public function add($id, $value, $expire=0, $dependency=null)
 	{
-		if(empty($value) && $expire === 0)
+		if(empty($value) && $expire===0)
 			return false;
-		$data=array($value,$dependency);
-		return $this->addValue($this->generateUniqueKey($id),$data,$expire);
+		$data=array($value, $dependency);
+		return $this->addValue($this->generateUniqueKey($id), $data, $expire);
 	}
 
 	/**
@@ -217,7 +217,7 @@ 
 	 * @param integer the number of seconds in which the cached value will expire. 0 means never expire.
 	 * @return boolean true if the value is successfully stored into cache, false otherwise
 	 */
-	abstract protected function setValue($key,$value,$expire);
+	abstract protected function setValue($key, $value, $expire);
 
 	/**
 	 * Stores a value identified by a key into cache if the cache does not contain this key.
@@ -231,7 +231,7 @@ 
 	 * @param integer the number of seconds in which the cached value will expire. 0 means never expire.
 	 * @return boolean true if the value is successfully stored into cache, false otherwise
 	 */
-	abstract protected function addValue($key,$value,$expire);
+	abstract protected function addValue($key, $value, $expire);
 
 	/**
 	 * Deletes a value with the specified key from cache
@@ -249,7 +249,7 @@ 
 	 */
 	public function offsetExists($id)
 	{
-		return $this->get($id) !== false;
+		return $this->get($id)!==false;
 	}
 
 	/**

framework/Caching/TDirectoryCacheDependency.php

Doc Comments +3 added lines

@@ -123,6 +123,7 @@ 
 	 * By default, it always returns true, meaning the file should be checked.
 	 * You may override this method to check only certain files.
 	 * @param string the name of the file that may be checked for dependency.
+	 * @param string $fileName
 	 * @return boolean whether this file should be checked.
 	 */
 	protected function validateFile($fileName)
@@ -136,6 +137,7 @@ 
 	 * By default, it always returns true, meaning the subdirectory should be checked.
 	 * You may override this method to check only certain subdirectories.
 	 * @param string the name of the subdirectory that may be checked for dependency.
+	 * @param string $directory
 	 * @return boolean whether this subdirectory should be checked.
 	 */
 	protected function validateDirectory($directory)
@@ -149,6 +151,7 @@ 
 	 * {@link setRecursiveCheck RecursiveCheck} is set true.
 	 * @param string the directory name
 	 * @param int level of the recursion
+	 * @param string $directory
 	 * @return array list of file modification time indexed by the file path
 	 */
 	protected function generateTimestamps($directory,$level=0)

Spacing +5 added lines, -5 removed lines

@@ -63,7 +63,7 @@ 
 	public function setDirectory($directory)
 	{
 		if(($path=realpath($directory))===false || !is_dir($path))
-			throw new TInvalidDataValueException('directorycachedependency_directory_invalid',$directory);
+			throw new TInvalidDataValueException('directorycachedependency_directory_invalid', $directory);
 		$this->_directory=$path;
 		$this->_timestamps=$this->generateTimestamps($path);
 	}
@@ -151,10 +151,10 @@ 
 	 * @param int level of the recursion
 	 * @return array list of file modification time indexed by the file path
 	 */
-	protected function generateTimestamps($directory,$level=0)
+	protected function generateTimestamps($directory, $level=0)
 	{
 		if(($dir=opendir($directory))===false)
-			throw new TIOException('directorycachedependency_directory_invalid',$directory);
+			throw new TIOException('directorycachedependency_directory_invalid', $directory);
 		$timestamps=array();
 		while(($file=readdir($dir))!==false)
 		{
@@ -163,8 +163,8 @@ 
 				continue;
 			else if(is_dir($path))
 			{
-				if(($this->_recursiveLevel<0 || $level<$this->_recursiveLevel) && $this->validateDirectory($path))
-					$timestamps=array_merge($this->generateTimestamps($path,$level+1));
+				if(($this->_recursiveLevel < 0 || $level < $this->_recursiveLevel) && $this->validateDirectory($path))
+					$timestamps=array_merge($this->generateTimestamps($path, $level + 1));
 			}
 			else if($this->validateFile($path))
 				$timestamps[$path]=filemtime($path);

Braces +1 added lines, -2 removed lines

@@ -532,8 +532,7 @@
 			{
 				if(($this->_recursiveLevel<0 || $level<$this->_recursiveLevel) && $this->validateDirectory($path))
 					$timestamps=array_merge($this->generateTimestamps($path,$level+1));
-			}
-			else if($this->validateFile($path))
+			} else if($this->validateFile($path))
 				$timestamps[$path]=filemtime($path);
 		}
 		closedir($dir);

framework/Collections/TDummyDataSource.php

Doc Comments +1 added lines, -1 removed lines

@@ -48,7 +48,7 @@
 	}
 
 	/**
-	 * @return Iterator iterator
+	 * @return TDummyDataSourceIterator iterator
 	 */
 	public function getIterator()
 	{

framework/Collections/TPagedDataSource.php

Doc Comments +6 added lines

@@ -68,6 +68,7 @@ 
 
 	/**
 	 * @param mixed original data source
+	 * @param \Traversable $value
 	 */
 	public function setDataSource($value)
 	{
@@ -93,6 +94,7 @@ 
 
 	/**
 	 * @param integer number of items in each page
+	 * @param integer $value
 	 */
 	public function setPageSize($value)
 	{
@@ -112,6 +114,7 @@ 
 
 	/**
 	 * @param integer current page index
+	 * @param integer $value
 	 */
 	public function setCurrentPageIndex($value)
 	{
@@ -130,6 +133,7 @@ 
 
 	/**
 	 * @param boolean whether to allow paging
+	 * @param boolean $value
 	 */
 	public function setAllowPaging($value)
 	{
@@ -146,6 +150,7 @@ 
 
 	/**
 	 * @param boolean whether to allow custom paging
+	 * @param boolean $value
 	 */
 	public function setAllowCustomPaging($value)
 	{
@@ -162,6 +167,7 @@ 
 
 	/**
 	 * @param integer user-assigned number of items in data source
+	 * @param integer $value
 	 */
 	public function setVirtualItemCount($value)
 	{

Spacing +10 added lines, -10 removed lines

@@ -96,7 +96,7 @@ 
 	 */
 	public function setPageSize($value)
 	{
-		if(($value=TPropertyValue::ensureInteger($value))>0)
+		if(($value=TPropertyValue::ensureInteger($value)) > 0)
 			$this->_pageSize=$value;
 		else
 			throw new TInvalidDataValueException('pageddatasource_pagesize_invalid');
@@ -115,7 +115,7 @@ 
 	 */
 	public function setCurrentPageIndex($value)
 	{
-		if(($value=TPropertyValue::ensureInteger($value))<0)
+		if(($value=TPropertyValue::ensureInteger($value)) < 0)
 			$value=0;
 		$this->_currentPageIndex=$value;
 	}
@@ -165,7 +165,7 @@ 
 	 */
 	public function setVirtualItemCount($value)
 	{
-		if(($value=TPropertyValue::ensureInteger($value))>=0)
+		if(($value=TPropertyValue::ensureInteger($value)) >= 0)
 			$this->_virtualCount=$value;
 		else
 			throw new TInvalidDataValueException('pageddatasource_virtualitemcount_invalid');
@@ -181,7 +181,7 @@ 
 		if(!$this->_allowPaging)
 			return $this->getDataSourceCount();
 		if(!$this->_allowCustomPaging && $this->getIsLastPage())
-			return $this->getDataSourceCount()-$this->getFirstIndexInPage();
+			return $this->getDataSourceCount() - $this->getFirstIndexInPage();
 		return $this->_pageSize;
 	}
 
@@ -203,9 +203,9 @@ 
 		if($this->_dataSource===null)
 			return 0;
 		$count=$this->getDataSourceCount();
-		if(!$this->_allowPaging || $count<=0)
+		if(!$this->_allowPaging || $count <= 0)
 			return 1;
-		return (int)(($count+$this->_pageSize-1)/$this->_pageSize);
+		return (int) (($count + $this->_pageSize - 1) / $this->_pageSize);
 	}
 
 	/**
@@ -225,7 +225,7 @@ 
 	public function getIsLastPage()
 	{
 		if($this->_allowPaging)
-			return $this->_currentPageIndex===$this->getPageCount()-1;
+			return $this->_currentPageIndex===$this->getPageCount() - 1;
 		else
 			return true;
 	}
@@ -237,7 +237,7 @@ 
 	public function getFirstIndexInPage()
 	{
 		if($this->_dataSource!==null && $this->_allowPaging && !$this->_allowCustomPaging)
-			return $this->_currentPageIndex*$this->_pageSize;
+			return $this->_currentPageIndex * $this->_pageSize;
 		else
 			return 0;
 	}
@@ -261,9 +261,9 @@ 
 	public function getIterator()
 	{
 		if($this->_dataSource instanceof TList)
-			return new TPagedListIterator($this->_dataSource,$this->getFirstIndexInPage(),$this->getCount());
+			return new TPagedListIterator($this->_dataSource, $this->getFirstIndexInPage(), $this->getCount());
 		else if($this->_dataSource instanceof TMap)
-			return new TPagedMapIterator($this->_dataSource,$this->getFirstIndexInPage(),$this->getCount());
+			return new TPagedMapIterator($this->_dataSource, $this->getFirstIndexInPage(), $this->getCount());
 		else
 			return null;
 	}

framework/Collections/TPagedListIterator.php

Doc Comments +2 added lines

@@ -35,6 +35,8 @@
 	 * @param TList the data to be iterated through
 	 * @param integer start index
 	 * @param integer number of items to be iterated through
+	 * @param integer $startIndex
+	 * @param integer $count
 	 */
 	public function __construct(TList $list,$startIndex,$count)
 	{

Spacing +5 added lines, -5 removed lines

@@ -36,13 +36,13 @@ 
 	 * @param integer start index
 	 * @param integer number of items to be iterated through
 	 */
-	public function __construct(TList $list,$startIndex,$count)
+	public function __construct(TList $list, $startIndex, $count)
 	{
 		$this->_list=$list;
 		$this->_index=0;
 		$this->_startIndex=$startIndex;
-		if($startIndex+$count>$list->getCount())
-			$this->_count=$list->getCount()-$startIndex;
+		if($startIndex + $count > $list->getCount())
+			$this->_count=$list->getCount() - $startIndex;
 		else
 			$this->_count=$count;
 	}
@@ -73,7 +73,7 @@ 
 	 */
 	public function current()
 	{
-		return $this->_list->itemAt($this->_startIndex+$this->_index);
+		return $this->_list->itemAt($this->_startIndex + $this->_index);
 	}
 
 	/**
@@ -92,6 +92,6 @@ 
 	 */
 	public function valid()
 	{
-		return $this->_index<$this->_count;
+		return $this->_index < $this->_count;
 	}
 }
\ No newline at end of file

framework/Collections/TPagedListPageChangedEventParameter.php

Doc Comments +1 added lines

@@ -28,6 +28,7 @@
 	/**
 	 * Constructor.
 	 * @param integer old page index
+	 * @param integer $oldPage
 	 */
 	public function __construct($oldPage)
 	{

framework/Collections/TPagedMapIterator.php

Doc Comments +2 added lines

@@ -34,6 +34,8 @@
 	/**
 	 * Constructor.
 	 * @param array the data to be iterated through
+	 * @param integer $startIndex
+	 * @param integer $count
 	 */
 	public function __construct(TMap $map,$startIndex,$count)
 	{

Spacing +5 added lines, -5 removed lines

@@ -35,13 +35,13 @@ 
 	 * Constructor.
 	 * @param array the data to be iterated through
 	 */
-	public function __construct(TMap $map,$startIndex,$count)
+	public function __construct(TMap $map, $startIndex, $count)
 	{
 		$this->_map=$map;
 		$this->_index=0;
 		$this->_startIndex=$startIndex;
-		if($startIndex+$count>$map->getCount())
-			$this->_count=$map->getCount()-$startIndex;
+		if($startIndex + $count > $map->getCount())
+			$this->_count=$map->getCount() - $startIndex;
 		else
 			$this->_count=$count;
 		$this->_iterator=$map->getIterator();
@@ -54,7 +54,7 @@ 
 	public function rewind()
 	{
 		$this->_iterator->rewind();
-		for($i=0;$i<$this->_startIndex;++$i)
+		for($i=0; $i < $this->_startIndex; ++$i)
 			$this->_iterator->next();
 		$this->_index=0;
 	}
@@ -96,6 +96,6 @@ 
 	 */
 	public function valid()
 	{
-		return $this->_index<$this->_count;
+		return $this->_index < $this->_count;
 	}
 }
\ No newline at end of file

framework/Collections/TPriorityList.php

Doc Comments +5 added lines, -1 removed lines

@@ -143,6 +143,7 @@ 
 	/**
 	 * This must be called internally or when instantiated.
 	 * @param numeric sets the default priority of inserted items without a specified priority
+	 * @param integer $value
 	 */
 	protected function setDefaultPriority($value)
 	{
@@ -160,6 +161,7 @@ 
 	/**
 	 * This must be called internally or when instantiated.
 	 * @param integer The precision of numeric priorities.
+	 * @param integer $value
 	 */
 	protected function setPrecision($value)
 	{
@@ -169,7 +171,7 @@ 
 	/**
 	 * Returns an iterator for traversing the items in the list.
 	 * This method is required by the interface \IteratorAggregate.
-	 * @return Iterator an iterator for traversing the items in the list.
+	 * @return \ArrayIterator an iterator for traversing the items in the list.
 	 */
 	public function getIterator()
 	{
@@ -596,6 +598,7 @@ 
 	 * Combines the map elements which have a priority below the parameter value
 	 * @param numeric the cut-off priority.  All items of priority less than this are returned.
 	 * @param boolean whether or not the input cut-off priority is inclusive.  Default: false, not inclusive.
+	 * @param integer $priority
 	 * @return array the array of priorities keys with values of arrays of items that are below a specified priority.
 	 *  The priorities are sorted so important priorities, lower numerics, are first.
 	 */
@@ -616,6 +619,7 @@ 
 	 * Combines the map elements which have a priority above the parameter value
 	 * @param numeric the cut-off priority.  All items of priority greater than this are returned.
 	 * @param boolean whether or not the input cut-off priority is inclusive.  Default: true, inclusive.
+	 * @param integer $priority
 	 * @return array the array of priorities keys with values of arrays of items that are above a specified priority.
 	 *  The priorities are sorted so important priorities, lower numerics, are first.
 	 */

Braces +3 added lines, -6 removed lines

@@ -390,8 +390,7 @@ 
 			}
 			$this->removeAtIndexInPriority($p[1],$p[0]);
 			return $p[2];
-		}
-		else
+		} else
 			throw new TInvalidDataValueException('list_item_inexistent');
 	}
 
@@ -676,14 +675,12 @@ 
 				foreach($data->itemsAtPriority($priority) as $index=>$item)
 					$this->insertAtIndexInPriority($item,false,$priority);
 			}
-		}
-		else if(is_array($data)||$data instanceof \Traversable)
+		} else if(is_array($data)||$data instanceof \Traversable)
 		{
 			foreach($data as $priority=>$item)
 				$this->add($item);
 
-		}
-		else if($data!==null)
+		} else if($data!==null)
 			throw new TInvalidDataTypeException('map_data_not_iterable');
 	}
 

Spacing +89 added lines, -89 removed lines

@@ -87,7 +87,7 @@ 
 	 * @param integer the precision of the numeric priorities
 	 * @throws TInvalidDataTypeException If data is not null and is neither an array nor an iterator.
 	 */
-	public function __construct($data=null,$readOnly=false,$defaultPriority=10,$precision=8)
+	public function __construct($data=null, $readOnly=false, $defaultPriority=10, $precision=8)
 	{
 		parent::__construct();
 		if($data!==null)
@@ -125,7 +125,7 @@ 
 	{
 		if($priority===null)
 			$priority=$this->getDefaultPriority();
-		$priority=(string)round(TPropertyValue::ensureFloat($priority),$this->_p);
+		$priority=(string) round(TPropertyValue::ensureFloat($priority), $this->_p);
 
 		if(!isset($this->_d[$priority]) || !is_array($this->_d[$priority]))
 			return false;
@@ -146,7 +146,7 @@ 
 	 */
 	protected function setDefaultPriority($value)
 	{
-		$this->_dp=(string)round(TPropertyValue::ensureFloat($value),$this->_p);
+		$this->_dp=(string) round(TPropertyValue::ensureFloat($value), $this->_p);
 	}
 
 	/**
@@ -192,7 +192,7 @@ 
 	 */
 	protected function sortPriorities() {
 		if(!$this->_o) {
-			ksort($this->_d,SORT_NUMERIC);
+			ksort($this->_d, SORT_NUMERIC);
 			$this->_o=true;
 		}
 	}
@@ -208,7 +208,7 @@ 
 		$this->sortPriorities();
 		$this->_fd=array();
 		foreach($this->_d as $priority => $itemsatpriority)
-			$this->_fd=array_merge($this->_fd,$itemsatpriority);
+			$this->_fd=array_merge($this->_fd, $itemsatpriority);
 		return $this->_fd;
 	}
 
@@ -222,11 +222,11 @@ 
 	 */
 	public function itemAt($index)
 	{
-		if($index>=0&&$index<$this->getCount()) {
+		if($index >= 0 && $index < $this->getCount()) {
 			$arr=$this->flattenPriorities();
 			return $arr[$index];
 		} else
-			throw new TInvalidDataValueException('list_index_invalid',$index);
+			throw new TInvalidDataValueException('list_index_invalid', $index);
 	}
 
 	/**
@@ -238,9 +238,9 @@ 
 	{
 		if($priority===null)
 			$priority=$this->getDefaultPriority();
-		$priority=(string)round(TPropertyValue::ensureFloat($priority),$this->_p);
+		$priority=(string) round(TPropertyValue::ensureFloat($priority), $this->_p);
 
-		return isset($this->_d[$priority])?$this->_d[$priority]:null;
+		return isset($this->_d[$priority]) ? $this->_d[$priority] : null;
 	}
 
 	/**
@@ -249,14 +249,14 @@ 
 	 * @param numeric the priority which to index.  no parameter or null will result in the default priority
 	 * @return mixed the element at the offset, false if no element is found at the offset
 	 */
-	public function itemAtIndexInPriority($index,$priority=null)
+	public function itemAtIndexInPriority($index, $priority=null)
 	{
 		if($priority===null)
 			$priority=$this->getDefaultPriority();
-		$priority=(string)round(TPropertyValue::ensureFloat($priority), $this->_p);
+		$priority=(string) round(TPropertyValue::ensureFloat($priority), $this->_p);
 
-		return !isset($this->_d[$priority])?false:(
-				isset($this->_d[$priority][$index])?$this->_d[$priority][$index]:false
+		return !isset($this->_d[$priority]) ?false:(
+				isset($this->_d[$priority][$index]) ? $this->_d[$priority][$index] : false
 			);
 	}
 
@@ -268,12 +268,12 @@ 
 	 * @return int the index within the flattened array
 	 * @throws TInvalidOperationException if the map is read-only
 	 */
-	public function add($item,$priority=null)
+	public function add($item, $priority=null)
 	{
 		if($this->getReadOnly())
-			throw new TInvalidOperationException('list_readonly',get_class($this));
+			throw new TInvalidOperationException('list_readonly', get_class($this));
 
-		return $this->insertAtIndexInPriority($item,false,$priority,true);
+		return $this->insertAtIndexInPriority($item, false, $priority, true);
 	}
 
 	/**
@@ -284,15 +284,15 @@ 
 	 * @throws TInvalidDataValueException If the index specified exceeds the bound
 	 * @throws TInvalidOperationException if the list is read-only
 	 */
-	public function insertAt($index,$item)
+	public function insertAt($index, $item)
 	{
 		if($this->getReadOnly())
-			throw new TInvalidOperationException('list_readonly',get_class($this));
+			throw new TInvalidOperationException('list_readonly', get_class($this));
 
-		if(($priority=$this->priorityAt($index,true))!==false)
-			$this->insertAtIndexInPriority($item,$priority[1],$priority[0]);
+		if(($priority=$this->priorityAt($index, true))!==false)
+			$this->insertAtIndexInPriority($item, $priority[1], $priority[0]);
 		else
-			throw new TInvalidDataValueException('list_index_invalid',$index);
+			throw new TInvalidDataValueException('list_index_invalid', $index);
 	}
 
 	/**
@@ -305,54 +305,54 @@ 
 	 * @throws TInvalidDataValueException If the index specified exceeds the bound
 	 * @throws TInvalidOperationException if the list is read-only
 	 */
-	public function insertAtIndexInPriority($item,$index=false,$priority=null,$preserveCache=false)
+	public function insertAtIndexInPriority($item, $index=false, $priority=null, $preserveCache=false)
 	{
 		if($this->getReadOnly())
-			throw new TInvalidOperationException('list_readonly',get_class($this));
+			throw new TInvalidOperationException('list_readonly', get_class($this));
 
 		if($priority===null)
 			$priority=$this->getDefaultPriority();
-		$priority=(string)round(TPropertyValue::ensureFloat($priority), $this->_p);
+		$priority=(string) round(TPropertyValue::ensureFloat($priority), $this->_p);
 
 		if($preserveCache) {
 			$this->sortPriorities();
 			$cc=0;
 			foreach($this->_d as $prioritykey=>$items)
-				if($prioritykey>=$priority)
+				if($prioritykey >= $priority)
 					break;
 				else
 					$cc+=count($items);
 
-			if($index===false&&isset($this->_d[$priority])) {
+			if($index===false && isset($this->_d[$priority])) {
 				$c=count($this->_d[$priority]);
 				$c+=$cc;
 				$this->_d[$priority][]=$item;
 			} else if(isset($this->_d[$priority])) {
-				$c=$index+$cc;
-				array_splice($this->_d[$priority],$index,0,array($item));
+				$c=$index + $cc;
+				array_splice($this->_d[$priority], $index, 0, array($item));
 			} else {
-				$c = $cc;
-				$this->_o = false;
+				$c=$cc;
+				$this->_o=false;
 				$this->_d[$priority]=array($item);
 			}
 
-			if($this->_fd&&is_array($this->_fd)) // if there is a flattened array cache
-				array_splice($this->_fd,$c,0,array($item));
+			if($this->_fd && is_array($this->_fd)) // if there is a flattened array cache
+				array_splice($this->_fd, $c, 0, array($item));
 		} else {
 			$c=null;
-			if($index===false&&isset($this->_d[$priority])) {
+			if($index===false && isset($this->_d[$priority])) {
 				$cc=count($this->_d[$priority]);
 				$this->_d[$priority][]=$item;
 			} else if(isset($this->_d[$priority])) {
 				$cc=$index;
-				array_splice($this->_d[$priority],$index,0,array($item));
+				array_splice($this->_d[$priority], $index, 0, array($item));
 			} else {
 				$cc=0;
 				$this->_o=false;
 				$this->_d[$priority]=array($item);
 			}
-			if($this->_fd&&is_array($this->_fd)&&count($this->_d)==1)
-				array_splice($this->_fd,$cc,0,array($item));
+			if($this->_fd && is_array($this->_fd) && count($this->_d)==1)
+				array_splice($this->_fd, $cc, 0, array($item));
 			else
 				$this->_fd=null;
 		}
@@ -373,22 +373,22 @@ 
 	 * @return integer index within the flattened list at which the item is being removed
 	 * @throws TInvalidDataValueException If the item does not exist
 	 */
-	public function remove($item,$priority=false)
+	public function remove($item, $priority=false)
 	{
 		if($this->getReadOnly())
-			throw new TInvalidOperationException('list_readonly',get_class($this));
+			throw new TInvalidOperationException('list_readonly', get_class($this));
 
-		if(($p=$this->priorityOf($item,true))!==false)
+		if(($p=$this->priorityOf($item, true))!==false)
 		{
 			if($priority!==false) {
 				if($priority===null)
 					$priority=$this->getDefaultPriority();
-				$priority=(string)round(TPropertyValue::ensureFloat($priority),$this->_p);
+				$priority=(string) round(TPropertyValue::ensureFloat($priority), $this->_p);
 
 				if($p[0]!=$priority)
 					throw new TInvalidDataValueException('list_item_inexistent');
 			}
-			$this->removeAtIndexInPriority($p[1],$p[0]);
+			$this->removeAtIndexInPriority($p[1], $p[0]);
 			return $p[2];
 		}
 		else
@@ -405,11 +405,11 @@ 
 	public function removeAt($index)
 	{
 		if($this->getReadOnly())
-			throw new TInvalidOperationException('list_readonly',get_class($this));
+			throw new TInvalidOperationException('list_readonly', get_class($this));
 
 		if(($priority=$this->priorityAt($index, true))!==false)
-			return $this->removeAtIndexInPriority($priority[1],$priority[0]);
-		throw new TInvalidDataValueException('list_index_invalid',$index);
+			return $this->removeAtIndexInPriority($priority[1], $priority[0]);
+		throw new TInvalidDataValueException('list_index_invalid', $index);
 	}
 
 	/**
@@ -423,17 +423,17 @@ 
 	public function removeAtIndexInPriority($index, $priority=null)
 	{
 		if($this->getReadOnly())
-			throw new TInvalidOperationException('list_readonly',get_class($this));
+			throw new TInvalidOperationException('list_readonly', get_class($this));
 
 		if($priority===null)
 			$priority=$this->getDefaultPriority();
-		$priority=(string)round(TPropertyValue::ensureFloat($priority),$this->_p);
+		$priority=(string) round(TPropertyValue::ensureFloat($priority), $this->_p);
 
-		if(!isset($this->_d[$priority])||$index<0||$index>=count($this->_d[$priority]))
+		if(!isset($this->_d[$priority]) || $index < 0 || $index >= count($this->_d[$priority]))
 			throw new TInvalidDataValueException('list_item_inexistent');
 
 		// $value is an array of elements removed, only one
-		$value=array_splice($this->_d[$priority],$index,1);
+		$value=array_splice($this->_d[$priority], $index, 1);
 		$value=$value[0];
 
 		if(!count($this->_d[$priority]))
@@ -450,11 +450,11 @@ 
 	public function clear()
 	{
 		if($this->getReadOnly())
-			throw new TInvalidOperationException('list_readonly',get_class($this));
+			throw new TInvalidOperationException('list_readonly', get_class($this));
 
 		foreach($this->_d as $priority=>$items) {
-			for($index=count($items)-1;$index>=0;$index--)
-				$this->removeAtIndexInPriority($index,$priority);
+			for($index=count($items) - 1; $index >= 0; $index--)
+				$this->removeAtIndexInPriority($index, $priority);
 			unset($this->_d[$priority]);
 		}
 	}
@@ -465,7 +465,7 @@ 
 	 */
 	public function contains($item)
 	{
-		return $this->indexOf($item)>=0;
+		return $this->indexOf($item) >= 0;
 	}
 
 	/**
@@ -474,7 +474,7 @@ 
 	 */
 	public function indexOf($item)
 	{
-		if(($index=array_search($item,$this->flattenPriorities(),true))===false)
+		if(($index=array_search($item, $this->flattenPriorities(), true))===false)
 			return -1;
 		else
 			return $index;
@@ -489,16 +489,16 @@ 
 	 *   if withindex is true, an array is returned of [0 => $priority, 1 => $priorityIndex, 2 => flattenedIndex,
 	 * 'priority' => $priority, 'index' => $priorityIndex, 'absindex' => flattenedIndex]
 	 */
-	public function priorityOf($item,$withindex = false)
+	public function priorityOf($item, $withindex=false)
 	{
 		$this->sortPriorities();
 
-		$absindex = 0;
+		$absindex=0;
 		foreach($this->_d as $priority=>$items) {
-			if(($index=array_search($item,$items,true))!==false) {
+			if(($index=array_search($item, $items, true))!==false) {
 				$absindex+=$index;
-				return $withindex?array($priority,$index,$absindex,
-						'priority'=>$priority,'index'=>$index,'absindex'=>$absindex):$priority;
+				return $withindex ? array($priority, $index, $absindex,
+						'priority'=>$priority, 'index'=>$index, 'absindex'=>$absindex) : $priority;
 			} else
 				$absindex+=count($items);
 		}
@@ -515,19 +515,19 @@ 
 	 *   if withindex is true, an array is returned of [0 => $priority, 1 => $priorityIndex, 2 => flattenedIndex,
 	 * 'priority' => $priority, 'index' => $priorityIndex, 'absindex' => flattenedIndex]
 	 */
-	public function priorityAt($index,$withindex = false)
+	public function priorityAt($index, $withindex=false)
 	{
-		if($index<0||$index>=$this->getCount())
-			throw new TInvalidDataValueException('list_index_invalid',$index);
+		if($index < 0 || $index >= $this->getCount())
+			throw new TInvalidDataValueException('list_index_invalid', $index);
 
 		$absindex=$index;
 		$this->sortPriorities();
 		foreach($this->_d as $priority=>$items) {
-			if($index>=($c=count($items)))
+			if($index >= ($c=count($items)))
 				$index-=$c;
 			else
-				return $withindex?array($priority,$index,$absindex,
-						'priority'=>$priority,'index'=>$index,'absindex'=>$absindex):$priority;
+				return $withindex ? array($priority, $index, $absindex,
+						'priority'=>$priority, 'index'=>$index, 'absindex'=>$absindex) : $priority;
 		}
 		return false;
 	}
@@ -543,12 +543,12 @@ 
 	public function insertBefore($indexitem, $item)
 	{
 		if($this->getReadOnly())
-			throw new TInvalidOperationException('list_readonly',get_class($this));
+			throw new TInvalidOperationException('list_readonly', get_class($this));
 
-		if(($priority=$this->priorityOf($indexitem,true))===false)
+		if(($priority=$this->priorityOf($indexitem, true))===false)
 			throw new TInvalidDataValueException('list_item_inexistent');
 
-		$this->insertAtIndexInPriority($item,$priority[1],$priority[0]);
+		$this->insertAtIndexInPriority($item, $priority[1], $priority[0]);
 
 		return $priority[2];
 	}
@@ -564,14 +564,14 @@ 
 	public function insertAfter($indexitem, $item)
 	{
 		if($this->getReadOnly())
-			throw new TInvalidOperationException('list_readonly',get_class($this));
+			throw new TInvalidOperationException('list_readonly', get_class($this));
 
-		if(($priority=$this->priorityOf($indexitem,true))===false)
+		if(($priority=$this->priorityOf($indexitem, true))===false)
 			throw new TInvalidDataValueException('list_item_inexistent');
 
-		$this->insertAtIndexInPriority($item,$priority[1]+1,$priority[0]);
+		$this->insertAtIndexInPriority($item, $priority[1] + 1, $priority[0]);
 
-		return $priority[2]+1;
+		return $priority[2] + 1;
 	}
 
 	/**
@@ -598,15 +598,15 @@ 
 	 * @return array the array of priorities keys with values of arrays of items that are below a specified priority.
 	 *  The priorities are sorted so important priorities, lower numerics, are first.
 	 */
-	public function toArrayBelowPriority($priority,$inclusive=false)
+	public function toArrayBelowPriority($priority, $inclusive=false)
 	{
 		$this->sortPriorities();
 		$items=array();
 		foreach($this->_d as $itemspriority=>$itemsatpriority)
 		{
-			if((!$inclusive&&$itemspriority>=$priority)||$itemspriority>$priority)
+			if((!$inclusive && $itemspriority >= $priority) || $itemspriority > $priority)
 				break;
-			$items=array_merge($items,$itemsatpriority);
+			$items=array_merge($items, $itemsatpriority);
 		}
 		return $items;
 	}
@@ -618,15 +618,15 @@ 
 	 * @return array the array of priorities keys with values of arrays of items that are above a specified priority.
 	 *  The priorities are sorted so important priorities, lower numerics, are first.
 	 */
-	public function toArrayAbovePriority($priority,$inclusive=true)
+	public function toArrayAbovePriority($priority, $inclusive=true)
 	{
 		$this->sortPriorities();
 		$items=array();
 		foreach($this->_d as $itemspriority=>$itemsatpriority)
 		{
-			if((!$inclusive&&$itemspriority<=$priority)||$itemspriority<$priority)
+			if((!$inclusive && $itemspriority <= $priority) || $itemspriority < $priority)
 				continue;
-			$items=array_merge($items,$itemsatpriority);
+			$items=array_merge($items, $itemsatpriority);
 		}
 		return $items;
 	}
@@ -642,15 +642,15 @@ 
 	{
 		if($data instanceof TPriorityList)
 		{
-			if($this->getCount()>0)
+			if($this->getCount() > 0)
 				$this->clear();
 			foreach($data->getPriorities() as $priority)
 			{
 				foreach($data->itemsAtPriority($priority) as $index=>$item)
-					$this->insertAtIndexInPriority($item,$index,$priority);
+					$this->insertAtIndexInPriority($item, $index, $priority);
 			}
-		} else if(is_array($data)||$data instanceof \Traversable) {
-			if($this->getCount()>0)
+		} else if(is_array($data) || $data instanceof \Traversable) {
+			if($this->getCount() > 0)
 				$this->clear();
 			foreach($data as $key=>$item)
 				$this->add($item);
@@ -673,10 +673,10 @@ 
 			foreach($data->getPriorities() as $priority)
 			{
 				foreach($data->itemsAtPriority($priority) as $index=>$item)
-					$this->insertAtIndexInPriority($item,false,$priority);
+					$this->insertAtIndexInPriority($item, false, $priority);
 			}
 		}
-		else if(is_array($data)||$data instanceof \Traversable)
+		else if(is_array($data) || $data instanceof \Traversable)
 		{
 			foreach($data as $priority=>$item)
 				$this->add($item);
@@ -694,7 +694,7 @@ 
 	 */
 	public function offsetExists($offset)
 	{
-		return ($offset>=0&&$offset<$this->getCount());
+		return ($offset >= 0 && $offset < $this->getCount());
 	}
 
 	/**
@@ -720,18 +720,18 @@ 
 	 * @param integer the offset to set element
 	 * @param mixed the element value
 	 */
-	public function offsetSet($offset,$item)
+	public function offsetSet($offset, $item)
 	{
 		if($offset===null)
 			return $this->add($item);
 		if($offset===$this->getCount()) {
-			$priority=$this->priorityAt($offset-1,true);
+			$priority=$this->priorityAt($offset - 1, true);
 			$priority[1]++;
 		} else {
-			$priority=$this->priorityAt($offset,true);
-			$this->removeAtIndexInPriority($priority[1],$priority[0]);
+			$priority=$this->priorityAt($offset, true);
+			$this->removeAtIndexInPriority($priority[1], $priority[0]);
 		}
-		$this->insertAtIndexInPriority($item,$priority[1],$priority[0]);
+		$this->insertAtIndexInPriority($item, $priority[1], $priority[0]);
 	}
 
 	/**