pradosoft / prado

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/TApplicationComponent.php

Doc Comments +2 added lines

@@ -92,6 +92,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)
@@ -106,6 +107,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/TComponent.php

Doc Comments +14 added lines, -2 removed lines

@@ -406,7 +406,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)
@@ -440,7 +440,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)
@@ -774,6 +774,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)
@@ -2100,6 +2101,9 @@ 
 		$this->reflect();
 	}
 
+	/**
+	 * @param ReflectionMethod $method
+	 */
 	private function isPropertyMethod($method)
 	{
 		$methodName=$method->getName();
@@ -2108,6 +2112,9 @@ 
 				&& isset($methodName[3]);
 	}
 
+	/**
+	 * @param ReflectionMethod $method
+	 */
 	private function isEventMethod($method)
 	{
 		$methodName=$method->getName();
@@ -2254,11 +2261,14 @@ 
 	/**
 	 * Attaches the behavior object to the component.
 	 * @param CComponent the component that this behavior is to be attached to.
+	 * @param TComponent $component
+	 * @return void
 	 */
 	public function attach($component);
 	/**
 	 * Detaches the behavior object from the component.
 	 * @param CComponent the component that this behavior is to be detached from.
+	 * @return void
 	 */
 	public function detach($component);
 }
@@ -2283,6 +2293,8 @@ 
 	public function getEnabled();
 	/**
 	 * @param boolean whether this behavior is enabled
+	 * @param boolean $value
+	 * @return void
 	 */
 	public function setEnabled($value);
 }

framework/Util/TSimpleDateFormatter.php

Doc Comments +9 added lines

