pradosoft / prado

bin/prado-cli.php

Doc Comments +25 added lines

@@ -143,6 +143,10 @@ 
 	 */
 	abstract public function performAction($args);
 
+	/**
+	 * @param string $dir
+	 * @param integer $mask
+	 */
 	protected function createDirectory($dir, $mask)
 	{
 		if(!is_dir($dir))
@@ -154,6 +158,9 @@ 
 			chmod($dir, $mask);
 	}
 
+	/**
+	 * @param string $filename
+	 */
 	protected function createFile($filename, $content)
 	{
 		if(!is_file($filename))
@@ -302,6 +309,9 @@ 
 ';
 	}
 
+	/**
+	 * @param string $appName
+	 */
 	protected function renderConfigFile($appName)
 	{
 		return <<<EOD
@@ -515,6 +525,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $app_dir
+	 */
 	protected function getActiveRecordConfig($app_dir)
 	{
 		if(false === ($xml = $this->getXmlFile($app_dir)))
@@ -530,6 +543,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $app_dir
+	 */
 	protected function getOutputFile($app_dir, $namespace)
 	{
 		if(is_file($namespace) && strpos($namespace, $app_dir) === 0)
@@ -591,6 +607,9 @@ 
 		return $prop;
 	}
 
+	/**
+	 * @param string $class
+	 */
 	protected function generateClass($properties, $tablename, $class)
 	{
 		$props = implode("\n", $properties);
@@ -686,6 +705,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param string $l
+	 */
 	public function generate($l)
 	{
 		$input = explode(" ", trim($l));
@@ -724,6 +746,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $app_dir
+	 */
 	protected function getActiveRecordConfig($app_dir) {
 		if (false === ($xml = $this->getXmlFile($app_dir)))
 			return false;

framework/Caching/ICache.php

Doc Comments +1 added lines

@@ -47,6 +47,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 labelled invalid.
+	 * @param string $id
 	 * @return boolean true if the value is successfully stored into cache, false otherwise
 	 */
 	public function add($id, $value, $expire = 0, $dependency = null);

framework/Caching/TCache.php

Doc Comments +9 added lines, -3 removed lines

@@ -110,7 +110,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)
 	{
@@ -144,7 +144,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)
 	{
@@ -202,6 +202,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);
@@ -216,6 +217,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);
@@ -230,6 +233,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);
@@ -238,6 +243,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);
@@ -281,7 +287,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

@@ -124,6 +124,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)
@@ -137,6 +138,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)
@@ -150,6 +152,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/Caching/TEtcdCache.php

Doc Comments +2 added lines

@@ -206,6 +206,8 @@
    * @param string the HTTP method for the request (GET,PUT,DELETE)
    * @param string the the key to perform the action on (includes the directory)
    * @param array the additional post data to send with the request
