pradosoft / prado

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/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)

framework/Web/UI/WebControls/THtmlArea4.php

Doc Comments +2 added lines, -2 removed lines

@@ -380,7 +380,7 @@ 
 
 	/**
 	 * Parse additional options set in the Options property.
-	 * @param mixed $string
+	 * @param string $string
 	 * @return array additional custom options
 	 */
 	protected function parseEditorOptions($string)
@@ -404,7 +404,7 @@ 
 	}
 
 	/**
-	 * @param mixed $culture
+	 * @param string $culture
 	 * @return string localized editor interface language extension.
 	 */
 	protected function getLanguageSuffix($culture)

framework/Web/UI/WebControls/TListControl.php

Doc Comments +2 added lines, -2 removed lines

@@ -262,7 +262,7 @@ 
 	/**
 	 * Creates a collection object to hold list items.
 	 * This method may be overriden to create a customized collection.
-	 * @return TListItemCollection the collection object
+	 * @return \Prado\Collections\TListItemCollection the collection object
 	 */
 	protected function createListItemCollection()
 	{
@@ -738,7 +738,7 @@ 
 	 * Raises OnSelectedIndexChanged event when selection is changed.
 	 * This method is invoked when the list control has its selection changed
 	 * by end-users.
-	 * @param TEventParameter $param event parameter
+	 * @param null|integer $param event parameter
 	 */
 	public function onSelectedIndexChanged($param)
 	{

framework/Web/UI/WebControls/TRatingList.php

Doc Comments +2 added lines, -2 removed lines

@@ -197,7 +197,7 @@ 
 	}
 
 	/**
-	 * @param mixed $value
+	 * @param string $value
 	 * @return TRatingListStyle current rating style
 	 */
 	public function setCaption($value)
@@ -214,7 +214,7 @@ 
 	}
 
 	/**
-	 * @return TRatingListStyle current rating style
+	 * @return string current rating style
 	 */
 	public function getRatingStyle()
 	{

framework/Web/UI/WebControls/TReCaptcha2.php

Doc Comments +6 added lines

@@ -356,11 +356,17 @@
 		}
 	}
 
+	/**
+	 * @param \Prado\Web\UI\ActiveControls\TCallbackEventParameter $param
+	 */
 	public function onCallback($param)
 	{
 		$this->raiseEvent('OnCallback', $this, $param);
 	}
 
+	/**
+	 * @param \Prado\Web\UI\ActiveControls\TCallbackEventParameter $param
+	 */
 	public function onCallbackExpired($param)
 	{
 		$this->raiseEvent('OnCallbackExpired', $this, $param);