pradosoft / prado

framework/Web/UI/TTemplateManager.php

Doc Comments +11 added lines

@@ -69,6 +69,7 @@ 
 
 	/**
 	 * Loads the template from the specified file.
+	 * @param string $fileName
 	 * @return ITemplate template parsed from the specified file, null if the file doesn't exist.
 	 */
 	public function getTemplateByFileName($fileName)
@@ -415,6 +416,7 @@ 
 	 * @param TControl control to be configured
 	 * @param string property name
 	 * @param mixed property initial value
+	 * @param TControl $control
 	 */
 	protected function configureControl($control,$name,$value)
 	{
@@ -431,6 +433,7 @@ 
 	 * @param TComponent component to be configured
 	 * @param string property name
 	 * @param mixed property initial value
+	 * @param TComponent $component
 	 */
 	protected function configureComponent($component,$name,$value)
 	{
@@ -817,6 +820,8 @@ 
 	/**
 	 * Parses the attributes of a tag from a string.
 	 * @param string the string to be parsed.
+	 * @param string $str
+	 * @param string $offset
 	 * @return array attribute values indexed by names.
 	 */
 	protected function parseAttributes($str,$offset)
@@ -851,6 +856,9 @@ 
 		return $attributes;
 	}
 
+	/**
+	 * @param string $content
+	 */
 	protected function parseTemplateProperty($content,$offset)
 	{
 		$line=$this->_startingLine+count(explode("\n",substr($this->_content,0,$offset)))-1;
@@ -860,6 +868,7 @@ 
 	/**
 	 * Parses a single attribute.
 	 * @param string the string to be parsed.
+	 * @param string $value
 	 * @return array attribute initialization
 	 */
 	protected function parseAttribute($value)
@@ -1002,6 +1011,8 @@ 
 	 * @param Exception template exception
 	 * @param int line number
 	 * @param string template string if no source file is used
+	 * @param Exception $e
+	 * @param integer $line
 	 */
 	protected function handleException($e,$line,$input=null)
 	{

framework/Web/UI/WebControls/assets/captcha.php

Doc Comments +20 added lines

@@ -54,6 +54,9 @@ 
 	return $caseSensitive?$token:strtoupper($token);
 }
 
+/**
+ * @param string $hex
+ */
 function hash2string($hex,$alphabet)
 {
 	if(strlen($alphabet)<2)
@@ -121,6 +124,11 @@ 
 	imagedestroy($image);
 }
 
+/**
+ * @param resource $image
+ * @param double $width
+ * @param double $height
+ */
 function addBackground($image,$width,$height,$opaque,$noisy,$hasGrid,$hasScribble,$morph)
 {
 	$background=imagecreatetruecolor($width*2,$height*2);
@@ -148,6 +156,9 @@ 
 		imagecolortransparent($image,$white);
 }
 
+/**
+ * @param resource $image
+ */
 function addNoise($image,$width,$height)
 {
 	for($x=0;$x<$width;++$x)
@@ -164,6 +175,9 @@ 
 	}
 }
 
+/**
+ * @param resource $image
+ */
 function addGrid($image,$width,$height)
 {
 	for($i=0;$i<$width;$i+=rand(15,25))
@@ -182,6 +196,9 @@ 
 	}
 }
 
+/**
+ * @param resource $image
+ */
 function addScribble($image,$width,$height)
 {
 	for($i=0;$i<8;$i++)
@@ -199,6 +216,9 @@ 
 	}
 }
 
