pradosoft / prado

framework/Collections/TPagedList.php

Doc Comments +6 added lines

@@ -76,6 +76,7 @@ 
 	 * Constructor.
 	 * @param array|Iterator the initial data. Default is null, meaning no initialization.
 	 * @param boolean whether the list is read-only. Always true for paged list.
+	 * @param integer[] $data
 	 */
 	public function __construct($data=null,$readOnly=false)
 	{
@@ -92,6 +93,7 @@ 
 
 	/**
 	 * @param boolean whether to allow custom paging
+	 * @param boolean $value
 	 */
 	public function setCustomPaging($value)
 	{
@@ -139,6 +141,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 +154,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)
 	{
@@ -316,6 +320,7 @@ 
 
 	/**
 	 * @param mixed the item
+	 * @param integer $item
 	 * @return integer the index of the item in the list (0 based), -1 if not found.
 	 */
 	public function indexOf($item)
@@ -380,6 +385,7 @@ 
 	/**
 	 * Constructor.
 	 * @param integer old page index
+	 * @param integer $oldPage
 	 */
 	public function __construct($oldPage)
 	{

framework/Collections/TPriorityList.php

Doc Comments +11 added lines

@@ -113,6 +113,7 @@ 
 	/**
 	 * Gets the number of items at a priority within the list
 	 * @param numeric optional priority at which to count items.  if no parameter, it will be set to the default {@link getDefaultPriority}
+	 * @param integer $priority
 	 * @return integer the number of items in the list at the specified priority
 	 */
 	public function getPriorityCount($priority=null)
@@ -137,6 +138,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 +156,7 @@ 
 	/**
 	 * This must be called internally or when instantiated.
 	 * @param integer The precision of numeric priorities.
+	 * @param integer $value
 	 */
 	protected function setPrecision($value)
 	{
@@ -241,6 +244,7 @@ 
 	 * Returns the item at an index within a priority
 	 * @param integer the index into the list of items at priority
 	 * @param numeric the priority which to index.  no parameter or null will result in the default priority
+	 * @param integer $index
 	 * @return mixed the element at the offset, false if no element is found at the offset
 	 */
 	public function itemAtIndexInPriority($index,$priority=null)
@@ -275,6 +279,7 @@ 
 	 * and then inserts the item at that priority-index.
 	 * @param integer the specified position in the flattened list.
 	 * @param mixed new item to add
+	 * @param integer $index
 	 * @throws TInvalidDataValueException If the index specified exceeds the bound
 	 * @throws TInvalidOperationException if the list is read-only
 	 */
@@ -456,6 +461,7 @@ 
 
 	/**
 	 * @param mixed item
+	 * @param PriorityListItem $item
 	 * @return boolean whether the list contains the item
 	 */
 	public function contains($item)
@@ -590,6 +596,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 +617,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.
 	 */
@@ -714,6 +722,8 @@ 
 	 * an item into a priority list doesn't mean the item is at the end of the list.
 	 * @param integer the offset to set element
 	 * @param mixed the element value
+	 * @param null|integer $offset
+	 * @param integer $item
 	 */
 	public function offsetSet($offset,$item)
 	{
@@ -733,6 +743,7 @@ 
 	 * Unsets the element at the specified offset.
 	 * This method is required by the interface ArrayAccess.
 	 * @param mixed the offset to unset element
+	 * @param integer $offset
 	 */
 	public function offsetUnset($offset)
 	{

framework/Collections/TPriorityMap.php

Doc Comments +8 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)
 	{
@@ -270,6 +273,8 @@ 
 	 * This method is exactly the same as {@link offsetGet}.
 	 * @param mixed the key
 	 * @param numeric|null the priority.  default: null, filled in with the default priority numeric.
+	 * @param string $key
+	 * @param integer $priority
 	 * @return numeric old priority of the item
 	 */
 	public function setPriorityAt($key,$priority=null)
@@ -338,7 +343,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)
@@ -467,6 +472,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.
 	 */
@@ -487,6 +493,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/TQueue.php

Doc Comments +3 added lines

@@ -49,6 +49,7 @@ 
 	 * Constructor.
 	 * Initializes the queue with an array or an iterable object.
 	 * @param array|Iterator the intial data. Default is null, meaning no initialization.
+	 * @param integer[] $data
 	 * @throws TInvalidDataTypeException If data is not null and neither an array nor an iterator.
 	 */
 	public function __construct($data=null)
@@ -97,6 +98,7 @@ 
 
 	/**
 	 * @param mixed the item
+	 * @param integer $item
 	 * @return boolean whether the queue contains the item
 	 */
 	public function contains($item)
@@ -137,6 +139,7 @@ 
 	/**
 	 * Adds an object to the end of the queue.
 	 * @param mixed the item to be appended into the queue
+	 * @param integer $item
 	 */
 	public function enqueue($item)
 	{

framework/Collections/TStack.php

Doc Comments +1 added lines

@@ -46,6 +46,7 @@
 	 * Constructor.
 	 * Initializes the stack with an array or an iterable object.
 	 * @param array|Iterator the initial data. Default is null, meaning no initialization.
+	 * @param integer[] $data
 	 * @throws TInvalidDataTypeException If data is not null and neither an array nor an iterator.
 	 */
 	public function __construct($data=null)

framework/Data/ActiveRecord/Relations/TActiveRecordHasManyAssociation.php

Doc Comments +6 added lines

@@ -208,6 +208,7 @@ 
 	 * @param string active record class name.
 	 * @param array row data
 	 * @param array foreign key column names
+	 * @param string $type
 	 * @return TActiveRecord
 	 */
 	protected function createFkObject($type,$row,$foreignKeys)
@@ -227,6 +228,7 @@ 
 	 * @param TTableInfo association table info
 	 * @param array field names
 	 * @param array field values
+	 * @param TActiveRecordCriteria $criteria
 	 */
 	public function createCommand($criteria, $foreignKeys,$indexValues,$sourceKeys)
 	{
@@ -341,6 +343,10 @@ 
 		return $this->getCommandBuilder()->onExecuteCommand($command, $command->execute()) > 0;
 	}
 
+	/**
+	 * @param TActiveRecord $obj
+	 * @param TDbCommandBuilder $builder
+	 */
 	private function updateAssociationTable($obj,$fkObjects, $builder)
 	{
 		$source = $this->getSourceRecordValues($obj);

framework/Data/ActiveRecord/Relations/TActiveRecordRelation.php

Doc Comments +2 added lines, -1 removed lines

@@ -92,6 +92,7 @@ 
 
 	/**
 	 * Fetch results for current relationship.
+	 * @param TActiveRecord $obj
 	 * @return boolean always true.
 	 */
 	public function fetchResultsInto($obj)
@@ -104,7 +105,6 @@ 
 	 * Returns foreign keys in $fromRecord with source column names as key
 	 * and foreign column names in the corresponding $matchesRecord as value.
 	 * The method returns the first matching foreign key between these 2 records.
-	 * @param TActiveRecord $fromRecord
 	 * @param TActiveRecord $matchesRecord
 	 * @return array foreign keys with source column names as key and foreign column names as value.
 	 */
@@ -212,6 +212,7 @@ 
 	 * @param array source property names
 	 * @param array foreign objects
 	 * @param array foreign object field names.
+	 * @param TActiveRecord[] $fkObjects
 	 */
 	protected function populateResult(&$results,$properties,&$fkObjects,$fields)
 	{

framework/Data/ActiveRecord/Relations/TActiveRecordRelationContext.php

Doc Comments +5 added lines, -1 removed lines

@@ -30,6 +30,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;
@@ -163,6 +166,7 @@ 
 	 * An instance of TActiveRecordHasOne, TActiveRecordBelongsTo, TActiveRecordHasMany,
 	 * or TActiveRecordHasManyAssocation will be returned.
 	 * @param TActiveRecordCriteria search criteria
+	 * @param TSqlCriteria $criteria
 	 * @return TActiveRecordRelation record relationship handler instnace.
 	 * @throws TActiveRecordException if property is not defined or missing.
 	 */
@@ -195,7 +199,7 @@ 
 	}
 
 	/**
-	 * @return TActiveRecordRelationCommand
+	 * @return boolean
 	 */
 	public function updateAssociatedRecords($updateBelongsTo=false)
 	{

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

Doc Comments +9 added lines

@@ -46,6 +46,10 @@ 
 		}
 	}
 
+	/**
+	 * @param TScaffoldEditView $parent
+	 * @param TActiveRecord $record
+	 */
 	public function createScaffoldInput($parent, $item, $column, $record)
 	{
 		$this->_parent=$parent;
@@ -62,6 +66,11 @@ 
 		$label->setForControl(self::DEFAULT_ID);
 	}
 
+	/**
+	 * @param TScaffoldEditView $parent
+	 * @param TDbTableColumn $column
+	 * @param TActiveRecord $record
+	 */
 	public function loadScaffoldInput($parent, $item, $column, $record)
 	{
 		$this->_parent=$parent;