pradosoft / prado

framework/Web/UI/ActiveControls/TCallbackClientSide.php

Doc Comments +4 added lines, -3 removed lines

@@ -199,7 +199,7 @@ 
 	}
 
 	/**
-	 * @return boolean true to post the inputs of the form on callback, default
+	 * @return string true to post the inputs of the form on callback, default
 	 * is post the inputs on callback.
 	 */
 	public function getPostState()
@@ -217,7 +217,7 @@ 
 	}
 
 	/**
-	 * @return integer callback request timeout.
+	 * @return string callback request timeout.
 	 */
 	public function getRequestTimeOut()
 	{
@@ -261,6 +261,7 @@ 
 	 * update. This will automatically set HasPrority to true.
 	 * @param boolean true enables the callback response to update the
 	 * viewstate.
+	 * @param boolean $value
 	 */
 	public function setEnablePageStateUpdate($value)
 	{
@@ -269,7 +270,7 @@ 
 	}
 
 	/**
-	 * @return boolean client-side viewstate will be updated on callback
+	 * @return boolean|string client-side viewstate will be updated on callback
 	 * response if true. Default is true.
 	 */
 	public function getEnablePageStateUpdate()

bin/prado-cli.php

Doc Comments +37 added lines

@@ -145,6 +145,10 @@ 
 	 */
 	public abstract function performAction($args);
 
+	/**
+	 * @param string $dir
+	 * @param integer $mask
+	 */
 	protected function createDirectory($dir, $mask)
 	{
 		if(!is_dir($dir))
@@ -156,6 +160,9 @@ 
 			chmod($dir, $mask);
 	}
 
+	/**
+	 * @param string $filename
+	 */
 	protected function createFile($filename, $content)
 	{
 		if(!is_file($filename))
@@ -304,6 +311,9 @@ 
 ';
 	}
 
+	/**
+	 * @param string $appName
+	 */
 	protected function renderConfigFile($appName)
 	{
 		return <<<EOD
@@ -500,6 +510,9 @@ 
 		require_once($TEST_TOOLS.'/simpletest/reporter.php');
 	}
 
+	/**
+	 * @param string $dir
+	 */
 	protected function runUnitTests($dir, $args)
 	{
 		$app_dir = $this->getAppDir($dir);
@@ -538,6 +551,9 @@ 
 		return realpath($dir.'/tests/unit/');
 	}
 
+	/**
+	 * @param string $dir
+	 */
 	protected function getUnitTestCases($dir,$args)
 	{
 		$matches = null;
@@ -565,6 +581,9 @@ 
 		closedir($dir);
 	}
 
+	/**
+	 * @param string $entry
+	 */
 	protected function hasMatch($match,$entry)
 	{
 		$file = strtolower(substr($entry,0,strrpos($entry,'.')));
@@ -630,6 +649,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $app_dir
+	 */
 	protected function getActiveRecordConfig($app_dir)
 	{
 		if(false === ($xml=$this->getXmlFile($app_dir)))
@@ -645,6 +667,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $app_dir
+	 */
 	protected function getOutputFile($app_dir, $namespace)
 	{
 		if(is_file($namespace) && strpos($namespace, $app_dir)===0)
@@ -659,6 +684,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param TActiveRecordConfig $config
+	 */
 	protected function generateActiveRecord($config, $tablename, $output)
 	{
 		$manager = TActiveRecordManager::getInstance();
@@ -706,6 +734,9 @@ 
 		return $prop;
 	}
 
+	/**
+	 * @param string $class
+	 */
 	protected function generateClass($properties, $tablename, $class)
 	{
 		$props = implode("\n", $properties);
@@ -799,6 +830,9 @@ 
         return false;
     }
 
+    /**
+     * @param string $app_dir
+     */
     protected function getActiveRecordConfig($app_dir) {
         if (false === ($xml = $this->getXmlFile($app_dir)))
             return false;
@@ -842,6 +876,9 @@ 
 			}
 	    }
 
+	    /**
+	     * @param string $l
+	     */
 	    public function generate($l)
 	    {
 			$input = explode(" ", trim($l));

framework/Caching/TCache.php

Doc Comments +10 added lines, -1 removed lines

@@ -106,7 +106,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)
 	{
@@ -198,6 +198,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);
@@ -212,6 +213,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);
@@ -226,6 +229,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);
@@ -234,6 +239,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);
@@ -490,6 +496,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)
@@ -503,6 +510,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)
@@ -516,6 +524,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/TAttributeCollection.php

