pradosoft / prado

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)

framework/Web/UI/WebControls/TCheckBox.php

Doc Comments +6 added lines, -1 removed lines

@@ -117,7 +117,7 @@ 
 
 	/**
 	 * Returns the value of the property that needs validation.
-	 * @return mixed the property value to be validated
+	 * @return boolean the property value to be validated
 	 */
 	public function getValidationPropertyValue()
 	{
@@ -184,6 +184,7 @@ 
 
 	/**
 	 * @param TTextAlign the alignment of the text caption. Valid values include Left and Right.
+	 * @param TTextAlign $value
 	 */
 	public function setTextAlign($value)
 	{
@@ -244,6 +245,7 @@ 
 	/**
 	 * Sets a value indicating whether clicking on the checkbox will post the page.
 	 * @param boolean whether clicking on the checkbox will post the page.
+	 * @param boolean $value
 	 */
 	public function setAutoPostBack($value)
 	{
@@ -261,6 +263,7 @@ 
 	/**
 	 * Sets the value indicating whether postback event trigger by this checkbox will cause input validation.
 	 * @param boolean whether postback event trigger by this checkbox will cause input validation.
+	 * @param boolean $value
 	 */
 	public function setCausesValidation($value)
 	{
@@ -277,6 +280,7 @@ 
 
 	/**
 	 * @param string the group of validators which the checkbox causes validation upon postback
+	 * @param string $value
 	 */
 	public function setValidationGroup($value)
 	{
@@ -410,6 +414,7 @@ 
 
 	/**
 	 * @param boolean whether to render javascript.
+	 * @param boolean $value
 	 */
 	public function setEnableClientScript($value)
 	{

framework/Web/UI/WebControls/TCheckBoxList.php

Doc Comments +3 added lines, -3 removed lines

@@ -154,7 +154,7 @@ 
 	}
 
 	/**
-	 * @return string the direction of traversing the list, defaults to 'Vertical'
+	 * @return TRepeatDirection the direction of traversing the list, defaults to 'Vertical'
 	 */
 	public function getRepeatDirection()
 	{
@@ -170,7 +170,7 @@ 
 	}
 
 	/**
-	 * @return string how the list should be displayed, using table or using line breaks. Defaults to 'Table'.
+	 * @return TRepeatLayout how the list should be displayed, using table or using line breaks. Defaults to 'Table'.
 	 */
 	public function getRepeatLayout()
 	{
@@ -449,7 +449,7 @@ 
 	/**
 	 * Returns the value to be validated.
 	 * This methid is required by IValidatable interface.
-	 * @return mixed the value of the property to be validated.
+	 * @return string the value of the property to be validated.
 	 */
 	public function getValidationPropertyValue()
 	{

framework/Web/UI/WebControls/TCompareValidator.php

Doc Comments +2 added lines

@@ -186,6 +186,8 @@
 	 * Parse the pair of values into the appropriate value type.
 	 * @param string value one
 	 * @param string second value
+	 * @param string $value1
+	 * @param string $value2
 	 * @return array appropriate type of the value pair, array($value1, $value2);
 	 */
 	protected function getComparisonValues($value1, $value2)

framework/Web/UI/WebControls/TCustomValidator.php

Doc Comments +1 added lines

@@ -171,6 +171,7 @@
 	 * Constructor.
 	 * @param string property value to be validated
 	 * @param boolean whether the value is valid
+	 * @param boolean $isValid
 	 */
 	public function __construct($value,$isValid)
 	{

framework/Web/UI/WebControls/TDataBoundControl.php

Doc Comments +8 added lines

@@ -151,6 +151,7 @@ 
 
 	/**
 	 * @param boolean if databind has been invoked in this page request
+	 * @param boolean $value
 	 */
 	protected function setIsDataBound($value)
 	{
@@ -211,6 +212,7 @@ 
 
 	/**
 	 * @param integer the zero-based index of the current page
+	 * @param integer $value
 	 * @throws TInvalidDataValueException if the value is less than 0
 	 */
 	public function setCurrentPageIndex($value)
@@ -273,6 +275,7 @@ 
 	 * If true and the control has been prerendered while it uses the data source
 	 * specified by {@link setDataSourceID}, a databind call will be called by this method.
 	 * @param boolean whether a databind call is required.
+	 * @param boolean $value
 	 */
 	protected function setRequiresDataBinding($value)
 	{
@@ -405,6 +408,9 @@ 
 		return $this->_currentDataSource;
 	}
 
+	/**
+	 * @param Traversable $data
+	 */
 	abstract protected function performDataBinding($data);
 
 	/**
@@ -566,6 +572,7 @@ 
 	 * Sets the zero-based index for the item.
 	 * If the item is not in the item collection (e.g. it is a header item), -1 should be used.
 	 * @param integer zero-based index of the item.
+	 * @return void
 	 */
 	public function setItemIndex($value);
 
@@ -576,6 +583,7 @@ 
 
 	/**
 	 * @param TListItemType the item type.
+	 * @return void
 	 */
 	public function setItemType($value);
 }

framework/Web/UI/WebControls/TDataGrid.php

Doc Comments +24 added lines, -1 removed lines

@@ -534,6 +534,7 @@ 
 	 * If the item to be selected is already in edit mode, it will remain in edit mode.
 	 * If the index is less than 0, any existing selection will be cleared up.
 	 * @param integer the selected item index
+	 * @param integer $value
 	 */
 	public function setSelectedItemIndex($value)
 	{
@@ -762,6 +763,7 @@ 
 	 * This method is invoked when a button control raises <b>OnCommand</b> event
 	 * with <b>cancel</b> command name.
 	 * @param TDataGridCommandEventParameter event parameter
+	 * @param TDataGridCommandEventParameter $param
 	 */
 	public function onCancelCommand($param)
 	{
@@ -773,6 +775,7 @@ 
 	 * This method is invoked when a button control raises <b>OnCommand</b> event
 	 * with <b>delete</b> command name.
 	 * @param TDataGridCommandEventParameter event parameter
+	 * @param TDataGridCommandEventParameter $param
 	 */
 	public function onDeleteCommand($param)
 	{
@@ -784,6 +787,7 @@ 
 	 * This method is invoked when a button control raises <b>OnCommand</b> event
 	 * with <b>edit</b> command name.
 	 * @param TDataGridCommandEventParameter event parameter
+	 * @param TDataGridCommandEventParameter $param
 	 */
 	public function onEditCommand($param)
 	{
@@ -794,6 +798,7 @@ 
 	 * Raises <b>OnItemCommand</b> event.
 	 * This method is invoked when a button control raises <b>OnCommand</b> event.
 	 * @param TDataGridCommandEventParameter event parameter
+	 * @param TDataGridCommandEventParameter $param
 	 */
 	public function onItemCommand($param)
 	{
@@ -805,6 +810,7 @@ 
 	 * This method is invoked when a button control raises <b>OnCommand</b> event
 	 * with <b>sort</b> command name.
 	 * @param TDataGridSortCommandEventParameter event parameter
+	 * @param TDataGridSortCommandEventParameter $param
 	 */
 	public function onSortCommand($param)
 	{
@@ -816,6 +822,7 @@ 
 	 * This method is invoked when a button control raises <b>OnCommand</b> event
 	 * with <b>update</b> command name.
 	 * @param TDataGridCommandEventParameter event parameter
+	 * @param TDataGridCommandEventParameter $param
 	 */
 	public function onUpdateCommand($param)
 	{
@@ -827,6 +834,7 @@ 
 	 * This method is invoked right after a datagrid item is created and before
 	 * added to page hierarchy.
 	 * @param TDataGridItemEventParameter event parameter
+	 * @param TDataGridItemEventParameter $param
 	 */
 	public function onItemCreated($param)
 	{
@@ -838,6 +846,7 @@ 
 	 * This method is invoked right after a datagrid pager is created and before
 	 * added to page hierarchy.
 	 * @param TDataGridPagerEventParameter event parameter
+	 * @param TDataGridPagerEventParameter $param
 	 */
 	public function onPagerCreated($param)
 	{
@@ -849,6 +858,7 @@ 
 	 * This method is invoked for each datagrid item after it performs
 	 * databinding.
 	 * @param TDataGridItemEventParameter event parameter
+	 * @param TDataGridItemEventParameter $param
 	 */
 	public function onItemDataBound($param)
 	{
@@ -859,6 +869,7 @@ 
 	 * Raises <b>OnPageIndexChanged</b> event.
 	 * This method is invoked when current page is changed.
 	 * @param TDataGridPageChangedEventParameter event parameter
+	 * @param TDataGridPageChangedEventParameter $param
 	 */
 	public function onPageIndexChanged($param)
 	{
@@ -1155,6 +1166,11 @@ 
 		return new TDataGridItem($itemIndex,$dataSourceIndex,$itemType);
 	}
 
+	/**
+	 * @param integer $itemIndex
+	 * @param boolean $dataBind
+	 * @param TList $columns
+	 */
 	private function createItemInternal($itemIndex,$dataSourceIndex,$itemType,$dataBind,$dataItem,$columns)
 	{
 		$item=$this->createItem($itemIndex,$dataSourceIndex,$itemType);
@@ -1180,6 +1196,7 @@ 
 	 * Initializes a datagrid item and cells inside it
 	 * @param TDataGrid datagrid item to be initialized
 	 * @param TDataGridColumnCollection datagrid columns to be used to initialize the cells in the item
+	 * @param TDataGridItem $item
 	 */
 	protected function initializeItem($item,$columns)
 	{
@@ -1212,6 +1229,7 @@ 
 	/**
 	 * Builds the pager content based on pager style.
 	 * @param TDataGridPager the container for the pager
+	 * @param TDataGridPager $pager
 	 */
 	protected function buildPager($pager)
 	{
@@ -1237,6 +1255,9 @@ 
 	 * @param string caption of the button
 	 * @param string CommandName corresponding to the OnCommand event of the button
 	 * @param string CommandParameter corresponding to the OnCommand event of the button
+	 * @param TDataGridPagerButtonType $buttonType
+	 * @param boolean $enabled
+	 * @param string $commandName
 	 * @return mixed the button instance
 	 */
 	protected function createPagerButton($pager,$buttonType,$enabled,$text,$commandName,$commandParameter)
@@ -1881,6 +1902,7 @@ 
 	 * Constructor.
 	 * @param TControl the control originally raises the <b>OnCommand</b> event.
 	 * @param integer new page index
+	 * @param integer $newPageIndex
 	 */
 	public function __construct($source,$newPageIndex)
 	{
@@ -1957,7 +1979,7 @@ 
 	}
 
 	/**
-	 * @return TListItemType item type.
+	 * @return string item type.
 	 */
 	public function getItemType()
 	{
@@ -2062,6 +2084,7 @@ 
 	/**
 	 * Constructor.
 	 * @param TDataGrid datagrid object
+	 * @param TDataGrid $dataGrid
 	 */
 	public function __construct($dataGrid)
 	{

framework/Web/UI/WebControls/TDataGridColumn.php

Doc Comments +4 added lines

@@ -281,6 +281,7 @@ 
 	 *
 	 * @param string the name of the viewstate value to be returned
 	 * @param mixed the default value. If $key is not found in viewstate, $defaultValue will be returned
+	 * @param string $key
 	 * @return mixed the viewstate value corresponding to $key
 	 */
 	protected function getViewState($key,$defaultValue=null)
@@ -295,6 +296,7 @@ 
 	 * @param string the name of the viewstate value
 	 * @param mixed the viewstate value to be set
 	 * @param mixed default value. If $value===$defaultValue, the item will be cleared from the viewstate.
+	 * @param string $key
 	 */
 	protected function setViewState($key,$value,$defaultValue=null)
 	{
@@ -356,6 +358,7 @@ 
 	 * If the data is a component, the field is used as the name of a property.
 	 * @param mixed data containing the field of value
 	 * @param string the data field
+	 * @param string $field
 	 * @return mixed data value at the specified field
 	 * @throws TInvalidDataValueException if the data or the field is invalid.
 	 */
@@ -515,6 +518,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)