+/**
+ * @param resource $image
+ */
 function morphImage($image,$width,$height)
 {
 	$tempImage=imagecreatetruecolor($width,$height);

framework/Web/UI/WebControls/TAccordion.php

Doc Comments +2 added lines, -1 removed lines

@@ -552,7 +552,7 @@ 
 	private $_active=false;
 
 	/**
-	 * @return the tag name for the view element
+	 * @return string tag name for the view element
 	 */
 	protected function getTagName()
 	{
@@ -725,6 +725,7 @@ 
 	/**
 	 * Finds the index of the accordion view whose ID is the same as the one being looked for.
 	 * @param string the explicit ID of the accordion view to be looked for
+	 * @param string $id
 	 * @return integer the index of the accordion view found, -1 if not found.
 	 */
 	public function findIndexByID($id)

framework/Web/UI/WebControls/TBaseDataList.php

Doc Comments +1 added lines

@@ -166,6 +166,7 @@
 	 * Otherwise, an exception will be raised.
 	 * @param mixed data item
 	 * @param mixed field name
+	 * @param string $field
 	 * @return mixed data value at the specified field
 	 * @throws TInvalidDataValueException if the data is invalid
 	 */

framework/Web/UI/WebControls/TBaseValidator.php

Doc Comments +5 added lines, -2 removed lines

@@ -182,6 +182,7 @@ 
 	 * TBaseValidator::$_clientClass, be sure to update the corresponding
 	 * "Javascript/validation3.js" file as well.
 	 * @param TControl control to validate.
+	 * @param TControl $control
 	 * @return string control type for client-side validation.
 	 */
 	private function getClientControlClass($control)
@@ -259,7 +260,7 @@ 
 	/**
 	 * Update the ControlToValidate component's css class depending
 	 * if the ControlCssClass property is set, and whether this is valid.
-	 * @return boolean true if change, false otherwise.
+	 * @return boolean|null true if change, false otherwise.
 	 */
 	protected function updateControlCssClass()
 	{
@@ -384,6 +385,7 @@ 
 	 * The ID path is the dot-connected IDs of the controls reaching from
 	 * the validator's naming container to the target control.
 	 * @param string the ID path
+	 * @param string $value
 	 */
 	public function setControlToValidate($value)
 	{
@@ -549,6 +551,7 @@ 
 
 	/**
 	 * @param string the css class that is applied to the control being validated in case the validation fails
+	 * @param string $value
 	 */
 	public function setControlCssClass($value)
 	{
@@ -691,7 +694,7 @@ 
 	}
 
 	/**
-	 * @return boolean true to observe changes.
+	 * @return boolean|string true to observe changes.
 	 */
 	public function getObserveChanges()
 	{

framework/Web/UI/WebControls/TBulletedList.php

Doc Comments +2 added lines

@@ -216,6 +216,7 @@ 
 	 * This method is invoked when the {@link getDisplayMode DisplayMode} is 'LinkButton'
 	 * and end-users click on one of the buttons.
 	 * @param TBulletedListEventParameter event parameter.
+	 * @param TBulletedListEventParameter $param
 	 */
 	public function onClick($param)
 	{
@@ -425,6 +426,7 @@ 
 	/**
 	 * Constructor.
 	 * @param integer index of the item clicked
+	 * @param integer $index
 	 */
 	public function __construct($index)
 	{

framework/Web/UI/WebControls/TButton.php

Doc Comments +2 added lines

@@ -218,6 +218,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)
 	{
@@ -342,6 +343,7 @@ 
 
 	/**
 	 * @param string the group of validators which the button causes validation upon postback
+	 * @param string $value
 	 */
 	public function setValidationGroup($value)
 	{

framework/Web/UI/WebControls/TCaptcha.php

Doc Comments +8 added lines

@@ -267,6 +267,7 @@ 
 
 	/**
 	 * @param string the public key used for generating the token. A random one will be generated if this is not set.
+	 * @param string $value
 	 */
 	public function setPublicKey($value)
 	{
@@ -322,6 +323,7 @@ 
 	/**
 	 * Validates a user input with the token.
 	 * @param string user input
+	 * @param string $input
 	 * @return boolean if the user input is not the same as the token.
 	 */
 	public function validate($input)
@@ -447,6 +449,11 @@ 
 	 * @param string private key
 	 * @param integer the length of the token
 	 * @param boolean whether the token is case sensitive
+	 * @param string $publicKey
+	 * @param string $privateKey
+	 * @param string $alphabet
+	 * @param integer $tokenLength
+	 * @param boolean $caseSensitive
 	 * @return string the token generated.
 	 */
 	protected function generateToken($publicKey,$privateKey,$alphabet,$tokenLength,$caseSensitive)
@@ -459,6 +466,7 @@ 
 	 * Converts a hash string into a string with characters consisting of alphanumeric characters.
 	 * @param string the hexadecimal representation of the hash string
 	 * @param string the alphabet used to represent the converted string. If empty, it means '234578adefhijmnrtwyABDEFGHIJLMNQRTWY', which excludes those confusing characters.
+	 * @param string $hex
 	 * @return string the converted string
 	 */
 	protected function hash2string($hex,$alphabet='')

framework/Web/UI/WebControls/TCaptchaValidator.php

Doc Comments +4 added lines, -1 removed lines

@@ -79,7 +79,7 @@ 
 	}
 
 	/**
-	 * @return TCaptchaControl the CAPTCHA control to be validated against
+	 * @return TCaptcha the CAPTCHA control to be validated against
 	 * @throws TConfigurationException if the CAPTCHA cannot be found according to {@link setCaptchaControl CaptchaControl}
 	 */
 	protected function findCaptchaControl()
@@ -115,6 +115,9 @@ 
 		return $options;
 	}
 
+	/**
+	 * @param string $token
+	 */
 	private function generateTokenHash($token)
 	{
 		for($h=0,$i=strlen($token)-1;$i>=0;--$i)