pradosoft / prado

framework/I18N/core/NumberFormat.php

Doc Comments +4 added lines, -1 removed lines

@@ -86,6 +86,7 @@ 
 	 * a CultureInfo or NumberFormatInfo instance will instantiated a instance
 	 * for that particular culture.
 	 * @param mixed either null, a CultureInfo, a NumberFormatInfo, or string
+	 * @param string $formatInfo
 	 * @return NumberFormat
 	 */
 	function __construct($formatInfo=null)
@@ -111,6 +112,7 @@ 
 	 * 3 decimal places.
 	 * @param string 3-letter ISO 4217 code. For example, the code
 	 * "USD" represents the US Dollar and "EUR" represents the Euro currency.
+	 * @param string $number
 	 * @return string formatted number string
 	 */
 	function format($number, $pattern='d', $currency='USD', $charset='UTF-8')
@@ -232,7 +234,7 @@ 
 
 	/**
 	 * Format the decimal places.
-	 * @param string the decimal number in string form.
+	 * @param string string decimal number in string form.
 	 * @return string formatted decimal places.
 	 */
 	protected function formatDecimal($string)
@@ -280,6 +282,7 @@ 
 	 * Set the pattern to format against. The default patterns
 	 * are retrieved from the NumberFormatInfo instance.
 	 * @param string the requested patterns.
+	 * @param string $pattern
 	 * @return string a number format pattern.
 	 */
 	protected function setPattern($pattern)

framework/I18N/TGlobalization.php

Doc Comments +1 added lines, -1 removed lines

@@ -90,7 +90,7 @@
 	}
 
 	/**
-	 * @return string default culture
+	 * @return boolean default culture
 	 */
 	public function getTranslateDefaultCulture()
 	{

framework/Security/TSecurityManager.php

Doc Comments +3 added lines, -1 removed lines

@@ -182,7 +182,7 @@ 
 	}
 
 	/**
-	 * @return mixed the algorithm used to encrypt/decrypt data. Defaults to the string 'rijndael-256'.
+	 * @return string the algorithm used to encrypt/decrypt data. Defaults to the string 'rijndael-256'.
 	 */
 	public function getCryptAlgorithm()
 	{
@@ -201,6 +201,7 @@ 
 	/**
 	 * Encrypts data with {@link getEncryptionKey EncryptionKey}.
 	 * @param string data to be encrypted.
+	 * @param string $data
 	 * @return string the encrypted data
 	 * @throws TNotSupportedException if PHP Mcrypt extension is not loaded
 	 */
@@ -220,6 +221,7 @@ 
 	/**
 	 * Decrypts data with {@link getEncryptionKey EncryptionKey}.
 	 * @param string data to be decrypted.
+	 * @param string $data
 	 * @return string the decrypted data
 	 * @throws TNotSupportedException if PHP Mcrypt extension is not loaded
 	 */

framework/Security/TUser.php

Doc Comments +4 added lines

@@ -73,6 +73,7 @@ 
 
 	/**
 	 * @param string username
+	 * @param string $value
 	 */
 	public function setName($value)
 	{
@@ -89,6 +90,7 @@ 
 
 	/**
 	 * @param boolean if the user is a guest
+	 * @param boolean $value
 	 */
 	public function setIsGuest($value)
 	{
@@ -170,6 +172,7 @@ 
 	 *
 	 * @param string variable name
 	 * @param mixed default value
+	 * @param string $key
 	 * @return mixed the value of the variable. If it doesn't exist, the provided default value will be returned
 	 * @see setState
 	 */
@@ -190,6 +193,7 @@ 
 	 * @param string variable name
 	 * @param mixed variable value
 	 * @param mixed default value. If $value===$defaultValue, the variable will be removed from persistent storage.
+	 * @param string $key
 	 * @see getState
 	 */
 	protected function setState($key,$value,$defaultValue=null)

framework/Web/TAssetManager.php

Doc Comments +9 added lines

@@ -215,6 +215,7 @@ 
 	 * This method does not perform any publishing. It merely tells you
 	 * if the file path is published, what the URL will be to access it.
 	 * @param string directory or file path being published
+	 * @param string $path
 	 * @return string the published URL for the file path
 	 */
 	public function getPublishedUrl($path)
@@ -230,6 +231,7 @@ 
 	 * Generate a CRC32 hash for the directory path. Collisions are higher
 	 * than MD5 but generates a much smaller hash string.
 	 * @param string string to be hashed.
+	 * @param string $dir
 	 * @return string hashed string.
 	 */
 	protected function hash($dir)
@@ -243,6 +245,8 @@ 
 	 * or has an older file modification time.
 	 * @param string source file path
 	 * @param string destination directory (if not exists, it will be created)
+	 * @param string $src
+	 * @param string $dst
 	 */
 	protected function copyFile($src,$dst)
 	{
@@ -265,6 +269,8 @@ 
 	 * File modification time is used to ensure the copied files are latest.
 	 * @param string the source directory
 	 * @param string the destination directory
+	 * @param string $src
+	 * @param string $dst
 	 * @todo a generic solution to ignore certain directories and files
 	 */
 	public function copyDirectory($src,$dst)
@@ -306,6 +312,8 @@ 
 	 * @param string tar filename
 	 * @param string MD5 checksum for the corresponding tar file.
 	 * @param boolean Wether or not to check the time stamp of the file for publishing. Defaults to false.
+	 * @param string $tarfile
+	 * @param string $md5sum
 	 * @return string URL path to the directory where the tar file was extracted.
 	 */
 	public function publishTarFile($tarfile, $md5sum, $checkTimestamp=false)
@@ -336,6 +344,7 @@ 
 	 * N.B Tar file must not be compressed.
 	 * @param string tar file
 	 * @param string path where the contents of tar file are to be extracted
+	 * @param string $destination
 	 * @return boolean true if extract successful, false otherwise.
 	 */
 	protected function deployTarFile($path,$destination)

bin/prado-cli.php

Doc Comments +34 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)
@@ -706,6 +731,9 @@ 
 		return $prop;
 	}
 
+	/**
+	 * @param string $class
+	 */
 	protected function generateClass($properties, $tablename, $class)
 	{
 		$props = implode("\n", $properties);
@@ -799,6 +827,9 @@ 
         return false;
     }
 
+    /**
+     * @param string $app_dir
+     */
     protected function getActiveRecordConfig($app_dir) {
         if (false === ($xml = $this->getXmlFile($app_dir)))
             return false;
@@ -842,6 +873,9 @@ 
 			}
 	    }
 
+	    /**
+	     * @param string $l
+	     */
 	    public function generate($l)
 	    {
 			$input = explode(" ", trim($l));

framework/Caching/ICache.php

Doc Comments +1 added lines

@@ -149,6 +149,7 @@
 	/**
 	 * Finds the database connection instance from the Application modules.
 	 * @param string Database connection module ID.
+	 * @param string $id
 	 * @return TDbConnection database connection.
 	 * @throws TConfigurationException when module is not of TDbConnection or TDataSourceConfig.
 	 */

framework/Caching/TCache.php

Doc Comments +9 added lines, -3 removed lines

@@ -109,7 +109,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)
 	{
@@ -143,7 +143,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)
 	{
@@ -201,6 +201,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);
@@ -215,6 +216,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);
@@ -229,6 +232,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);
@@ -237,6 +242,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);
@@ -280,7 +286,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

@@ -123,6 +123,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)
@@ -136,6 +137,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)
@@ -149,6 +151,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)