pradosoft / prado

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)
 	{

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)

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/TList.php

Doc Comments +4 added lines, -2 removed lines

@@ -81,6 +81,7 @@ 
 
 	/**
 	 * @param boolean whether this list is read-only or not
+	 * @param boolean $value
 	 */
 	protected function setReadOnly($value)
 	{
@@ -90,7 +91,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()
 	{
@@ -283,7 +284,7 @@ 
 	 * Finds the base item.  If found, the item is inserted after it.
 	 * @param mixed the base item which comes before the second parameter when added to the list
 	 * @param mixed the item
-	 * @return int the index where the item is inserted
+	 * @return double the index where the item is inserted
 	 * @throws TInvalidDataValueException if the base item is not within this list
 	 * @throws TInvalidOperationException if the list is read-only
 	 * @since 3.2a
@@ -334,6 +335,7 @@ 
 	 * Merges iterable data into the map.
 	 * New data will be appended to the end of the existing data.
 	 * @param mixed the data to be merged with, must be an array or object implementing Traversable
+	 * @param \Prado\Web\UI\WebControls\TDataGridColumnCollection|null $data
 	 * @throws TInvalidDataTypeException If data is neither an array nor an iterator.
 	 */
 	public function mergeWith($data)

framework/Collections/TMap.php

Doc Comments +2 added lines, -1 removed lines

@@ -86,6 +86,7 @@ 
 
 	/**
 	 * @param boolean whether this list is read-only or not
+	 * @param boolean $value
 	 */
 	protected function setReadOnly($value)
 	{
@@ -95,7 +96,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()
 	{

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)
 	{

framework/Collections/TPagedList.php

Doc Comments +3 added lines

@@ -96,6 +96,7 @@ 
 
 	/**
 	 * @param boolean whether to allow custom paging
+	 * @param boolean $value
 	 */
 	public function setCustomPaging($value)
 	{
@@ -143,6 +144,7 @@ 
 	 * Raises <b>OnPageIndexChanged</b> event.
 	 * This event is raised each time when the list changes to a different page.
 	 * @param TPagedListPageChangedEventParameter event parameter
+	 * @param TPagedListPageChangedEventParameter|null $param
 	 */
 	public function onPageIndexChanged($param)
 	{
@@ -155,6 +157,7 @@ 
 	 * and needs the new page of data. This event can only be raised when
 	 * {@link setCustomPaging CustomPaging} is true.
 	 * @param TPagedListFetchDataEventParameter event parameter
+	 * @param TPagedListFetchDataEventParameter $param
 	 */
 	public function onFetchData($param)
 	{

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)
 	{