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 @@ 
 		}
 	}
 
+	/**
+	 * @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
@@ -520,6 +530,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $app_dir
+	 */
 	protected function getActiveRecordConfig($app_dir)
 	{
 		if (false === ($xml = $this->getXmlFile($app_dir))) {
@@ -537,6 +550,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $app_dir
+	 */
 	protected function getOutputFile($app_dir, $namespace)
 	{
 		if (is_file($namespace) && strpos($namespace, $app_dir) === 0) {
@@ -596,6 +612,9 @@ 
 		return $prop;
 	}
 
+	/**
+	 * @param string $class
+	 */
 	protected function generateClass($properties, $tablename, $class)
 	{
 		$props = implode("\n", $properties);
@@ -691,6 +710,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param string $l
+	 */
 	public function generate($l)
 	{
 		$input = explode(" ", trim($l));
@@ -734,6 +756,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $app_dir
+	 */
 	protected function getActiveRecordConfig($app_dir)
 	{
 		if (false === ($xml = $this->getXmlFile($app_dir))) {

framework/Caching/TCache.php

Doc Comments +3 added lines, -3 removed lines

@@ -111,7 +111,7 @@ 
 
 	/**
 	 * @param string $key 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)
 	{
@@ -146,7 +146,7 @@ 
 	 * @param mixed $value the value to be cached
 	 * @param int $expire the number of seconds in which the cached value will expire. 0 means never expire.
 	 * @param ICacheDependency $dependency dependency of the cached item. If the dependency changes, the item is labeled invalid.
-	 * @return bool 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)
 	{
@@ -283,7 +283,7 @@ 
 	 * Deletes the value with the specified key from cache
 	 * This method is required by the interface \ArrayAccess.
 	 * @param string $id the key of the value to be deleted
-	 * @return bool if no error happens during deletion
+	 * @return boolean|null if no error happens during deletion
 	 */
 	public function offsetUnset($id)
 	{

framework/Collections/TAttributeCollection.php

Doc Comments +3 added lines, -3 removed lines

@@ -103,7 +103,7 @@ 
 	/**
 	 * Returns the item with the specified key.
 	 * This overrides the parent implementation by converting the key to lower case first if CaseSensitive is false.
-	 * @param mixed $key the key
+	 * @param string $key the key
 	 * @return mixed the element at the offset, null if no element is found at the offset
 	 */
 	public function itemAt($key)
@@ -115,7 +115,7 @@ 
 	/**
 	 * Adds an item into the map.
 	 * This overrides the parent implementation by converting the key to lower case first if CaseSensitive is false.
-	 * @param mixed $key
+	 * @param string $key
 	 * @param mixed $value
 	 */
 	public function add($key, $value)
@@ -126,7 +126,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 $key the key of the item to be removed
+	 * @param string $key the key of the item to be removed
 	 * @return mixed the removed value, null if no such key exists.
 	 */
 	public function remove($key)

framework/Collections/TPagedDataSource.php

Doc Comments +1 added lines, -1 removed lines

@@ -68,7 +68,7 @@
 	}
 
 	/**
-	 * @param mixed $value original data source
+	 * @param \Traversable $value original data source
 	 */
 	public function setDataSource($value)
 	{

framework/Collections/TPagedList.php

Doc Comments +1 added lines, -1 removed lines

@@ -289,7 +289,7 @@
 	}
 
 	/**
-	 * @return Iterator iterator
+	 * @return \ArrayIterator iterator
 	 */
 	public function getIterator()
 	{

framework/Collections/TPriorityList.php

Doc Comments +6 added lines, -6 removed lines

@@ -84,7 +84,7 @@ 
 	 * Initializes the list with an array or an iterable object.
 	 * @param null|array|Iterator $data the intial data. Default is null, meaning no initial data.
 	 * @param bool $readOnly whether the list is read-only
-	 * @param numeric $defaultPriority the default priority of items without specified priorities.
+	 * @param integer $defaultPriority the default priority of items without specified priorities.
 	 * @param int $precision the precision of the numeric priorities
 	 * @throws TInvalidDataTypeException If data is not null and is neither an array nor an iterator.
 	 */
@@ -146,7 +146,7 @@ 
 
 	/**
 	 * This must be called internally or when instantiated.
-	 * @param numeric $value sets the default priority of inserted items without a specified priority
+	 * @param integer $value sets the default priority of inserted items without a specified priority
 	 */
 	protected function setDefaultPriority($value)
 	{
@@ -173,7 +173,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()
 	{
@@ -386,7 +386,7 @@ 
 	/**
 	 * Removes an item from the priority list.
 	 * The list will search for the item.  The first matching item found will be removed from the list.
-	 * @param mixed $item item the item to be removed.
+	 * @param callable $item item the item to be removed.
 	 * @param null|bool|float $priority priority of item to remove. without this parameter it defaults to false.
 	 * A value of false means any priority. null will be filled in with the default priority.
 	 * @throws TInvalidDataValueException If the item does not exist
@@ -630,7 +630,7 @@ 
 
 	/**
 	 * Combines the map elements which have a priority below the parameter value
-	 * @param numeric $priority the cut-off priority.  All items of priority less than this are returned.
+	 * @param integer $priority the cut-off priority.  All items of priority less than this are returned.
 	 * @param bool $inclusive whether or not the input cut-off priority is inclusive.  Default: false, not inclusive.
 	 * @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.
@@ -650,7 +650,7 @@ 
 
 	/**
 	 * Combines the map elements which have a priority above the parameter value
-	 * @param numeric $priority the cut-off priority.  All items of priority greater than this are returned.
+	 * @param integer $priority the cut-off priority.  All items of priority greater than this are returned.
 	 * @param bool $inclusive whether or not the input cut-off priority is inclusive.  Default: true, inclusive.
 	 * @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/Data/ActiveRecord/Relations/TActiveRecordHasManyAssociation.php

Doc Comments +6 added lines, -2 removed lines

@@ -160,7 +160,7 @@ 
 	}
 
 	/**
-	 * @return TDataGatewayCommand
+	 * @return \Prado\Data\DataGateway\TDataGatewayCommand
 	 */
 	protected function getCommandBuilder()
 	{
@@ -168,7 +168,7 @@ 
 	}
 
 	/**
-	 * @return TDataGatewayCommand
+	 * @return \Prado\Data\DataGateway\TDataGatewayCommand
 	 */
 	protected function getForeignCommandBuilder()
 	{
@@ -227,6 +227,7 @@ 
 	 * @param array $foreignKeys field names
 	 * @param array $indexValues field values
 	 * @param array $sourceKeys source table column names.
+	 * @return \Prado\Data\DataGateway\TDataGatewayCommand
 	 */
 	public function createCommand($criteria, $foreignKeys, $indexValues, $sourceKeys)
 	{
@@ -344,6 +345,9 @@ 
 		return $this->getCommandBuilder()->onExecuteCommand($command, $command->execute()) > 0;
 	}
 
+	/**
+	 * @param TActiveRecord $obj
+	 */
 	private function updateAssociationTable($obj, $fkObjects, $builder)
 	{
 		$source = $this->getSourceRecordValues($obj);

framework/Data/ActiveRecord/Scaffold/TScaffoldEditView.php

Doc Comments +3 added lines, -3 removed lines

@@ -104,7 +104,7 @@ 
 	}
 
 	/**
-	 * @return TActiveRecord current Active Record instance
+	 * @return \Prado\Data\ActiveRecord\TActiveRecord current Active Record instance
 	 */
 	protected function getCurrentRecord()
 	{
@@ -133,7 +133,7 @@ 
 
 	/**
 	 * Instantiate the external edit renderer.
-	 * @param TActiveRecord $record record to be edited
+	 * @param \Prado\Data\ActiveRecord\TActiveRecord $record record to be edited
 	 * @param string $classPath external edit renderer class name.
 	 * @throws TConfigurationException raised when renderer is not an
 	 * instance of IScaffoldEditRenderer.
@@ -261,7 +261,7 @@ 
 
 	/**
 	 * Create the default scaffold editor control factory.
-	 * @param TActiveRecord $record record instance.
+	 * @param \Prado\Data\ActiveRecord\TActiveRecord $record record instance.
 	 * @return TScaffoldInputBase scaffold editor control factory.
 	 */
 	protected function getScaffoldInputBuilder($record)

framework/Data/ActiveRecord/TActiveRecord.php

Doc Comments +3 added lines, -3 removed lines

@@ -329,7 +329,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()
 	{
@@ -582,7 +582,7 @@ 
 	 * $finder->find($criteria); //the 2nd parameter for find() is ignored.
 	 * </code>
 	 *
-	 * @param string|TActiveRecordCriteria $criteria SQL condition or criteria object.
+	 * @param TSqlCriteria $criteria SQL condition or criteria object.
 	 * @param mixed $parameters parameter values.
 	 * @return TActiveRecord matching record object. Null if no result is found.
 	 */
@@ -1065,7 +1065,7 @@ 
 
 	/**
 	 * Return record data as JSON
-	 * @return JSON
+	 * @return string
 	 * @since 3.2.4
 	 */
 	public function toJSON()