pradosoft / prado

framework/Web/UI/WebControls/TButton.php

Doc Comments +1 added lines, -1 removed lines

@@ -243,7 +243,7 @@
 	 * invoke the page's {@link TPage::validate validate} method first.
 	 * It will raise {@link onClick OnClick} and {@link onCommand OnCommand} events.
 	 * This method is mainly used by framework and control developers.
-	 * @param TEventParameter $param the event parameter
+	 * @param \Prado\Web\UI\ActiveControls\TCallbackEventParameter $param the event parameter
 	 */
 	public function raisePostBackEvent($param)
 	{

framework/Web/UI/WebControls/TCaptcha.php

Doc Comments +1 added lines, -1 removed lines

@@ -449,7 +449,7 @@
 	 * Generates the token.
 	 * @param string $publicKey public key
 	 * @param string $privateKey private key
-	 * @param mixed $alphabet
+	 * @param string $alphabet
 	 * @param int $tokenLength the length of the token
 	 * @param bool $caseSensitive whether the token is case sensitive
 	 * @return string the token generated.

framework/Web/UI/WebControls/TCheckBox.php

Doc Comments +1 added lines, -1 removed lines

@@ -125,7 +125,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()
 	{

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()
 	{
@@ -73,7 +73,7 @@ 
 	 * the checkbox list itself (because the checkbox list does not have child controls.)
 	 * @param string $id control ID
 	 * @param mixed $real
-	 * @return TControl control being found
+	 * @return null|\Prado\Web\UI\TControl control being found
 	 */
 	public function findControl($id, $real = false)
 	{
@@ -147,7 +147,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()
 	{
@@ -163,7 +163,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()
 	{
@@ -436,7 +436,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/TDataBoundControl.php

Doc Comments +3 added lines

@@ -411,6 +411,9 @@
 		return $this->_currentDataSource;
 	}
 
+	/**
+	 * @param \Traversable $data
+	 */
 	abstract protected function performDataBinding($data);
 
 	/**

framework/Web/UI/WebControls/TDataGrid.php

Doc Comments +6 added lines, -1 removed lines

@@ -1119,6 +1119,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);
@@ -1192,7 +1197,7 @@ 
 	 * Depending on the button type, a TLinkButton or a TButton may be created.
 	 * If it is enabled (clickable), its command name and parameter will also be set.
 	 * Derived classes may override this method to create additional types of buttons, such as TImageButton.
-	 * @param mixed $pager the container pager instance of TActiveDatagridPager
+	 * @param TDataGridPager $pager the container pager instance of TActiveDatagridPager
 	 * @param string $buttonType button type, either LinkButton or PushButton
 	 * @param bool $enabled whether the button should be enabled
 	 * @param string $text caption of the button

framework/Web/UI/WebControls/TDataList.php

Doc Comments +6 added lines, -3 removed lines

@@ -1131,7 +1131,7 @@ 
 	 * This method invokes {@link createItem} to create a new datalist item.
 	 * @param int $itemIndex zero-based item index.
 	 * @param TListItemType $itemType item type
-	 * @return TControl the created item, null if item is not created
+	 * @return \Prado\TComponent|null the created item, null if item is not created
 	 */
 	private function createItemInternal($itemIndex, $itemType)
 	{
@@ -1151,7 +1151,7 @@ 
 	 * @param int $itemIndex zero-based item index.
 	 * @param TListItemType $itemType item type
 	 * @param mixed $dataItem data to be associated with the item
-	 * @return TControl the created item, null if item is not created
+	 * @return \Prado\TComponent|null the created item, null if item is not created
 	 */
 	private function createItemWithDataInternal($itemIndex, $itemType, $dataItem)
 	{
@@ -1192,6 +1192,9 @@ 
 		}
 	}
 
+	/**
+	 * @param integer $itemIndex
+	 */
 	private function getEditItemDisplay($itemIndex)
 	{
 		if (($classPath = $this->getEditItemRenderer()) === '' && $this->_editItemTemplate === null) {
@@ -1205,7 +1208,7 @@ 
 	 * Creates a datalist item instance based on the item type and index.
 	 * @param int $itemIndex zero-based item index
 	 * @param TListItemType $itemType item type
-	 * @return TControl created datalist item
+	 * @return null|\Prado\TComponent created datalist item
 	 */
 	protected function createItem($itemIndex, $itemType)
 	{

framework/Web/UI/WebControls/TDatePicker.php

Doc Comments +4 added lines, -4 removed lines

@@ -483,7 +483,7 @@ 
 	 * Loads date from drop down list data.
 	 * @param string $key the key that can be used to retrieve data from the input data collection
 	 * @param array $values the input data collection
-	 * @return array the date selected
+	 * @return string the date selected
 	 */
 	protected function getDateFromPostData($key, $values)
 	{
@@ -595,7 +595,7 @@ 
 	}
 
 	/**
-	 * @return DateTimeFormatInfo date time format information for the current culture.
+	 * @return \Prado\I18N\core\DateTimeFormatInfo date time format information for the current culture.
 	 */
 	protected function getLocalizedCalendarInfo()
 	{
@@ -647,7 +647,7 @@ 
 	/**
 	 * Renders the calendar drop down list depending on the DateFormat pattern.
 	 * @param THtmlWriter $writer the Html writer to render the drop down lists.
-	 * @param array $date the current selected date
+	 * @param \DateTime $date the current selected date
 	 */
 	protected function renderCalendarSelections($writer, $date)
 	{
@@ -755,7 +755,7 @@ 
 	 * Returns the localized month names that depends on the month format pattern.
 	 * "MMMM" will return the month names, "MM" or "MMM" return abbr. month names
 	 * and "M" return month digits.
-	 * @param DateTimeFormatInfo $info localized date format information.
+	 * @param \Prado\I18N\core\DateTimeFormatInfo $info localized date format information.
 	 * @return array localized month names.
 	 */
 	protected function getLocalizedMonthNames($info)

framework/Web/UI/WebControls/THtmlArea.php

Doc Comments +5 added lines, -2 removed lines

@@ -385,6 +385,9 @@ 
 		return $url;
 	}
 
+	/**
+	 * @param string $url
+	 */
 	protected function copyCustomPlugins($url)
 	{
 		if ($plugins = $this->getCustomPluginPath()) {
@@ -429,7 +432,7 @@ 
 
 	/**
 	 * Parse additional options set in the Options property.
-	 * @param mixed $string
+	 * @param string $string
 	 * @return array additional custom options
 	 */
 	protected function parseEditorOptions($string)
@@ -453,7 +456,7 @@ 
 	}
 
 	/**
-	 * @param mixed $culture
+	 * @param string $culture
 	 * @return string localized editor interface language extension.
 	 */
 	protected function getLanguageSuffix($culture)