pradosoft / prado

framework/Web/UI/TClientScriptManager.php

Doc Comments +6 added lines

@@ -215,6 +215,7 @@ 
 
 	/**
 	 * @param string javascript package path.
+	 * @param string $base
 	 * @return array tuple($path,$url).
 	 */
 	protected function getPackagePathUrl($base)
@@ -496,6 +497,8 @@ 
 	 * @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
+	 * @param string $value
 	 */
 	public function registerHiddenField($name,$value)
 	{
@@ -735,6 +738,7 @@ 
 
 	/**
 	 * @param THtmlWriter writer for the rendering purpose
+	 * @param boolean $initial
 	 */
 	protected function renderHiddenFieldsInt($writer, $initial)
  	{
@@ -799,6 +803,7 @@ 
 	 * javascript statements.
 	 * @param string option name
 	 * @param string javascript statements.
+	 * @param string $name
 	 */
 	protected function setFunction($name, $code)
 	{
@@ -808,6 +813,7 @@ 
 	}
 
 	/**
+	 * @param string $name
 	 * @return string gets a particular option, null if not set.
 	 */
 	protected function getOption($name)

framework/Web/UI/TPage.php

Doc Comments +15 added lines

@@ -278,6 +278,9 @@ 
 		$this->unloadRecursive();
 	}
 
+	/**
+	 * @param string $enc
+	 */
 	protected static function decodeUTF8($data, $enc)
 	{
 		if(is_array($data))
@@ -451,6 +454,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)
@@ -562,6 +566,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)
 	{
@@ -856,6 +861,7 @@ 
 	 * Processes post data.
 	 * @param TMap post data to be processed
 	 * @param boolean whether this method is invoked before {@link onLoad OnLoad}.
+	 * @param boolean $beforeLoad
 	 */
 	protected function processPostData($postData,$beforeLoad)
 	{
@@ -981,6 +987,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)
 	{
@@ -1066,6 +1073,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)
 	{
@@ -1185,6 +1193,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)
 	{
@@ -1230,15 +1240,18 @@ 
 {
 	/**
 	 * @param TPage the page that this persister works for
+	 * @return TPage
 	 */
 	public function getPage();
 	/**
 	 * @param TPage the page that this persister works for
+	 * @return void
 	 */
 	public function setPage(TPage $page);
 	/**
 	 * Saves state to persistent storage.
 	 * @param mixed state to be stored
+	 * @return void
 	 */
 	public function save($state);
 	/**
@@ -1272,6 +1285,7 @@ 
 	/**
 	 * @param TPage
 	 * @param mixed state data
+	 * @param TPage $page
 	 * @return string serialized data
 	 */
 	public static function serialize($page,$data)
@@ -1291,6 +1305,7 @@ 
 	/**
 	 * @param TPage
 	 * @param string serialized data
+	 * @param TPage $page
 	 * @return mixed unserialized state data, null if data is corrupted
 	 */
 	public static function unserialize($page,$data)

framework/Web/UI/TTemplateControl.php

Doc Comments +3 added lines, -1 removed lines

@@ -144,6 +144,7 @@ 
 	 * Registers a content control.
 	 * @param string ID of the content
 	 * @param TContent
+	 * @param string $id
 	 */
 	public function registerContent($id,TContent $object)
 	{
@@ -158,6 +159,7 @@ 
 	 * This method should only be used by framework and control developers.
 	 * @param string placeholder ID
 	 * @param TContentPlaceHolder placeholder control
+	 * @param string $id
 	 */
 	public function registerContentPlaceHolder($id,TContentPlaceHolder $object)
 	{
@@ -184,7 +186,7 @@ 
 	}
 
 	/**
-	 * @return TTemplateControl|null master control associated with this control, null if none
+	 * @return TTemplateControl master control associated with this control, null if none
 	 */
 	public function getMaster()
 	{

framework/Web/UI/TTemplateControlInheritable.php

Doc Comments +1 added lines, -1 removed lines

@@ -76,7 +76,7 @@
 	/**
 	 * This method creates the template object for the given class
 	 *
-	 * @param string $p_class The class to create the template from
+	 * @param string $parentClass
 	 * @return void
 	 * @throws TConfigurationException if a template control directive is invalid
 	 */

framework/Web/UI/TTemplateManager.php

Doc Comments +11 added lines

@@ -69,6 +69,7 @@ 
 
 	/**
 	 * Loads the template from the specified file.
+	 * @param string $fileName
 	 * @return ITemplate template parsed from the specified file, null if the file doesn't exist.
 	 */
 	public function getTemplateByFileName($fileName)
@@ -415,6 +416,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)
 	{
@@ -431,6 +433,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)
 	{
@@ -817,6 +820,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)
@@ -851,6 +856,9 @@ 
 		return $attributes;
 	}
 
+	/**
+	 * @param string $content
+	 */
 	protected function parseTemplateProperty($content,$offset)
 	{
 		$line=$this->_startingLine+count(explode("\n",substr($this->_content,0,$offset)))-1;
@@ -860,6 +868,7 @@ 
 	/**
 	 * Parses a single attribute.
 	 * @param string the string to be parsed.
+	 * @param string $value
 	 * @return array attribute initialization
 	 */
 	protected function parseAttribute($value)
@@ -1002,6 +1011,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)
 	{

framework/Web/UI/WebControls/assets/captcha.php

Doc Comments +20 added lines

@@ -54,6 +54,9 @@ 
 	return $caseSensitive?$token:strtoupper($token);
 }
 
+/**
+ * @param string $hex
+ */
 function hash2string($hex,$alphabet)
 {
 	if(strlen($alphabet)<2)
@@ -121,6 +124,11 @@ 
 	imagedestroy($image);
 }
 
+/**
+ * @param resource $image
+ * @param double $width
+ * @param double $height
+ */
 function addBackground($image,$width,$height,$opaque,$noisy,$hasGrid,$hasScribble,$morph)
 {
 	$background=imagecreatetruecolor($width*2,$height*2);
@@ -148,6 +156,9 @@ 
 		imagecolortransparent($image,$white);
 }
 
+/**
+ * @param resource $image
+ */
 function addNoise($image,$width,$height)
 {
 	for($x=0;$x<$width;++$x)
@@ -164,6 +175,9 @@ 
 	}
 }
 
+/**
+ * @param resource $image
+ */
 function addGrid($image,$width,$height)
 {
 	for($i=0;$i<$width;$i+=rand(15,25))
@@ -182,6 +196,9 @@ 
 	}
 }
 
+/**
+ * @param resource $image
+ */
 function addScribble($image,$width,$height)
 {
 	for($i=0;$i<8;$i++)
@@ -199,6 +216,9 @@ 
 	}
 }
 
