pradosoft / prado

framework/Security/IUserManager.php

Doc Comments +3 added lines

@@ -37,6 +37,7 @@ 
 	/**
 	 * Returns a user instance according to auth data stored in a cookie.
 	 * @param THttpCookie the cookie storing user authentication information
+	 * @param \Prado\Web\THttpCookie $cookie
 	 * @return TUser the user instance generated based on the cookie auth data, null if the cookie does not have valid auth data.
 	 * @since 3.1.1
 	 */
@@ -44,7 +45,9 @@ 
 	/**
 	 * Saves user auth data into a cookie.
 	 * @param THttpCookie the cookie to receive the user auth data.
+	 * @param \Prado\Web\THttpCookie $cookie
 	 * @since 3.1.1
+	 * @return void
 	 */
 	public function saveUserToCookie($cookie);
 	/**

framework/Security/TAuthManager.php

Doc Comments +2 added lines

@@ -228,6 +228,7 @@ 
 	/**
 	 * Sets the URL that the browser should be redirected to when login succeeds.
 	 * @param string the URL to be redirected to.
+	 * @param string $value
 	 */
 	public function setReturnUrl($value)
 	{
@@ -376,6 +377,7 @@ 
 	/**
 	 * Updates the user data stored in session.
 	 * @param IUser user object
+	 * @param TUser $user
 	 * @throws new TConfigurationException if session module is not loaded.
 	 */
 	public function updateSessionUser($user)

framework/Security/TAuthorizationRule.php

Doc Comments +7 added lines, -1 removed lines

@@ -165,7 +165,7 @@ 
 	}
 
 	/**
-	 * @return array list of IP rules.
+	 * @return string list of IP rules.
 	 * @since 3.1.1
 	 */
 	public function getIPRules()
@@ -223,11 +223,17 @@ 
 		return 0;
 	}
 
+	/**
+	 * @param IUser $user
+	 */
 	private function isUserMatched($user)
 	{
 		return ($this->_everyone || ($this->_guest && $user->getIsGuest()) || ($this->_authenticated && !$user->getIsGuest()) || in_array(strtolower($user->getName()),$this->_users));
 	}
 
+	/**
+	 * @param IUser $user
+	 */
 	private function isRoleMatched($user)
 	{
 		foreach($this->_roles as $role)

framework/Security/TDbUserManager.php

Doc Comments +2 added lines, -1 removed lines

@@ -162,7 +162,8 @@
 	/**
 	 * Creates the DB connection.
 	 * @param string the module ID for TDataSourceConfig
-	 * @return TDbConnection the created DB connection
+	 * @param string $connectionID
+	 * @return \Prado\Data\TDbConnection the created DB connection
 	 * @throws TConfigurationException if module ID is invalid or empty
 	 */
 	protected function createDbConnection($connectionID)

framework/TApplication.php

Doc Comments +9 added lines

@@ -325,6 +325,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
@@ -423,6 +424,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)
@@ -439,6 +441,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)
 	{
@@ -553,6 +556,7 @@ 
 
 	/**
 	 * @param string the directory containing the application configuration file
+	 * @param string $value
 	 */
 	public function setBasePath($value)
 	{
@@ -569,6 +573,7 @@ 
 
 	/**
 	 * @param string the application configuration file (absolute path)
+	 * @param string $value
 	 */
 	public function setConfigurationFile($value)
 	{
@@ -585,6 +590,7 @@ 
 
  	/**
  	 * @param string the application configuration type. 'xml' and 'php' are valid values
+ 	 * @param string $value
 	 */
 	public function setConfigurationType($value)
 	{
@@ -640,6 +646,7 @@ 
 
 	/**
 	 * @param string the directory storing cache data and application-level persistent data. (absolute path)
+	 * @param string $value
 	 */
 	public function setRuntimePath($value)
 	{
@@ -1071,6 +1078,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)
 	{
@@ -1109,6 +1117,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/TApplicationConfiguration.php

Doc Comments +1 added lines

@@ -61,6 +61,7 @@
 	/**
 	 * Parses the application configuration file.
 	 * @param string configuration file name
+	 * @param string $fname
 	 * @throws TConfigurationException if there is any parsing error
 	 */
 	public function loadFromFile($fname)

framework/TComponent.php

Doc Comments +3 added lines, -2 removed lines

@@ -422,7 +422,7 @@ 
 	 * </code>
 	 * to be executed when listen is called.  All attached behaviors are notified through dyListen.
 	 *
-	 * @return numeric the number of global events that were registered to the global event registry
+	 * @return null|integer the number of global events that were registered to the global event registry
 	 */
 	public function listen() {
 		if($this->_listeningenabled)
@@ -456,7 +456,7 @@ 
 	 * </code>
 	 * to be executed when listen is called.  All attached behaviors are notified through dyUnlisten.
 	 *
-	 * @return numeric the number of global events that were unregistered from the global event registry
+	 * @return null|integer the number of global events that were unregistered from the global event registry
 	 */
 	public function unlisten() {
 		if(!$this->_listeningenabled)
@@ -793,6 +793,7 @@ 
 	 * A property is defined if there is a getter or setter method
 	 * defined in the class. Note, property names are case-insensitive.
 	 * @param string the property name
+	 * @param string $name
 	 * @return boolean whether the property is defined
 	 */
 	public function hasProperty($name)

framework/TComponentReflection.php

Doc Comments +6 added lines

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