pradosoft / prado

framework/Web/UI/ActiveControls/TBaseActiveControl.php

Doc Comments +4 added lines, -4 removed lines

@@ -56,7 +56,7 @@ 
 	 * named values for the base active controls.
 	 * @param string $name option name.
 	 * @param mixed $value new value.
-	 * @param mixed $default default value.
+	 * @param string|boolean $default default value.
 	 * @return mixed options value.
 	 */
 	protected function setOption($name, $value, $default = null)
@@ -71,7 +71,7 @@ 
 	 * Gets an option named value. Options are used to store and retrive
 	 * named values for the base active controls.
 	 * @param string $name option name.
-	 * @param mixed $default default value.
+	 * @param string|boolean $default default value.
 	 * @return mixed options value.
 	 */
 	protected function getOption($name, $default = null)
@@ -89,7 +89,7 @@ 
 	}
 
 	/**
-	 * @return TPage the page containing the attached control.
+	 * @return \Prado\Web\UI\TPage the page containing the attached control.
 	 */
 	protected function getPage()
 	{
@@ -125,7 +125,7 @@ 
 	 * Is is true if the control is initilized, and is a callback request and
 	 * the {@link setEnableUpdate EnableUpdate} property is true and
 	 * the page is not loading post data.
-	 * @param mixed $bDontRequireVisibility
+	 * @param boolean $bDontRequireVisibility
 	 * @return bool true if the callback response is allowed update
 	 * client-side contents.
 	 */

framework/Web/UI/ActiveControls/TCallbackClientScript.php

Doc Comments +6 added lines

@@ -185,6 +185,9 @@ 
 		);
 	}
 