Doc Comments +2 added lines

@@ -93,6 +93,7 @@ 
 
 	/**
 	 * @param boolean whether the keys are case-sensitive.
+	 * @param boolean $value
 	 */
 	public function setCaseSensitive($value)
 	{
@@ -126,6 +127,7 @@ 
 	 * Removes an item from the map by its key.
 	 * This overrides the parent implementation by converting the key to lower case first if CaseSensitive is false.
 	 * @param mixed the key of the item to be removed
+	 * @param string $key
 	 * @return mixed the removed value, null if no such key exists.
 	 */
 	public function remove($key)

framework/Collections/TList.php

Doc Comments +2 added lines, -1 removed lines

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

framework/Collections/TMap.php

Doc Comments +2 added lines

@@ -80,6 +80,7 @@ 
 
 	/**
 	 * @param boolean whether this list is read-only or not
+	 * @param boolean $value
 	 */
 	protected function setReadOnly($value)
 	{
@@ -220,6 +221,7 @@ 
 	 * Merges iterable data into the map.
 	 * Existing data in the map will be kept and overwritten if the keys are the same.
 	 * @param mixed the data to be merged with, must be an array or object implementing Traversable
+	 * @param TMap $data
 	 * @throws TInvalidDataTypeException If data is neither an array nor an iterator.
 	 */
 	public function mergeWith($data)

framework/Collections/TPagedList.php

Doc Comments +4 added lines

@@ -92,6 +92,7 @@ 
 
 	/**
 	 * @param boolean whether to allow custom paging
+	 * @param boolean $value
 	 */
 	public function setCustomPaging($value)
 	{
@@ -139,6 +140,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)
 	{
@@ -151,6 +153,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)
 	{
@@ -380,6 +383,7 @@ 
 	/**
 	 * Constructor.
 	 * @param integer old page index
+	 * @param integer $oldPage
 	 */
 	public function __construct($oldPage)
 	{

framework/Collections/TPriorityList.php

Doc Comments +4 added lines

@@ -137,6 +137,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)
 	{
@@ -154,6 +155,7 @@ 
 	/**
 	 * This must be called internally or when instantiated.
 	 * @param integer The precision of numeric priorities.
+	 * @param integer $value
 	 */
 	protected function setPrecision($value)
 	{
@@ -590,6 +592,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.
 	 */
@@ -610,6 +613,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.
 	 */

framework/Collections/TPriorityMap.php

Doc Comments +4 added lines, -1 removed lines

@@ -114,6 +114,7 @@ 
 
 	/**
 	 * @param boolean whether this list is read-only or not
+	 * @param boolean $value
 	 */
 	protected function setReadOnly($value)
 	{
@@ -131,6 +132,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)
 	{
@@ -148,6 +150,7 @@ 
 	/**
 	 * This must be called internally or when instantiated.
 	 * @param integer The precision of numeric priorities.
+	 * @param integer $value
 	 */
 	protected function setPrecision($value)
 	{
@@ -338,7 +341,7 @@ 
 	 * @param mixed key
 	 * @param mixed value
 	 * @param numeric|null priority, default: null, filled in with default priority
-	 * @return numeric priority at which the pair was added
+	 * @return string priority at which the pair was added
 	 * @throws TInvalidOperationException if the map is read-only
 	 */
 	public function add($key,$value,$priority=null)