@@ -93,6 +93,7 @@ 
 
 	/**
 	 * @param string formatting charset.
+	 * @param string $charset
 	 */
 	public function setCharset($charset)
 	{
@@ -313,6 +314,7 @@ 
 
 	/**
 	 * Calculate the length of a string, may be consider iconv_strlen?
+	 * @param string $string
 	 */
 	private function length($string)
 	{
@@ -338,6 +340,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)
 	{
@@ -350,6 +355,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/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)

framework/Web/THttpRequest.php

Doc Comments +6 added lines, -1 removed lines

@@ -258,6 +258,7 @@ 
 
 	/**
 	 * Saves the current UrlManager instance to cache.
+	 * @param TUrlManager $manager
 	 * @return boolean true if UrlManager instance was cached, false otherwise.
 	 */
 	protected function cacheUrlManager($manager)
@@ -349,7 +350,7 @@ 
 	}
 
 	/**
-	 * @return THttpRequestUrlFormat the format of URLs. Defaults to THttpRequestUrlFormat::Get.
+	 * @return string the format of URLs. Defaults to THttpRequestUrlFormat::Get.
 	 */
 	public function getUrlFormat()
 	{
@@ -710,6 +711,7 @@ 
 	 * @param array GET parameters, null if not needed
 	 * @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 false.
+	 * @param string $serviceID
 	 * @return string URL
 	 * @see TUrlManager::constructUrl
 	 */
@@ -980,6 +982,7 @@ 
 	/**
 	 * Constructor.
 	 * @param mixed owner of this collection.
+	 * @param THttpResponse $owner
 	 */
 	public function __construct($owner=null)
 	{
@@ -1125,6 +1128,7 @@ 
 
 	/**
 	 * @param integer the time the cookie expires. This is a Unix timestamp so is in number of seconds since the epoch.
+	 * @param integer $value
 	 */
 	public function setExpire($value)
 	{
@@ -1287,6 +1291,7 @@ 
 	 * Constructor.
 	 * Decomposes the specified URI into parts.
 	 * @param string URI to be represented
+	 * @param string $uri
 	 * @throws TInvalidDataValueException if URI is of bad format
 	 */
 	public function __construct($uri)

framework/Web/TUrlMapping.php

Doc Comments +3 added lines, -1 removed lines

@@ -606,6 +606,7 @@ 
 
 	/**
 	 * @param string full regular expression mapping pattern.
+	 * @param string $value
 	 */
 	public function setRegularExpression($value)
 	{
@@ -715,6 +716,7 @@ 
 	 * Uses URL pattern (or full regular expression if available) to
 	 * match the given url path.
 	 * @param THttpRequest the request module
+	 * @param THttpRequest $request
 	 * @return array matched parameters, empty if no matches.
 	 */
 	public function getPatternMatches($request)
@@ -785,7 +787,7 @@ 
 	}
 
 	/**
-	 * @return THttpRequestUrlFormat the format of URLs. Defaults to THttpRequestUrlFormat::Get.
+	 * @return string the format of URLs. Defaults to THttpRequestUrlFormat::Get.
 	 */
 	public function getUrlFormat()
 	{

framework/Web/UI/WebControls/TImageButton.php

Doc Comments +5 added lines

@@ -220,6 +220,7 @@ 
 	 * If you override this method, be sure to call the parent implementation
 	 * so that the event handler can be invoked.
 	 * @param TImageClickEventParameter event parameter to be passed to the event handlers
+	 * @param TImageClickEventParameter $param
 	 */
 	public function onClick($param)
 	{
@@ -232,6 +233,7 @@ 
 	 * If you override this method, be sure to call the parent implementation
 	 * so that the event handlers can be invoked.
 	 * @param TCommandEventParameter event parameter to be passed to the event handlers
+	 * @param TCommandEventParameter $param
 	 */
 	public function onCommand($param)
 	{
@@ -324,6 +326,7 @@ 
 
 	/**
 	 * @param string the group of validators which the button causes validation upon postback
+	 * @param string $value
 	 */
 	public function setValidationGroup($value)
 	{
@@ -396,6 +399,8 @@ 
 	 * Constructor.
 	 * @param integer X coordinate of the clicking point
 	 * @param integer Y coordinate of the clicking point
+	 * @param integer $x
+	 * @param integer $y
 	 */
 	public function __construct($x,$y)
 	{

framework/Web/UI/WebControls/TListControl.php

Doc Comments +10 added lines

@@ -347,6 +347,7 @@ 
 	 * An automatic postback to the server will occur whenever the user
 	 * makes change to the list control and then tabs out of it.
 	 * @param boolean the value indicating if postback automatically
+	 * @param boolean $value
 	 */
 	public function setAutoPostBack($value)
 	{
@@ -379,6 +380,7 @@ 
 
 	/**
 	 * @param string the field of the data source that provides the text content of the list items.
+	 * @param string $value
 	 */
 	public function setDataTextField($value)
 	{
@@ -398,6 +400,7 @@ 
 	 * The format string is used in {@link TDataValueFormatter::format()} to format the Text property value
 	 * of each item in the list control.
 	 * @param string the formatting string used to control how data bound to the list control is displayed.
+	 * @param string $value
 	 * @see TDataValueFormatter::format()
 	 */
 	public function setDataTextFormatString($value)
@@ -415,6 +418,7 @@ 
 
 	/**
 	 * @param string the field of the data source that provides the value of each list item.
+	 * @param string $value
 	 */
 	public function setDataValueField($value)
 	{
@@ -856,6 +860,7 @@ 
 	 * as the first and second parameters in {@link sprintf}.
 	 * @param string format string
 	 * @param mixed the data to be formatted
+	 * @param string $formatString
 	 * @return string the formatted result
 	 */
 	protected function formatDataValue($formatString,$value)
@@ -894,28 +899,33 @@ 
 	/**
 	 * Selects an item based on zero-base index on the client side.
 	 * @param integer the index (zero-based) of the item to be selected
+	 * @return void
 	 */
 	public function setSelectedIndex($index);
 	/**
 	 * Selects a list of item based on zero-base indices on the client side.
 	 * @param array list of index of items to be selected
+	 * @return void
 	 */
 	public function setSelectedIndices($indices);
 
 	/**
 	 * Sets selection by item value on the client side.
 	 * @param string the value of the item to be selected.
+	 * @return void
 	 */
 	public function setSelectedValue($value);
 
 	/**
 	 * Sets selection by a list of item values on the client side.
 	 * @param array list of the selected item values
+	 * @return void
 	 */
 	public function setSelectedValues($values);
 
     /**
      * Clears all existing selections on the client side.
+     * @return void
      */
     public function clearSelection();
 }