+   * @param string $method
+   * @param string $key
    * @return \stdClass the response from the etcd instance
    */
   protected function request($method, $key, $value = []) {

framework/Collections/TPriorityMap.php

Doc Comments +5 added lines, -2 removed lines

@@ -119,6 +119,7 @@ 
 
 	/**
 	 * @param boolean whether this list is read-only or not
+	 * @param boolean $value
 	 */
 	protected function setReadOnly($value)
 	{
@@ -136,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)
 	{
@@ -153,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)
 	{
@@ -162,7 +165,7 @@ 
 	/**
 	 * Returns an iterator for traversing the items in the map.
 	 * This method is required by the interface \IteratorAggregate.
-	 * @return Iterator an iterator for traversing the items in the map.
+	 * @return \ArrayIterator an iterator for traversing the items in the map.
 	 */
 	public function getIterator()
 	{
@@ -343,7 +346,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)

framework/Data/ActiveRecord/Relations/TActiveRecordRelationContext.php

Doc Comments +5 added lines, -1 removed lines

@@ -36,6 +36,9 @@ 
 	private $_relation; //data from an entry of TActiveRecord::$RELATION
 	private $_fkeys;
 
+	/**
+	 * @param TActiveRecord $record
+	 */
 	public function __construct($record, $property = null, $relation = null)
 	{
 		$this->_record = $record;
@@ -169,6 +172,7 @@ 
 	 * An instance of TActiveRecordHasOne, TActiveRecordBelongsTo, TActiveRecordHasMany,
 	 * or TActiveRecordHasManyAssocation will be returned.
 	 * @param TActiveRecordCriteria search criteria
+	 * @param \Prado\Data\DataGateway\TSqlCriteria $criteria
 	 * @return TActiveRecordRelation record relationship handler instnace.
 	 * @throws TActiveRecordException if property is not defined or missing.
 	 */
@@ -197,7 +201,7 @@ 
 	}
 
 	/**
-	 * @return TActiveRecordRelationCommand
+	 * @return boolean
 	 */
 	public function updateAssociatedRecords($updateBelongsTo = false)
 	{

framework/Data/ActiveRecord/Scaffold/InputBuilder/TScaffoldInputBase.php

Doc Comments +8 added lines

@@ -52,6 +52,10 @@ 
 		}
 	}
 
+	/**
+	 * @param \Prado\Data\ActiveRecord\Scaffold\TScaffoldEditView $parent
+	 * @param \Prado\Data\ActiveRecord\TActiveRecord $record
+	 */
 	public function createScaffoldInput($parent, $item, $column, $record)
 	{
 		$this->_parent = $parent;
@@ -68,6 +72,10 @@ 
 		$label->setForControl(self::DEFAULT_ID);
 	}
 
+	/**
+	 * @param \Prado\Data\ActiveRecord\Scaffold\TScaffoldEditView $parent
+	 * @param \Prado\Data\ActiveRecord\TActiveRecord $record
+	 */
 	public function loadScaffoldInput($parent, $item, $column, $record)
 	{
 		$this->_parent = $parent;

framework/Data/ActiveRecord/TActiveRecord.php

Doc Comments +10 added lines, -2 removed lines

@@ -324,7 +324,7 @@ 
 	/**
 	 * Gets the current Db connection, the connection object is obtained from
 	 * the TActiveRecordManager if connection is currently null.
-	 * @return TDbConnection current db connection for this object.
+	 * @return \Prado\Data\TDbConnection current db connection for this object.
 	 */
 	public function getDbConnection()
 	{
@@ -511,6 +511,7 @@ 
 	 * Delete multiple records using a criteria.
 	 * @param string|TActiveRecordCriteria SQL condition or criteria object.
 	 * @param mixed parameter values.
+	 * @param TSqlCriteria $criteria
 	 * @return int number of records deleted.
 	 */
 	public function deleteAll($criteria = null, $parameters = [])
@@ -577,6 +578,7 @@ 
 	 *
 	 * @param string|TActiveRecordCriteria SQL condition or criteria object.
 	 * @param mixed parameter values.
+	 * @param TSqlCriteria $criteria
 	 * @return TActiveRecord matching record object. Null if no result is found.
 	 */
 	public function find($criteria, $parameters = [])
@@ -593,6 +595,7 @@ 
 	 *
 	 * @param string|TActiveRecordCriteria SQL condition or criteria object.
 	 * @param mixed parameter values.
+	 * @param TSqlCriteria $criteria
 	 * @return array matching record objects. Empty array if no result is found.
 	 */
 	public function findAll($criteria = null, $parameters = [])
@@ -706,6 +709,7 @@ 
 	 * Find the number of records.
 	 * @param string|TActiveRecordCriteria SQL condition or criteria object.
 	 * @param mixed parameter values.
+	 * @param TActiveRecordCriteria $criteria
 	 * @return int number of records.
 	 */
 	public function count($criteria = null, $parameters = [])
@@ -721,6 +725,7 @@ 
 	 * value equal to the $property value.
 	 * @param string relationship/property name corresponding to keys in $RELATION array.
 	 * @param array method call arguments.
+	 * @param string $name
 	 * @return TActiveRecordRelation, null if the context or the handler doesn't exist
 	 */
 	protected function getRelationHandler($name, $args = [])
@@ -945,6 +950,7 @@ 
 	 * Raised before the record attempt to insert its data into the database.
 	 * To prevent the insert operation, set the TActiveRecordChangeEventParameter::IsValid parameter to false.
 	 * @param TActiveRecordChangeEventParameter event parameter to be passed to the event handlers
+	 * @param TActiveRecordChangeEventParameter $param
 	 */
 	public function onInsert($param)
 	{
@@ -955,6 +961,7 @@ 
 	 * Raised before the record attempt to delete its data from the database.
 	 * To prevent the delete operation, set the TActiveRecordChangeEventParameter::IsValid parameter to false.
 	 * @param TActiveRecordChangeEventParameter event parameter to be passed to the event handlers
+	 * @param TActiveRecordChangeEventParameter $param
 	 */
 	public function onDelete($param)
 	{
@@ -965,6 +972,7 @@ 
 	 * Raised before the record attempt to update its data in the database.
 	 * To prevent the update operation, set the TActiveRecordChangeEventParameter::IsValid parameter to false.
 	 * @param TActiveRecordChangeEventParameter event parameter to be passed to the event handlers
+	 * @param TActiveRecordChangeEventParameter $param
 	 */
 	public function onUpdate($param)
 	{
@@ -1048,7 +1056,7 @@ 
 	
 		/**
 		 * Return record data as JSON
-		 * @return JSON
+		 * @return string
 		 * @since 3.2.4
 		 */
 		public function toJSON(){