+/**
+ * @param resource $image
+ */
 function morphImage($image,$width,$height)
 {
 	$tempImage=imagecreatetruecolor($width,$height);

framework/Web/UI/WebControls/TBaseDataList.php

Doc Comments +1 added lines

@@ -166,6 +166,7 @@
 	 * Otherwise, an exception will be raised.
 	 * @param mixed data item
 	 * @param mixed field name
+	 * @param string $field
 	 * @return mixed data value at the specified field
 	 * @throws TInvalidDataValueException if the data is invalid
 	 */

framework/Web/UI/WebControls/TBaseValidator.php

Doc Comments +5 added lines, -2 removed lines

@@ -182,6 +182,7 @@ 
 	 * TBaseValidator::$_clientClass, be sure to update the corresponding
 	 * "Javascript/validation3.js" file as well.
 	 * @param TControl control to validate.
+	 * @param TControl $control
 	 * @return string control type for client-side validation.
 	 */
 	private function getClientControlClass($control)
@@ -259,7 +260,7 @@ 
 	/**
 	 * Update the ControlToValidate component's css class depending
 	 * if the ControlCssClass property is set, and whether this is valid.
-	 * @return boolean true if change, false otherwise.
+	 * @return boolean|null true if change, false otherwise.
 	 */
 	protected function updateControlCssClass()
 	{
@@ -384,6 +385,7 @@ 
 	 * The ID path is the dot-connected IDs of the controls reaching from
 	 * the validator's naming container to the target control.
 	 * @param string the ID path
+	 * @param string $value
 	 */
 	public function setControlToValidate($value)
 	{
@@ -549,6 +551,7 @@ 
 
 	/**
 	 * @param string the css class that is applied to the control being validated in case the validation fails
+	 * @param string $value
 	 */
 	public function setControlCssClass($value)
 	{
@@ -691,7 +694,7 @@ 
 	}
 
 	/**
-	 * @return boolean true to observe changes.
+	 * @return boolean|string true to observe changes.
 	 */
 	public function getObserveChanges()
 	{

framework/Web/UI/WebControls/TBulletedList.php

Doc Comments +2 added lines

@@ -216,6 +216,7 @@ 
 	 * This method is invoked when the {@link getDisplayMode DisplayMode} is 'LinkButton'
 	 * and end-users click on one of the buttons.
 	 * @param TBulletedListEventParameter event parameter.
+	 * @param TBulletedListEventParameter $param
 	 */
 	public function onClick($param)
 	{
@@ -425,6 +426,7 @@ 
 	/**
 	 * Constructor.
 	 * @param integer index of the item clicked
+	 * @param integer $index
 	 */
 	public function __construct($index)
 	{