pradosoft / prado

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)

framework/Data/ActiveRecord/TActiveRecord.php

Doc Comments +9 added lines, -1 removed lines

@@ -505,6 +505,7 @@ 
 	 * Delete multiple records using a criteria.
 	 * @param string|TActiveRecordCriteria SQL condition or criteria object.
 	 * @param mixed parameter values.
+	 * @param TActiveRecordCriteria $criteria
 	 * @return int number of records deleted.
 	 */
 	public function deleteAll($criteria=null, $parameters=array())
@@ -571,6 +572,7 @@ 
 	 *
 	 * @param string|TActiveRecordCriteria SQL condition or criteria object.
 	 * @param mixed parameter values.
+	 * @param TActiveRecordCriteria $criteria
 	 * @return TActiveRecord matching record object. Null if no result is found.
 	 */
 	public function find($criteria,$parameters=array())
@@ -587,6 +589,7 @@ 
 	 *
 	 * @param string|TActiveRecordCriteria SQL condition or criteria object.
 	 * @param mixed parameter values.
+	 * @param TActiveRecordCriteria $criteria
 	 * @return array matching record objects. Empty array if no result is found.
 	 */
 	public function findAll($criteria=null,$parameters=array())
@@ -700,6 +703,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=array())
@@ -715,6 +719,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=array())
@@ -939,6 +944,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)
 	{
@@ -949,6 +955,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)
 	{
@@ -959,6 +966,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)
 	{
@@ -1042,7 +1050,7 @@ 
     
     	/**
      	* Return record data as JSON
-     	* @return JSON
+     	* @return string
      	* @since 3.2.4
      	*/
     	public function toJSON(){

framework/Data/ActiveRecord/TActiveRecordManager.php

Doc Comments +4 added lines

@@ -67,6 +67,7 @@ 
 
 	/**
 	 * @param ICache application cache
+	 * @param ICache $value
 	 */
 	public function setCache($value)
 	{
@@ -75,6 +76,7 @@ 
 
 	/**
 	 * @param TDbConnection default database connection
+	 * @param TDbConnection $conn
 	 */
 	public function setDbConnection($conn)
 	{
@@ -90,6 +92,7 @@ 
 	}
 
 	/**
+	 * @param TComponent $self
 	 * @return TActiveRecordManager static instance of record manager.
 	 */
 	public static function getInstance($self=null)
@@ -152,6 +155,7 @@ 
 	/**
 	 * Define the way an active record finder react if an invalid magic-finder invoked
 	 * @param TActiveRecordInvalidFinderResult
+	 * @param TActiveRecordInvalidFinderResult $value
 	 * @since 3.1.5
 	 * @see getInvalidFinderResult
 	 */

framework/Data/DataGateway/TTableGateway.php

Doc Comments +8 added lines, -3 removed lines

@@ -100,6 +100,7 @@ 
 
 	/**
 	 * @param TDbTableInfo table or view information.
+	 * @param TDbTableInfo $tableInfo
 	 */
 	protected function setTableInfo($tableInfo)
 	{
@@ -110,6 +111,7 @@ 
 	/**
 	 * Sets up the command builder for the given table.
 	 * @param string table or view name.
+	 * @param string $tableName
 	 */
 	protected function setTableName($tableName)
 	{
@@ -185,7 +187,7 @@ 
 	 * Execute arbituary sql command with binding parameters.
 	 * @param string SQL query string.
 	 * @param array binding parameters, positional or named.
-	 * @return array query results.
+	 * @return TDbDataReader query results.
 	 */
 	public function findBySql($sql, $parameters=array())
 	{
@@ -222,6 +224,7 @@ 
 	 *
 	 * @param string|TSqlCriteria SQL condition or criteria object.
 	 * @param mixed parameter values.
+	 * @param TActiveRecordCriteria $criteria
 	 * @return array matching record object.
 	 */
 	public function find($criteria, $parameters=array())
@@ -235,6 +238,7 @@ 
 	 * Accepts same parameters as find(), but returns TDbDataReader instead.
 	 * @param string|TSqlCriteria SQL condition or criteria object.
 	 * @param mixed parameter values.
+	 * @param TActiveRecordCriteria $criteria
 	 * @return TDbDataReader matching records.
 	 */
 	public function findAll($criteria=null, $parameters=array())
@@ -297,6 +301,7 @@ 
 	 * </code>
 	 * @param string delete condition.
 	 * @param array condition parameters.
+	 * @param TActiveRecordCriteria $criteria
 	 * @return integer number of records deleted.
 	 */
 	public function deleteAll($criteria, $parameters=array())
@@ -385,7 +390,7 @@ 
 	 * Inserts a new record into the table. Each array key must
 	 * correspond to a column name in the table unless a null value is permitted.
 	 * @param array new record data.
-	 * @return mixed last insert id if one column contains a serial or sequence,
+	 * @return string|boolean last insert id if one column contains a serial or sequence,
 	 * otherwise true if command executes successfully and affected 1 or more rows.
 	 */
 	public function insert($data)
@@ -394,7 +399,7 @@ 
 	}
 
 	/**
-	 * @return mixed last insert id, null if none is found.
+	 * @return string|null last insert id, null if none is found.
 	 */
 	public function getLastInsertId()
 	{

framework/Data/SqlMap/Configuration/TSqlMapCacheModel.php

Doc Comments +5 added lines, -2 removed lines

@@ -129,6 +129,7 @@ 
 	/**
 	 * Register a mapped statement that will trigger a cache flush.
 	 * @param TMappedStatement mapped statement that may flush the cache.
+	 * @param IMappedStatement $mappedStatement
 	 */
 	public function registerTriggerStatement($mappedStatement)
 	{
@@ -145,6 +146,7 @@ 
 
 	/**
 	 * @param TSqlMapCacheKey|string cache key
+	 * @param string $key
 	 * @return mixed cached value.
 	 */
 	public function get($key)
@@ -163,6 +165,7 @@ 
 	/**
 	 * @param TSqlMapCacheKey|string cache key
 	 * @param mixed value to be cached.
+	 * @param string $key
 	 */
 	public function set($key, $value)
 	{
@@ -174,7 +177,7 @@ 
 	}
 
 	/**
-	 * @return float cache hit ratio.
+	 * @return integer cache hit ratio.
 	 */
 	public function getHitRatio()
 	{
@@ -223,7 +226,7 @@ 
 	}
 
 	/**
-	 * @param string serialized object
+	 * @param string string object
 	 * @return string crc32 hash of the serialized object.
 	 */
 	protected function generateKey($string)

framework/Data/SqlMap/DataMapper/TSqlMapCache.php

Doc Comments +3 added lines

@@ -205,6 +205,9 @@
 		return $keyList;
 	}
 
+	/**
+	 * @param TList $keyList
+	 */
 	protected function setKeyList($keyList)
 	{
 		$this->getCache()->set($this->getKeyListId(), $keyList);