pradosoft / prado

framework/Web/UI/WebControls/TCaptcha.php

Doc Comments +8 added lines

@@ -270,6 +270,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)
 	{
@@ -325,6 +326,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)
@@ -450,6 +452,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)
@@ -462,6 +469,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

@@ -81,7 +81,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()
@@ -117,6 +117,9 @@ 
 		return $options;
 	}
 
+	/**
+	 * @param string $token
+	 */
 	private function generateTokenHash($token)
 	{
 		for($h = 0,$i = strlen($token) - 1;$i >= 0;--$i)

framework/Web/UI/WebControls/TCheckBoxList.php

Doc Comments +5 added lines, -5 removed lines

@@ -60,7 +60,7 @@ 
 
 	/**
 	 * Creates a control used for repetition (used as a template).
-	 * @return TControl the control to be repeated
+	 * @return TCheckBoxItem the control to be repeated
 	 */
 	protected function createRepeatedControl()
 	{
@@ -72,7 +72,7 @@ 
 	 * This method overrides the parent implementation so that it always returns
 	 * the checkbox list itself (because the checkbox list does not have child controls.)
 	 * @param string control ID
-	 * @return TControl control being found
+	 * @return \Prado\Web\UI\TControl|null control being found
 	 */
 	public function findControl($id, $real = false)
 	{
@@ -146,7 +146,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()
 	{
@@ -162,7 +162,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()
 	{
@@ -441,7 +441,7 @@ 
 	/**
 	 * Returns the value to be validated.
 	 * This methid is required by \Prado\Web\UI\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/TDataGrid.php

Doc Comments +21 added lines

@@ -519,6 +519,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)
 	{
@@ -747,6 +748,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)
 	{
@@ -758,6 +760,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)
 	{
@@ -769,6 +772,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)
 	{
@@ -779,6 +783,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)
 	{
@@ -790,6 +795,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)
 	{
@@ -801,6 +807,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)
 	{
@@ -812,6 +819,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)
 	{
@@ -823,6 +831,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)
 	{
@@ -834,6 +843,7 @@ 
 	 * This method is invoked for each datagrid item after it performs
 	 * databinding.
 	 * @param TDataGridItemEventParameter event parameter
+	 * @param TDataGridItemEventParameter $param
 	 */
 	public function onItemDataBound($param)
 	{
@@ -844,6 +854,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)
 	{
@@ -1140,6 +1151,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);
@@ -1165,6 +1181,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)
 	{
@@ -1197,6 +1214,7 @@ 
 	/**
 	 * Builds the pager content based on pager style.
 	 * @param TDataGridPager the container for the pager
+	 * @param TDataGridPager $pager
 	 */
 	protected function buildPager($pager)
 	{
@@ -1222,6 +1240,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)

framework/Web/UI/WebControls/TDataGridColumn.php

Doc Comments +4 added lines

@@ -287,6 +287,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)
@@ -301,6 +302,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)
 	{
@@ -362,6 +364,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.
 	 */
@@ -521,6 +524,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)

framework/Web/UI/WebControls/TFileUploadItem.php

Doc Comments +3 added lines

@@ -91,6 +91,7 @@ 
 
   /**
    * @param string the local name of the file (where it is after being uploaded).
+   * @param string $value
    */
   public function setLocalName($value)
   {
@@ -110,6 +111,7 @@ 
   /**
    * Sets the error code describing the status of this file uploading.
    * @param integer the error code
+   * @param integer $value
    * @see http://www.php.net/manual/en/features.file-upload.errors.php
    */
   public function setErrorCode($value)
@@ -130,6 +132,7 @@ 
    * @param string the file name used to save the uploaded file
    * @param boolean whether to delete the temporary file after saving.
    * If true, you will not be able to save the uploaded file again.
+   * @param string $fileName
    * @return boolean true if the file saving is successful
    */
   public function saveAs($fileName, $deleteTempFile = true)

framework/Web/UI/WebControls/THotSpot.php

Doc Comments +2 added lines

@@ -36,6 +36,7 @@ 
 	 * that must be kept in viewstate.
 	 * @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)
@@ -52,6 +53,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)
 	{

framework/Web/UI/WebControls/TTabView.php

Doc Comments +1 added lines, -1 removed lines

@@ -40,7 +40,7 @@
 	private $_active = false;
 
 	/**
-	 * @return the tag name for the view element
+	 * @return string tag name for the view element
 	 */
 	protected function getTagName()
 	{