pradosoft / prado

framework/Web/UI/TControl.php

Doc Comments +37 added lines, -1 removed lines

@@ -209,7 +209,7 @@ 
 	 * the control ID will take the precedence.
 	 *
 	 * @param string the property name or control ID
-	 * @return bool wether the control or property exists
+	 * @return boolean|null wether the control or property exists
 	 * @see __get
 	 */
 	public function __isset($name) {
@@ -286,6 +286,7 @@ 
 	 * Sets the page for a control.
 	 * Only framework developers should use this method.
 	 * @param TPage the page that contains this control
+	 * @param TPage $page
 	 */
 	public function setPage($page)
 	{
@@ -567,6 +568,7 @@ 
 
 	/**
 	 * @param boolean whether the control is visible
+	 * @param boolean $value
 	 */
 	public function setVisible($value)
 	{
@@ -634,6 +636,7 @@ 
 	}
 
 	/**
+	 * @param string $name
 	 * @return boolean whether the named attribute exists
 	 */
 	public function hasAttribute($name)
@@ -645,6 +648,7 @@ 
 	}
 
 	/**
+	 * @param string $name
 	 * @return string attribute value, null if attribute does not exist
 	 */
 	public function getAttribute($name)
@@ -659,6 +663,7 @@ 
 	 * Sets a custom control attribute.
 	 * @param string attribute name
 	 * @param string value of the attribute
+	 * @param string $name
 	 */
 	public function setAttribute($name,$value)
 	{
@@ -696,6 +701,7 @@ 
 
 	/**
 	 * @param boolean set whether to enable viewstate
+	 * @param boolean $value
 	 */
 	public function setEnableViewState($value)
 	{
@@ -712,6 +718,8 @@ 
 	 * that must be kept in controlstate.
 	 * @param string the name of the controlstate value to be returned
 	 * @param mixed the default value. If $key is not found in controlstate, $defaultValue will be returned
+	 * @param string $key
+	 * @param integer $defaultValue
 	 * @return mixed the controlstate value corresponding to $key
 	 */
 	protected function getControlState($key,$defaultValue=null)
@@ -728,6 +736,8 @@ 
 	 * @param string the name of the controlstate value
 	 * @param mixed the controlstate value to be set
 	 * @param mixed default value. If $value===$defaultValue, the item will be cleared from controlstate
+	 * @param string $key
+	 * @param integer $defaultValue
 	 */
 	protected function setControlState($key,$value,$defaultValue=null)
 	{
@@ -751,6 +761,7 @@ 
 	 * When it is false, data saved via setViewState() will not be persisted.
 	 * By default, it is true, meaning data will be persisted across postbacks.
 	 * @param boolean whether data should be persisted
+	 * @param boolean $enabled
 	 */
 	public function trackViewState($enabled)
 	{
@@ -789,6 +800,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
 	 */
 	public function setViewState($key,$value,$defaultValue=null)
 	{
@@ -813,6 +825,7 @@ 
 	/**
 	 * Clears a viewstate value.
 	 * @param string the name of the viewstate value to be cleared
+	 * @param string $key
 	 */
 	public function clearViewState($key)
 	{
@@ -918,6 +931,7 @@ 
 	 * Sets a value indicating whether child controls are created.
 	 * If false, any existing child controls will be cleared up.
 	 * @param boolean whether child controls are created
+	 * @param boolean $value
 	 */
 	final protected function setChildControlsCreated($value)
 	{
@@ -1008,6 +1022,7 @@ 
 	 * Finds all child and grand-child controls that are of the specified type.
 	 * @param string the class name
 	 * @param boolean whether the type comparison is strict or not. If false, controls of the parent classes of the specified class will also be returned.
+	 * @param string $type
 	 * @return array list of controls found
 	 */
 	public function findControlsByType($type,$strict=true)
@@ -1142,6 +1157,7 @@ 
 	 * A component with explicit ID on a template will be registered to
 	 * the template owner. This method allows you to obtain this component
 	 * with the ID.
+	 * @param string $name
 	 * @return mixed the named registered object. Null if object is not found.
 	 */
 	public function getRegisteredObject($name)
@@ -1199,6 +1215,7 @@ 
 	 * Control lifecycles will be caught up during the addition.
 	 * Only framework developers should use this method.
 	 * @param TControl the new child control
+	 * @param TControl $control
 	 */
 	public function addedControl($control)
 	{
@@ -1244,6 +1261,7 @@ 
 	 * Removes a control from the child collection of the control.
 	 * Only framework developers should use this method.
 	 * @param TControl the child control removed
+	 * @param TControl $control
 	 */
 	public function removedControl($control)
 	{
@@ -1495,6 +1513,7 @@ 
 	 * @param string name of the broadcast event
 	 * @param TControl sender of the event
 	 * @param TBroadcastEventParameter event parameter
+	 * @param TBroadcastEventParameter $param
 	 */
 	private function broadcastEventInternal($name,$sender,$param)
 	{
@@ -1719,6 +1738,7 @@ 
 	 * Clears the cached UniqueID.
 	 * If $recursive=true, all children's cached UniqueID will be cleared as well.
 	 * @param boolean whether the clearing is recursive.
+	 * @param boolean $recursive
 	 */
 	private function clearCachedUniqueID($recursive)
 	{
@@ -1756,6 +1776,7 @@ 
 	 * Updates the list of the controls whose IDs are managed by the specified naming container.
 	 * @param TControl the naming container
 	 * @param TControlCollection list of controls
+	 * @param TControl $container
 	 * @throws TInvalidDataValueException if a control's ID is not unique within its naming container.
 	 */
 	private function fillNameTable($container,$controls)
@@ -1925,6 +1946,7 @@ 
 	 * The implementation of this function should raise appropriate event(s) (e.g. OnClick, OnCommand)
 	 * indicating the component is responsible for the postback event.
 	 * @param string the parameter associated with the postback event
+	 * @return void
 	 */
 	public function raisePostBackEvent($param);
 }
@@ -1953,6 +1975,7 @@ 
 	 * Raises postdata changed event.
 	 * The implementation of this function should raise appropriate event(s) (e.g. OnTextChanged)
 	 * indicating the control data is changed.
+	 * @return void
 	 */
 	public function raisePostDataChangedEvent();
 	/**
@@ -1986,6 +2009,7 @@ 
 	public function getIsValid();
 	/**
 	 * @param boolean whether the validator validates successfully
+	 * @return void
 	 */
 	public function setIsValid($value);
 	/**
@@ -1994,6 +2018,7 @@ 
 	public function getErrorMessage();
 	/**
 	 * @param string error message for the validation
+	 * @return void
 	 */
 	public function setErrorMessage($value);
 }
@@ -2061,6 +2086,7 @@ 
 	/**
 	 * Applies this theme to the specified control.
 	 * @param TControl the control to be applied with this theme
+	 * @return boolean
 	 */
 	public function applySkin($control);
 }
@@ -2082,6 +2108,7 @@ 
 	 * Content in the template will be instantiated as components and text strings
 	 * and passed to the specified parent control.
 	 * @param TControl the parent control
+	 * @return void
 	 */
 	public function instantiateIn($parent);
 }
@@ -2106,6 +2133,8 @@ 
 
 	/**
 	 * @param string caption of the button
+	 * @param string $value
+	 * @return void
 	 */
 	public function setText($value);
 
@@ -2116,6 +2145,7 @@ 
 
 	/**
 	 * @param boolean whether postback event trigger by this button will cause input validation
+	 * @return void
 	 */
 	public function setCausesValidation($value);
 
@@ -2126,6 +2156,7 @@ 
 
 	/**
 	 * @param string the command name associated with the {@link onCommand OnCommand} event.
+	 * @return void
 	 */
 	public function setCommandName($value);
 
@@ -2136,6 +2167,7 @@ 
 
 	/**
 	 * @param string the parameter associated with the {@link onCommand OnCommand} event.
+	 * @return void
 	 */
 	public function setCommandParameter($value);
 
@@ -2146,23 +2178,27 @@ 
 
 	/**
 	 * @param string the group of validators which the button causes validation upon postback
+	 * @return void
 	 */
 	public function setValidationGroup($value);
 
 	/**
 	 * Raises <b>OnClick</b> event.
 	 * @param TEventParameter event parameter to be passed to the event handlers
+	 * @return void
 	 */
 	public function onClick($param);
 
 	/**
 	 * Raises <b>OnCommand</b> event.
 	 * @param TCommandEventParameter event parameter to be passed to the event handlers
+	 * @return void
 	 */
 	public function onCommand($param);
 
 	/**
 	 * @param boolean set by a panel to register this button as the default button for the panel.
+	 * @return void
 	 */
 	public function setIsDefaultButton($value);