pradosoft / prado

framework/Security/TUser.php

Doc Comments +4 added lines

@@ -72,6 +72,7 @@ 
 
 	/**
 	 * @param string username
+	 * @param string $value
 	 */
 	public function setName($value)
 	{
@@ -88,6 +89,7 @@ 
 
 	/**
 	 * @param boolean if the user is a guest
+	 * @param boolean $value
 	 */
 	public function setIsGuest($value)
 	{
@@ -169,6 +171,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
 	 */
@@ -189,6 +192,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/TApplication.php

Doc Comments +9 added lines

@@ -317,6 +317,7 @@ 
 	 * to determine the application configuration file,
 	 * application root path and the runtime path.
 	 * @param string the application root path or the application configuration file
+	 * @param string $basePath
 	 * @see setBasePath
 	 * @see setRuntimePath
 	 * @see setConfigurationFile
@@ -415,6 +416,7 @@ 
 	 * A global value is one that is persistent across users sessions and requests.
 	 * @param string the name of the value to be returned
 	 * @param mixed the default value. If $key is not found, $defaultValue will be returned
+	 * @param integer $defaultValue
 	 * @return mixed the global value corresponding to $key
 	 */
 	public function getGlobalState($key, $defaultValue = null)
@@ -431,6 +433,7 @@ 
 	 * @param mixed the global value to be set
 	 * @param mixed the default value. If $key is not found, $defaultValue will be returned
 	 * @param boolean wheter to force an immediate GlobalState save. defaults to false
+	 * @param string $key
 	 */
 	public function setGlobalState($key, $value, $defaultValue = null, $forceSave = false)
 	{
@@ -545,6 +548,7 @@ 
 
 	/**
 	 * @param string the directory containing the application configuration file
+	 * @param string $value
 	 */
 	public function setBasePath($value)
 	{
@@ -561,6 +565,7 @@ 
 
 	/**
 	 * @param string the application configuration file (absolute path)
+	 * @param string $value
 	 */
 	public function setConfigurationFile($value)
 	{
@@ -577,6 +582,7 @@ 
 
 	/**
 	 * @param string the application configuration type. 'xml' and 'php' are valid values
+	 * @param string $value
 	 */
 	public function setConfigurationType($value)
 	{
@@ -632,6 +638,7 @@ 
 
 	/**
 	 * @param string the directory storing cache data and application-level persistent data. (absolute path)
+	 * @param string $value
 	 */
 	public function setRuntimePath($value)
 	{
@@ -1063,6 +1070,7 @@ 
 	 * The service instance will be created. Its properties will be initialized
 	 * and the configurations will be applied, if any.
 	 * @param string service ID
+	 * @param string $serviceID
 	 */
 	public function startService($serviceID)
 	{
@@ -1101,6 +1109,7 @@ 
 	 * This method is invoked when an exception is raised during the lifecycles
 	 * of the application.
 	 * @param mixed event parameter
+	 * @param \Exception $param
 	 */
 	public function onError($param)
 	{

framework/TApplicationComponent.php

Doc Comments +5 added lines, -3 removed lines

@@ -51,7 +51,7 @@ 
 	}
 
 	/**
-	 * @return THttpRequest the current user request
+	 * @return Web\THttpRequest the current user request
 	 */
 	public function getRequest()
 	{
@@ -59,7 +59,7 @@ 
 	}
 
 	/**
-	 * @return THttpResponse the response
+	 * @return Web\THttpResponse the response
 	 */
 	public function getResponse()
 	{
@@ -67,7 +67,7 @@ 
 	}
 
 	/**
-	 * @return THttpSession user session
+	 * @return Web\THttpSession user session
 	 */
 	public function getSession()
 	{
@@ -94,6 +94,7 @@ 
 	 *
 	 * @param string path of the asset that is relative to the directory containing the specified class file.
 	 * @param string name of the class whose containing directory will be prepend to the asset path. If null, it means get_class($this).
+	 * @param string $assetPath
 	 * @return string URL to the asset path.
 	 */
 	public function publishAsset($assetPath, $className = null)
@@ -108,6 +109,7 @@ 
 	/**
 	 * Publishes a file or directory and returns its URL.
 	 * @param string absolute path of the file or directory to be published
+	 * @param string $fullPath
 	 * @return string URL to the published file or directory
 	 */
 	public function publishFilePath($fullPath, $checkTimestamp = false)

framework/TComponentReflection.php

Doc Comments +6 added lines

@@ -56,6 +56,9 @@ 
 		$this->reflect();
 	}
 
+	/**
+	 * @param \ReflectionMethod $method
+	 */
 	private function isPropertyMethod($method)
 	{
 		$methodName = $method->getName();
@@ -64,6 +67,9 @@ 
 				&& isset($methodName[3]);
 	}
 
+	/**
+	 * @param \ReflectionMethod $method
+	 */
 	private function isEventMethod($method)
 	{
 		$methodName = $method->getName();

framework/Util/TSimpleDateFormatter.php

Doc Comments +11 added lines, -1 removed lines

@@ -65,6 +65,7 @@ 
 	 * Constructor, create a new date time formatter.
 	 * @param string formatting pattern.
 	 * @param string pattern and value charset
+	 * @param string $pattern
 	 */
 	public function __construct($pattern, $charset = 'UTF-8')
 	{
@@ -98,6 +99,7 @@ 
 
 	/**
 	 * @param string formatting charset.
+	 * @param string $charset
 	 */
 	public function setCharset($charset)
 	{
@@ -172,7 +174,7 @@ 
 	/**
 	 * Gets the time stamp from string or integer.
 	 * @param string|int date to parse
-	 * @return array date info array
+	 * @return \DateTime date info array
 	 */
 	private function getDate($value)
 	{
@@ -324,6 +326,7 @@ 
 
 	/**
 	 * Calculate the length of a string, may be consider iconv_strlen?
+	 * @param string $string
 	 */
 	private function length($string)
 	{
@@ -349,6 +352,9 @@ 
 
 	/**
 	 * Returns true if char at position equals a particular char.
+	 * @param string $string
+	 * @param integer $pos
+	 * @param string $char
 	 */
 	private function charEqual($string, $pos, $char)
 	{
@@ -361,6 +367,10 @@ 
 	 * @param int starting position
 	 * @param int minimum integer length
 	 * @param int maximum integer length
+	 * @param string $str
+	 * @param integer $i
+	 * @param integer|null $minlength
+	 * @param integer|null $maxlength
 	 * @return string integer portion of the string, null otherwise
 	 */
 	private function getInteger($str, $i, $minlength, $maxlength)

framework/Web/Services/TPageService.php

Doc Comments +6 added lines, -1 removed lines

@@ -170,6 +170,7 @@ 
 	 * parameter initialization, module loadings, page initial properties
 	 * and authorization rules.
 	 * @param TPageConfiguration
+	 * @param TPageConfiguration $pageConfig
 	 */
 	protected function initPageContext($pageConfig)
 	{
@@ -377,6 +378,7 @@ 
 
 	/**
 	 * @param string default page path to be served if no explicit page is request
+	 * @param string $value
 	 * @throws TInvalidOperationException if the page service is initialized
 	 */
 	public function setDefaultPage($value)
@@ -479,7 +481,8 @@ 
 	/**
 	 * Creates a page instance based on requested page path.
 	 * @param string requested page path
-	 * @return TPage the requested page instance
+	 * @param string $pagePath
+	 * @return \Prado\TComponent the requested page instance
 	 * @throws THttpException if requested page path is invalid
 	 * @throws TConfigurationException if the page class cannot be found
 	 */
@@ -527,6 +530,7 @@ 
 	 * Executes a page.
 	 * @param TPage the page instance to be run
 	 * @param array list of initial page properties
+	 * @param \Prado\TComponent $page
 	 */
 	protected function runPage($page, $properties)
 	{
@@ -541,6 +545,7 @@ 
 	 * @param array list of GET parameters, null if no GET parameters required
 	 * @param boolean whether to encode the ampersand in URL, defaults to true.
 	 * @param boolean whether to encode the GET parameters (their names and values), defaults to true.
+	 * @param string $pagePath
 	 * @return string URL for the page and GET parameters
 	 */
 	public function constructUrl($pagePath, $getParams = null, $encodeAmpersand = true, $encodeGetItems = true)

framework/Web/TAssetManager.php

Doc Comments +9 added lines

@@ -225,6 +225,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)
@@ -240,6 +241,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)
@@ -253,6 +255,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)
 	{
@@ -275,6 +279,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)
@@ -316,6 +322,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)
@@ -346,6 +354,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)

framework/Web/THttpCookieCollection.php

Doc Comments +2 added lines

@@ -38,6 +38,7 @@ 
 	/**
 	 * Constructor.
 	 * @param mixed owner of this collection.
+	 * @param THttpResponse $owner
 	 */
 	public function __construct($owner = null)
 	{
@@ -81,6 +82,7 @@ 
 
 	/**
 	 * @param integer|string index of the cookie in the collection or the cookie's name
+	 * @param string $index
 	 * @return THttpCookie the cookie found
 	 */
 	public function itemAt($index)

framework/Web/THttpResponse.php

Doc Comments +4 added lines

@@ -234,6 +234,7 @@ 
 
 	/**
 	 * @param string|boolean output charset.
+	 * @param string $charset
 	 */
 	public function setCharset($charset)
 	{
@@ -403,6 +404,7 @@ 
 	 * The current application will be terminated after this method is invoked.
 	 * @param string URL to be redirected to. If the URL is a relative one, the base URL of
 	 * the current request will be inserted at the beginning.
+	 * @param string $url
 	 */
 	public function redirect($url)
 	{
@@ -618,6 +620,7 @@ 
 	 * Sends a header.
 	 * @param string header
 	 * @param boolean whether the header should replace a previous similar header, or add a second header of the same type
+	 * @param string $value
 	 */
 	public function appendHeader($value, $replace = true)
 	{
@@ -643,6 +646,7 @@ 
 	 * Sends a cookie.
 	 * Do not call this method directly. Operate with the result of {@link getCookies} instead.
 	 * @param THttpCookie cook to be sent
+	 * @param THttpCookie $cookie
 	 */
 	public function addCookie($cookie)
 	{