+	/**
+	 * @param TControl $control
+	 */
 	private function getSelectionControlType($control)
 	{
 		if (is_string($control)) {
@@ -199,6 +202,9 @@ 
 		return 'select';
 	}
 
+	/**
+	 * @param TControl $control
+	 */
 	private function getSelectionControlIsListType($control)
 	{
 		return $control instanceof TListControl;

framework/Web/UI/ActiveControls/TCallbackEventParameter.php

Doc Comments +1 added lines, -1 removed lines

@@ -73,7 +73,7 @@
 	}
 
 	/**
-	 * @param mixed $value callback response data.
+	 * @param boolean $value callback response data.
 	 */
 	public function setResponseData($value)
 	{

framework/Web/UI/ActiveControls/TInPlaceTextBox.php

Doc Comments +1 added lines, -1 removed lines

@@ -97,7 +97,7 @@
 	/**
 	 * Calls the client-side static method for this control class.
 	 * @param string $func static method name
-	 * @param mixed $value method parmaeter
+	 * @param boolean $value method parmaeter
 	 */
 	protected function callClientFunction($func, $value)
 	{

framework/Web/UI/JuiControls/TJuiAutoComplete.php

Doc Comments +2 added lines, -2 removed lines

@@ -254,7 +254,7 @@ 
 	 * The method raises 'OnSuggest' event. If you override this
 	 * method, be sure to call the parent implementation so that the event
 	 * handler can be invoked.
-	 * @param TCallbackEventParameter $param event parameter to be passed to the event handlers
+	 * @param TJuiAutoCompleteEventParameter $param event parameter to be passed to the event handlers
 	 */
 	public function onSuggest($param)
 	{
@@ -266,7 +266,7 @@ 
 	 * The method raises 'OnSuggestionSelected' event. If you override this
 	 * method, be sure to call the parent implementation so that the event
 	 * handler can be invoked.
-	 * @param TCallbackEventParameter $param event parameter to be passed to the event handlers
+	 * @param TJuiAutoCompleteEventParameter $param event parameter to be passed to the event handlers
 	 */
 	public function onSuggestionSelected($param)
 	{

framework/Web/UI/JuiControls/TJuiControlAdapter.php

Doc Comments +1 added lines, -1 removed lines

@@ -80,7 +80,7 @@
 
 	/**
 	 * Publish the jQuery-ui style Css asset file.
-	 * @param file $file name
+	 * @param string $file name
 	 * @return string Css file url.
 	 */
 	public function publishJuiStyle($file)

framework/Web/UI/JuiControls/TJuiControlOptions.php

Doc Comments +1 added lines, -1 removed lines

@@ -126,7 +126,7 @@
 
 	/**
 	 * Only serialize the options itself, not the corresponding parent control.
-	 * @return mixed array with the names of all variables of that object that should be serialized.
+	 * @return string[] array with the names of all variables of that object that should be serialized.
 	 */
 	public function __sleep()
 	{

framework/Web/UI/TClientScriptManager.php

Doc Comments +20 added lines, -5 removed lines

@@ -221,7 +221,7 @@ 
 	}
 
 	/**
-	 * @param mixed $script
+	 * @param string $script
 	 * @return string Prado javascript library base asset url.
 	 */
 	public function getPradoScriptAssetUrl($script = 'prado')
@@ -236,7 +236,7 @@ 
 	}
 
 	/**
-	 * @param mixed $script
+	 * @param string $script
 	 * @return string Prado javascript library base asset path in local filesystem.
 	 */
 	public function getPradoScriptAssetPath($script = 'prado')
@@ -265,7 +265,7 @@ 
 
 	/**
 	 * @param string $base javascript or css package path.
-	 * @return array tuple($path,$url).
+	 * @return string[] tuple($path,$url).
 	 */
 	protected function getPackagePathUrl($base)
 	{
@@ -446,7 +446,7 @@ 
 
 	/**
 	 * Registers a Prado style library to be loaded.
-	 * @param mixed $name
+	 * @param string $name
 	 */
 	protected function registerPradoStyleInternal($name)
 	{
@@ -784,11 +784,17 @@ 
 		$writer->write(TJavaScript::renderScriptBlocks($this->_headScripts));
 	}
 
+	/**
+	 * @param THtmlWriter $writer
+	 */
 	public function renderScriptFilesBegin($writer)
 	{
 		$this->renderAllPendingScriptFiles($writer);
 	}
 
+	/**
+	 * @param THtmlWriter $writer
+	 */
 	public function renderScriptFilesEnd($writer)
 	{
 		$this->renderAllPendingScriptFiles($writer);
@@ -801,6 +807,9 @@ 
 		$this->_page->registerCachingAction('Page.ClientScript', 'markScriptFileAsRendered', $params);
 	}
 
+	/**
+	 * @param THtmlWriter $writer
+	 */
 	protected function renderScriptFiles($writer, array $scripts)
 	{
 		foreach ($scripts as $script) {
@@ -857,11 +866,17 @@ 
 		$writer->write(TJavaScript::renderScriptBlocksCallback($this->_endScripts));
 	}
 
+	/**
+	 * @param THtmlWriter $writer
+	 */
 	public function renderHiddenFieldsBegin($writer)
 	{
 		$this->renderHiddenFieldsInt($writer, true);
 	}
 
+	/**
+	 * @param THtmlWriter $writer
+	 */
 	public function renderHiddenFieldsEnd($writer)
 	{
 		$this->renderHiddenFieldsInt($writer, false);
@@ -886,7 +901,7 @@ 
 	 * Unfortunately this attribute is invalid for hidden fields, so text fields are
 	 * rendered instead (#642).
 	 * @param THtmlWriter $writer writer for the rendering purpose
-	 * @param mixed $initial
+	 * @param boolean $initial
 	 */
 
 	protected function renderHiddenFieldsInt($writer, $initial)

framework/Web/UI/TControl.php

Doc Comments +9 added lines, -9 removed lines

@@ -214,7 +214,7 @@ 
 	 * the control ID will take the precedence.
 	 *
 	 * @param string $name 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)
@@ -471,7 +471,7 @@ 
 	}
 
 	/**
-	 * @return bool if a skin is applied.
+	 * @return integer if a skin is applied.
 	 */
 	public function getIsSkinApplied()
 	{
@@ -648,7 +648,7 @@ 
 	}
 
 	/**
-	 * @param mixed $name
+	 * @param string $name
 	 * @return bool whether the named attribute exists
 	 */
 	public function hasAttribute($name)
@@ -661,7 +661,7 @@ 
 	}
 
 	/**
-	 * @param mixed $name
+	 * @param string $name
 	 * @return string attribute value, null if attribute does not exist
 	 */
 	public function getAttribute($name)
@@ -698,7 +698,7 @@ 
 	}
 
 	/**
-	 * @param mixed $checkParents
+	 * @param boolean $checkParents
 	 * @return bool whether viewstate is enabled
 	 */
 	public function getEnableViewState($checkParents = false)
@@ -733,7 +733,7 @@ 
 	 * This function is mainly used in defining getter functions for control properties
 	 * that must be kept in controlstate.
 	 * @param string $key the name of the controlstate value to be returned
-	 * @param mixed $defaultValue the default value. If $key is not found in controlstate, $defaultValue will be returned
+	 * @param integer|null $defaultValue the default value. If $key is not found in controlstate, $defaultValue will be returned
 	 * @return mixed the controlstate value corresponding to $key
 	 */
 	protected function getControlState($key, $defaultValue = null)
@@ -749,7 +749,7 @@ 
 	 * Make sure that the controlstate value must be serializable and unserializable.
 	 * @param string $key the name of the controlstate value
 	 * @param mixed $value the controlstate value to be set
-	 * @param null|mixed $defaultValue default value. If $value===$defaultValue, the item will be cleared from controlstate
+	 * @param integer $defaultValue default value. If $value===$defaultValue, the item will be cleared from controlstate
 	 */
 	protected function setControlState($key, $value, $defaultValue = null)
 	{
@@ -1084,7 +1084,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 name of the object
-	 * @param object $object object to be declared
+	 * @param \Prado\TComponent $object object to be declared
 	 * @see __get
 	 */
 	public function registerObject($name, $object)
@@ -1160,7 +1160,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 mixed $name
+	 * @param string $name
 	 * @return mixed the named registered object. Null if object is not found.
 	 */
 	public function getRegisteredObject($name)

Spacing +12 added lines, -12 removed lines

@@ -114,17 +114,17 @@ 
 	 * Indexes for the rare fields.
 	 * In order to save memory, rare fields will only be created if they are needed.
 	 */
-	const RF_CONTROLS = 0;			// child controls
-	const RF_CHILD_STATE = 1;			// child state field
-	const RF_NAMED_CONTROLS = 2;		// list of controls whose namingcontainer is this control
-	const RF_NAMED_CONTROLS_ID = 3;	// counter for automatic id
-	const RF_SKIN_ID = 4;				// skin ID
-	const RF_DATA_BINDINGS = 5;		// data bindings
-	const RF_EVENTS = 6;				// event handlers
-	const RF_CONTROLSTATE = 7;		// controlstate
-	const RF_NAMED_OBJECTS = 8;		// controls declared with ID on template
-	const RF_ADAPTER = 9;				// adapter
-	const RF_AUTO_BINDINGS = 10;		// auto data bindings
+	const RF_CONTROLS = 0; // child controls
+	const RF_CHILD_STATE = 1; // child state field
+	const RF_NAMED_CONTROLS = 2; // list of controls whose namingcontainer is this control
+	const RF_NAMED_CONTROLS_ID = 3; // counter for automatic id
+	const RF_SKIN_ID = 4; // skin ID
+	const RF_DATA_BINDINGS = 5; // data bindings
+	const RF_EVENTS = 6; // event handlers
+	const RF_CONTROLSTATE = 7; // controlstate
+	const RF_NAMED_OBJECTS = 8; // controls declared with ID on template
+	const RF_ADAPTER = 9; // adapter
+	const RF_AUTO_BINDINGS = 10; // auto data bindings
 
 	/**
 	 * @var string control ID
@@ -402,7 +402,7 @@ 
 	public function getUniqueID()
 	{
 		if ($this->_uid === '' || $this->_uid === null) {	// need to build the UniqueID
-			$this->_uid = '';  // set to not-null, so that clearCachedUniqueID() may take action
+			$this->_uid = ''; // set to not-null, so that clearCachedUniqueID() may take action
 			if ($namingContainer = $this->getNamingContainer()) {
 				if ($this->getPage() === $namingContainer) {
 					return ($this->_uid = $this->_id);