pradosoft / prado

framework/Web/UI/ActiveControls/TActiveTableRowEventParameter.php

Doc Comments +1 added lines

@@ -37,6 +37,7 @@
 
 	/**
 	 * Creates a new TActiveTableRowEventParameter.
+	 * @param \Prado\Web\THttpResponse $response
 	 */
 	public function __construct($response, $parameter, $index = -1)
 	{

framework/Web/UI/ActiveControls/TBaseActiveCallbackControl.php

Doc Comments +2 added lines

@@ -60,6 +60,7 @@ 
 	/**
 	 * Sets the client side options. Can only be set when client side is null.
 	 * @param TCallbackClientSide client side options.
+	 * @param TActiveCustomValidatorClientSide $client
 	 */
 	public function setClientSide($client)
 	{
@@ -226,6 +227,7 @@ 
 	 * {@link getClientSide ClientSide} property.
 	 * @param string client side javascript class name.
 	 * @param array additional callback options.
+	 * @param string $class
 	 */
 	public function registerCallbackClientScript($class, $options = null)
 	{

framework/Web/UI/ActiveControls/TBaseActiveControl.php

Doc Comments +5 added lines, -1 removed lines

@@ -58,6 +58,8 @@ 
 	 * @param string option name.
 	 * @param mixed new value.
 	 * @param mixed default value.
+	 * @param string $name
+	 * @param string|boolean $default
 	 * @return mixed options value.
 	 */
 	protected function setOption($name, $value, $default = null)
@@ -72,6 +74,8 @@ 
 	 * named values for the base active controls.
 	 * @param string option name.
 	 * @param mixed default value.
+	 * @param string $name
+	 * @param string|boolean $default
 	 * @return mixed options value.
 	 */
 	protected function getOption($name, $default = null)
@@ -89,7 +93,7 @@ 
 	}
 
 	/**
-	 * @return TPage the page containing the attached control.
+	 * @return \Prado\Web\UI\TPage the page containing the attached control.
 	 */
 	protected function getPage()
 	{

framework/Web/UI/ActiveControls/TCallbackClientScript.php

Doc Comments +8 added lines

@@ -95,6 +95,7 @@ 
 	 * Executes a client-side statement.
 	 * @param string javascript function name
 	 * @param array list of arguments for the function
+	 * @param string $function
 	 */
 	public function callClientFunction($function, $params = [])
 	{
@@ -155,6 +156,7 @@ 
 	 * @param string selection method
 	 * @param string|int the value or index to select/check.
 	 * @param string selection control type, either 'check' or 'select'
+	 * @param string $type
 	 */
 	public function select($control, $method = 'Value', $value = null, $type = null)
 	{
@@ -424,6 +426,7 @@ 
 	 * @param TControl control element or HTML element id.
 	 * @param string HTML fragement or the control to be rendered.
 	 * @param boolean whether to fully replace the element or just its inner content.
+	 * @param boolean $self
 	 * @see insertAbout
 	 * @see insertBelow
 	 * @see insertBefore
@@ -482,6 +485,7 @@ 
 	 * Similar to to evaluateScript(), but functions declared in the
 	 * inline block will be available to page elements.
 	 * @param THtmlWriter writer for the content.
+	 * @param \Prado\TComponent $content
 	 */
 	public function appendScriptBlock($content)
 	{
@@ -503,6 +507,7 @@ 
 	 * component developers. The render() method is defered to be called in the
 	 * TActivePageAdapter class.
 	 * @param TControl control to be rendered on callback response.
+	 * @param TControl $control
 	 * @return string the boundary for which the rendered content is wrapped.
 	 */
 	private function getRenderedContentBoundary($control)
@@ -515,6 +520,7 @@ 
 
 	/**
 	 * @param THtmlWriter the writer responsible for rendering html content.
+	 * @param THtmlWriter $html
 	 * @return string content boundary.
 	 */
 	private function getResponseContentBoundary($html)
@@ -534,6 +540,7 @@ 
 	 * @param string visual effect function name.
 	 * @param TControl control element or element id
 	 * @param array visual effect key-value pair options.
+	 * @param string $type
 	 */
 	public function visualEffect($type, $element, $options = [])
 	{
@@ -641,6 +648,7 @@ 
 	 * @param string visual effect function name.
 	 * @param TControl control element or element id
 	 * @param array effect options.
+	 * @param string $effect
 	 */
 	public function juiEffect($element, $effect, $options = [])
 	{

framework/Web/UI/JuiControls/TJuiAutoCompleteEventParameter.php

Doc Comments +1 added lines

@@ -30,6 +30,7 @@
 
 	/**
 	 * Creates a new TCallbackEventParameter.
+	 * @param \Prado\Web\THttpResponse $response
 	 */
 	public function __construct($response, $parameter, $index = -1)
 	{

framework/Web/UI/TClientScriptManager.php

Doc Comments +10 added lines, -1 removed lines

@@ -154,6 +154,7 @@ 
 	 * Registers Prado javascript by library name. See "Web/Javascripts/packages.php"
 	 * for library names.
 	 * @param string script library name.
+	 * @param string $name
 	 */
 	public function registerPradoScript($name)
 	{
@@ -267,7 +268,7 @@ 
 
 	/**
 	 * @param string javascript or css package path.
-	 * @return array tuple($path,$url).
+	 * @return string[] tuple($path,$url).
 	 */
 	protected function getPackagePathUrl($base)
 	{
@@ -359,6 +360,7 @@ 
 	 * the javascript code registration.
 	 * @param string javascript class responsible for the control being registered for postback
 	 * @param array postback options
+	 * @param string $class
 	 */
 	public function registerPostBackControl($class, $options)
 	{
@@ -438,6 +440,7 @@ 
 	 * Registers Prado style by library name. See "Web/Javascripts/packages.php"
 	 * for library names.
 	 * @param string style library name.
+	 * @param string $name
 	 */
 	public function registerPradoStyle($name)
 	{
@@ -618,6 +621,7 @@ 
 	 * Registers a javascript script block at the beginning of the form
 	 * @param string a unique key identifying the script block
 	 * @param string javascript block
+	 * @param string $key
 	 */
 	public function registerBeginScript($key, $script)
 	{
@@ -646,6 +650,7 @@ 
 	 * @param string a unique key identifying the hidden field
 	 * @param string|array hidden field value, if the value is an array, every element
 	 * in the array will be rendered as a hidden field value.
+	 * @param string $name
 	 */
 	public function registerHiddenField($name, $value)
 	{
@@ -657,6 +662,7 @@ 
 
 	/**
 	 * @param string a unique key
+	 * @param string $key
 	 * @return boolean whether there is a CSS file registered with the specified key
 	 */
 	public function isStyleSheetFileRegistered($key)
@@ -693,6 +699,7 @@ 
 
 	/**
 	 * @param string a unique key
+	 * @param string $key
 	 * @return boolean whether there is a javascript file registered with the specified key
 	 */
 	public function isScriptFileRegistered($key)
@@ -873,6 +880,7 @@ 
 	 * Flushes all pending script registrations
 	 * @param THtmlWriter writer for the rendering purpose
 	 * @param TControl the control forcing the flush (used only in error messages)
+	 * @param WebControls\TClientScript $control
 	 */
 	public function flushScriptFiles($writer, $control = null)
 	{
@@ -889,6 +897,7 @@ 
 	 * Unfortunately this attribute is invalid for hidden fields, so text fields are
 	 * rendered instead (#642).
 	 * @param THtmlWriter writer for the rendering purpose
+	 * @param boolean $initial
 	 */
 
 	protected function renderHiddenFieldsInt($writer, $initial)

framework/Web/UI/TControl.php

Doc Comments +24 added lines, -2 removed lines

@@ -213,7 +213,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) {
@@ -290,6 +290,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)
 	{
@@ -571,6 +572,7 @@ 
 
 	/**
 	 * @param boolean whether the control is visible
+	 * @param boolean $value
 	 */
 	public function setVisible($value)
 	{
@@ -638,6 +640,7 @@ 
 	}
 
 	/**
+	 * @param string $name
 	 * @return boolean whether the named attribute exists
 	 */
 	public function hasAttribute($name)
@@ -649,6 +652,7 @@ 
 	}
 
 	/**
+	 * @param string $name
 	 * @return string attribute value, null if attribute does not exist
 	 */
 	public function getAttribute($name)
@@ -663,6 +667,7 @@ 
 	 * Sets a custom control attribute.
 	 * @param string attribute name
 	 * @param string value of the attribute
+	 * @param string $name
 	 */
 	public function setAttribute($name, $value)
 	{
@@ -700,6 +705,7 @@ 
 
 	/**
 	 * @param boolean set whether to enable viewstate
+	 * @param boolean $value
 	 */
 	public function setEnableViewState($value)
 	{
@@ -716,6 +722,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)
@@ -732,6 +740,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)
 	{
@@ -755,6 +765,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)
 	{
@@ -768,6 +779,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
 	 */
 	public function getViewState($key, $defaultValue = null)
@@ -793,6 +805,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)
 	{
@@ -814,6 +827,7 @@ 
 	/**
 	 * Clears a viewstate value.
 	 * @param string the name of the viewstate value to be cleared
+	 * @param string $key
 	 */
 	public function clearViewState($key)
 	{
@@ -919,6 +933,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)
 	{
@@ -1009,6 +1024,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)
@@ -1069,7 +1085,7 @@ 
 	 * A registered object can be accessed like a public member variable.
 	 * This method should only be used by framework and control developers.
 	 * @param string name of the object
-	 * @param object object to be declared
+	 * @param object WebControls\TCheckBox to be declared
 	 * @see __get
 	 */
 	public function registerObject($name, $object)
@@ -1143,6 +1159,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)
@@ -1200,6 +1217,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)
 	{
@@ -1245,6 +1263,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)
 	{
@@ -1496,6 +1515,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)
 	{
@@ -1720,6 +1740,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)
 	{
@@ -1757,6 +1778,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)

framework/Web/UI/TPage.php

Doc Comments +11 added lines

@@ -290,6 +290,9 @@ 
 		$this->unloadRecursive();
 	}
 
+	/**
+	 * @param string $enc
+	 */
 	protected static function decodeUTF8($data, $enc)
 	{
 		if(is_array($data))
@@ -460,6 +463,7 @@ 
 	 * Returns a list of registered validators.
 	 * If validation group is specified, only the validators in that group will be returned.
 	 * @param string validation group
+	 * @param string $validationGroup
 	 * @return TList registered validators in the requested group. If the group is null, all validators will be returned.
 	 */
 	public function getValidators($validationGroup = null)
@@ -571,6 +575,7 @@ 
 	 * Applies a skin in the current theme to a control.
 	 * This method should only be used by framework developers.
 	 * @param TControl a control to be applied skin with
+	 * @param TControl $control
 	 */
 	public function applyControlSkin($control)
 	{
@@ -862,6 +867,8 @@ 
 	 * Processes post data.
 	 * @param TMap post data to be processed
 	 * @param boolean whether this method is invoked before {@link onLoad OnLoad}.
+	 * @param TMap $postData
+	 * @param boolean $beforeLoad
 	 */
 	protected function processPostData($postData, $beforeLoad)
 	{
@@ -987,6 +994,7 @@ 
 	/**
 	 * Sets input focus on a control after the page is rendered to users.
 	 * @param TControl|string control to receive focus, or the ID of the element on the page to receive focus
+	 * @param TControl $value
 	 */
 	public function setFocus($value)
 	{
@@ -1072,6 +1080,7 @@ 
 	 * Sets the state to be stored on the client side.
 	 * This method should only be used by framework and control developers.
 	 * @param string the state to be stored on the client side
+	 * @param string $state
 	 */
 	public function setClientState($state)
 	{
@@ -1191,6 +1200,8 @@ 
 	 * referring to the context object (e.g. Page, Page.ClientScript).
 	 * @param string method name of the context object
 	 * @param array list of parameters to be passed to the action method
+	 * @param string $context
+	 * @param string $funcName
 	 */
 	public function registerCachingAction($context, $funcName, $funcParams)
 	{

framework/Web/UI/TTemplate.php

Doc Comments +12 added lines, -1 removed lines

@@ -120,6 +120,7 @@ 
 	 * @param integer the line number that parsing starts from (internal use)
 	 * @param boolean whether this template is a source template, i.e., this template is loaded from
 	 * some external storage rather than from within another template.
+	 * @param string $tplFile
 	 */
 	public function __construct($template, $contextPath, $tplFile = null, $startingLine = 0, $sourceTemplate = true)
 	{
@@ -302,6 +303,7 @@ 
 	 * @param TControl control to be configured
 	 * @param string property name
 	 * @param mixed property initial value
+	 * @param TControl $control
 	 */
 	protected function configureControl($control, $name, $value)
 	{
@@ -318,6 +320,7 @@ 
 	 * @param TComponent component to be configured
 	 * @param string property name
 	 * @param mixed property initial value
+	 * @param TComponent $component
 	 */
 	protected function configureComponent($component, $name, $value)
 	{
@@ -704,6 +707,8 @@ 
 	/**
 	 * Parses the attributes of a tag from a string.
 	 * @param string the string to be parsed.
+	 * @param string $str
+	 * @param string $offset
 	 * @return array attribute values indexed by names.
 	 */
 	protected function parseAttributes($str, $offset)
@@ -738,6 +743,9 @@ 
 		return $attributes;
 	}
 
+	/**
+	 * @param string $content
+	 */
 	protected function parseTemplateProperty($content, $offset)
 	{
 		$line = $this->_startingLine + count(explode("\n", substr($this->_content, 0, $offset))) - 1;
@@ -747,6 +755,7 @@ 
 	/**
 	 * Parses a single attribute.
 	 * @param string the string to be parsed.
+	 * @param string $value
 	 * @return array attribute initialization
 	 */
 	protected function parseAttribute($value)
@@ -890,6 +899,8 @@ 
 	 * @param Exception template exception
 	 * @param int line number
 	 * @param string template string if no source file is used
+	 * @param \Exception $e
+	 * @param integer $line
 	 */
 	protected function handleException($e, $line, $input = null)
 	{
@@ -959,7 +970,7 @@ 
 
 	/**
 	 * Checks if the given method belongs to a previously attached class behavior.
-	 * @param ReflectionClass $class
+	 * @param \ReflectionClass $class
 	 * @param string $method
 	 * @return boolean
 	 */