pradosoft / prado

framework/Web/UI/ActiveControls/TCallbackClientScript.php

Doc Comments +10 added lines

@@ -84,6 +84,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=array())
 	{
@@ -144,6 +145,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 boolean $value
 	 */
 	public function select($control, $method='Value', $value=null, $type=null)
 	{
@@ -210,6 +212,7 @@ 
 	 * @param TControl control element or element id
 	 * @param string attribute name
 	 * @param string attribute value
+	 * @param TControl $control
 	 */
 	public function setAttribute($control, $name, $value)
 	{
@@ -359,6 +362,7 @@ 
 	 * key is the style property and the value is the style value.
 	 * @param TControl control element or element id
 	 * @param array list of key-value pairs as style property and style value.
+	 * @param TControl $element
 	 */
 	public function setStyle($element, $styles)
 	{
@@ -413,6 +417,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
@@ -441,6 +446,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, defaults to true.
+	 * @param TControl $element
 	 */
 	public function replaceContent($element, $content, $self=true)
 	{
@@ -492,6 +498,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)
@@ -504,6 +511,7 @@ 
 
 	/**
 	 * @param THtmlWriter the writer responsible for rendering html content.
+	 * @param THtmlWriter $html
 	 * @return string content boundary.
 	 */
 	private function getResponseContentBoundary($html)
@@ -523,6 +531,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=array())
 	{
@@ -630,6 +639,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=array())
 	{

framework/Web/UI/ActiveControls/TCallbackClientSide.php

Doc Comments +6 added lines, -4 removed lines

@@ -199,7 +199,7 @@ 
 	}
 
 	/**
-	 * @return boolean true to post the inputs of the form on callback, default
+	 * @return string true to post the inputs of the form on callback, default
 	 * is post the inputs on callback.
 	 */
 	public function getPostState()
@@ -217,7 +217,7 @@ 
 	}
 
 	/**
-	 * @return integer callback request timeout.
+	 * @return string callback request timeout.
 	 */
 	public function getRequestTimeOut()
 	{
@@ -233,7 +233,7 @@ 
 	}
 
 	/**
-	 * @return boolean true if the callback request has priority and will abort
+	 * @return boolean|string true if the callback request has priority and will abort
 	 * existing prioritized request in order to send immediately. It does not
 	 * affect callbacks that are not prioritized. Default is true.
 	 * @deprecated since 3.3.0
@@ -248,6 +248,7 @@ 
 	 * @param boolean true to ensure that the callback request will be sent
 	 * immediately and will abort existing prioritized requests. It does not
 	 * affect callbacks that are not prioritized.
+	 * @param boolean $value
 	 * @deprecated since 3.3.0
 	 */
 	public function setHasPriority($value)
@@ -263,6 +264,7 @@ 
 	 * update. This will automatically set HasPrority to true.
 	 * @param boolean true enables the callback response to update the
 	 * viewstate.
+	 * @param boolean $value
 	 */
 	public function setEnablePageStateUpdate($value)
 	{
@@ -273,7 +275,7 @@ 
 	}
 
 	/**
-	 * @return boolean client-side viewstate will be updated on callback
+	 * @return boolean|string client-side viewstate will be updated on callback
 	 * response if true. Default is true.
 	 */
 	public function getEnablePageStateUpdate()

framework/Web/UI/ActiveControls/TDraggable.php

Doc Comments +2 added lines, -2 removed lines

@@ -53,7 +53,7 @@ 
 	 *   o 'True' or 'Revert' : The draggable will revert to it's original position
 	 *   o 'False' or 'None' : The draggable won't revert to it's original position
 	 *   o 'Failure' : The draggable will only revert if it's dropped on a non droppable area
-	 * @return TDraggableRevertOption true to revert
+	 * @return string true to revert
 	 */
 	public function getRevert()
 	{
@@ -118,7 +118,7 @@ 
 
 	/**
 	 * Determine if the element should be constrainted in one direction or not
-	 * @return CDraggableConstraint
+	 * @return string
 	 */
 	public function getConstraint()
 	{

framework/Web/UI/ActiveControls/TDropContainer.php

Doc Comments -1 removed lines

@@ -127,7 +127,6 @@
 	 * Raises the onDrop event.
 	 * The drop parameters are encapsulated into a {@link TDropContainerEventParameter}
 	 *
-	 * @param object $dropControlId
 	 */
 	public function onDrop ($dropParams)
 	{

framework/Web/UI/ActiveControls/TInPlaceTextBox.php

Doc Comments +3 added lines

@@ -92,6 +92,8 @@ 
 	 * Calls the client-side static method for this control class.
 	 * @param string static method name
 	 * @param mixed method parmaeter
+	 * @param string $func
+	 * @param boolean $value
 	 */
 	protected function callClientFunction($func,$value)
 	{
@@ -239,6 +241,7 @@ 
 	 * Raised when editing the content is requsted to be loaded from the
 	 * server side.
 	 * @param TCallbackEventParameter event parameter to be passed to the event handlers
+	 * @param TCallbackEventParameter $param
 	 */
 	public function onLoadingText($param)
 	{

framework/Web/UI/ActiveControls/TTriggeredCallback.php

Doc Comments +1 added lines, -1 removed lines

@@ -56,7 +56,7 @@
 	}
 
 	/**
-	 * @return array list of trigger callback options.
+	 * @return string list of trigger callback options.
 	 */
 	protected function getTriggerOptions()
 	{

framework/Web/UI/JuiControls/TJuiAutoComplete.php

Doc Comments +3 added lines

@@ -252,6 +252,7 @@ 
 	 * method, be sure to call the parent implementation so that the event
 	 * handler can be invoked.
 	 * @param TCallbackEventParameter event parameter to be passed to the event handlers
+	 * @param TJuiAutoCompleteEventParameter $param
 	 */
 	public function onSuggest($param)
 	{
@@ -264,6 +265,7 @@ 
 	 * method, be sure to call the parent implementation so that the event
 	 * handler can be invoked.
 	 * @param TCallbackEventParameter event parameter to be passed to the event handlers
+	 * @param TJuiAutoCompleteEventParameter $param
 	 */
 	public function onSuggestionSelected($param)
 	{
@@ -441,6 +443,7 @@ 
 
 	/**
 	 * Creates a new TCallbackEventParameter.
+	 * @param THttpResponse $response
 	 */
 	public function __construct($response, $parameter, $index=-1)
 	{

framework/Web/UI/JuiControls/TJuiControlAdapter.php

Doc Comments +2 added lines, -2 removed lines

@@ -78,7 +78,7 @@ 
 
 	/**
 	 * Publish the jQuery-ui style Css asset file.
-	 * @param file name
+	 * @param file string
 	 * @return string Css file url.
 	 */
 	public function publishJuiStyle($file)
@@ -153,7 +153,7 @@ 
 	 * Gets a control instance named after a returned control id.
 	 * Example: if a $param->draggable control id is returned from clientside,
 	 * calling $param->DraggableControl will return the control instance
-	 * @return mixed control or null if not set.
+	 * @return null|TControl control or null if not set.
 	 */
 	public function __get($name)
 	{

framework/Web/UI/JuiControls/TJuiControlOptions.php

Doc Comments +16 added lines, -1 removed lines

@@ -21,9 +21,24 @@ 
  */
 interface IJuiOptions
 {
+	/**
+	 * @return string
+	 */
 	public function getWidget();
+
+	/**
+	 * @return string
+	 */
 	public function getWidgetID();
+
+	/**
+	 * @return TJuiControlOptions
+	 */
 	public function getOptions();
+
+	/**
+	 * @return string[]
+	 */
 	public function getValidOptions();
 	public function getValidEvents();
 }
@@ -139,7 +154,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() {
 	  return array('_options');