@@ -84,6 +84,7 @@ discard block |
||
84 | 84 | * Executes a client-side statement. |
85 | 85 | * @param string javascript function name |
86 | 86 | * @param array list of arguments for the function |
87 | + * @param string $function |
|
87 | 88 | */ |
88 | 89 | public function callClientFunction($function, $params=array()) |
89 | 90 | { |
@@ -144,6 +145,7 @@ discard block |
||
144 | 145 | * @param string selection method |
145 | 146 | * @param string|int the value or index to select/check. |
146 | 147 | * @param string selection control type, either 'check' or 'select' |
148 | + * @param boolean $value |
|
147 | 149 | */ |
148 | 150 | public function select($control, $method='Value', $value=null, $type=null) |
149 | 151 | { |
@@ -210,6 +212,7 @@ discard block |
||
210 | 212 | * @param TControl control element or element id |
211 | 213 | * @param string attribute name |
212 | 214 | * @param string attribute value |
215 | + * @param TControl $control |
|
213 | 216 | */ |
214 | 217 | public function setAttribute($control, $name, $value) |
215 | 218 | { |
@@ -359,6 +362,7 @@ discard block |
||
359 | 362 | * key is the style property and the value is the style value. |
360 | 363 | * @param TControl control element or element id |
361 | 364 | * @param array list of key-value pairs as style property and style value. |
365 | + * @param TControl $element |
|
362 | 366 | */ |
363 | 367 | public function setStyle($element, $styles) |
364 | 368 | { |
@@ -413,6 +417,7 @@ discard block |
||
413 | 417 | * @param TControl control element or HTML element id. |
414 | 418 | * @param string HTML fragement or the control to be rendered. |
415 | 419 | * @param boolean whether to fully replace the element or just its inner content. |
420 | + * @param boolean $self |
|
416 | 421 | * @see insertAbout |
417 | 422 | * @see insertBelow |
418 | 423 | * @see insertBefore |
@@ -441,6 +446,7 @@ discard block |
||
441 | 446 | * @param TControl control element or HTML element id. |
442 | 447 | * @param string HTML fragement or the control to be rendered. |
443 | 448 | * @param boolean whether to fully replace the element or just its inner content, defaults to true. |
449 | + * @param TControl $element |
|
444 | 450 | */ |
445 | 451 | public function replaceContent($element, $content, $self=true) |
446 | 452 | { |
@@ -492,6 +498,7 @@ discard block |
||
492 | 498 | * component developers. The render() method is defered to be called in the |
493 | 499 | * TActivePageAdapter class. |
494 | 500 | * @param TControl control to be rendered on callback response. |
501 | + * @param TControl $control |
|
495 | 502 | * @return string the boundary for which the rendered content is wrapped. |
496 | 503 | */ |
497 | 504 | private function getRenderedContentBoundary($control) |
@@ -504,6 +511,7 @@ discard block |
||
504 | 511 | |
505 | 512 | /** |
506 | 513 | * @param THtmlWriter the writer responsible for rendering html content. |
514 | + * @param THtmlWriter $html |
|
507 | 515 | * @return string content boundary. |
508 | 516 | */ |
509 | 517 | private function getResponseContentBoundary($html) |
@@ -523,6 +531,7 @@ discard block |
||
523 | 531 | * @param string visual effect function name. |
524 | 532 | * @param TControl control element or element id |
525 | 533 | * @param array visual effect key-value pair options. |
534 | + * @param string $type |
|
526 | 535 | */ |
527 | 536 | public function visualEffect($type, $element, $options=array()) |
528 | 537 | { |
@@ -630,6 +639,7 @@ discard block |
||
630 | 639 | * @param string visual effect function name. |
631 | 640 | * @param TControl control element or element id |
632 | 641 | * @param array effect options. |
642 | + * @param string $effect |
|
633 | 643 | */ |
634 | 644 | public function juiEffect($element, $effect, $options=array()) |
635 | 645 | { |
@@ -53,7 +53,7 @@ discard block |
||
53 | 53 | * o 'True' or 'Revert' : The draggable will revert to it's original position |
54 | 54 | * o 'False' or 'None' : The draggable won't revert to it's original position |
55 | 55 | * o 'Failure' : The draggable will only revert if it's dropped on a non droppable area |
56 | - * @return TDraggableRevertOption true to revert |
|
56 | + * @return string true to revert |
|
57 | 57 | */ |
58 | 58 | public function getRevert() |
59 | 59 | { |
@@ -118,7 +118,7 @@ discard block |
||
118 | 118 | |
119 | 119 | /** |
120 | 120 | * Determine if the element should be constrainted in one direction or not |
121 | - * @return CDraggableConstraint |
|
121 | + * @return string |
|
122 | 122 | */ |
123 | 123 | public function getConstraint() |
124 | 124 | { |
@@ -127,7 +127,6 @@ |
||
127 | 127 | * Raises the onDrop event. |
128 | 128 | * The drop parameters are encapsulated into a {@link TDropContainerEventParameter} |
129 | 129 | * |
130 | - * @param object $dropControlId |
|
131 | 130 | */ |
132 | 131 | public function onDrop ($dropParams) |
133 | 132 | { |
@@ -92,6 +92,8 @@ discard block |
||
92 | 92 | * Calls the client-side static method for this control class. |
93 | 93 | * @param string static method name |
94 | 94 | * @param mixed method parmaeter |
95 | + * @param string $func |
|
96 | + * @param boolean $value |
|
95 | 97 | */ |
96 | 98 | protected function callClientFunction($func,$value) |
97 | 99 | { |
@@ -239,6 +241,7 @@ discard block |
||
239 | 241 | * Raised when editing the content is requsted to be loaded from the |
240 | 242 | * server side. |
241 | 243 | * @param TCallbackEventParameter event parameter to be passed to the event handlers |
244 | + * @param TCallbackEventParameter $param |
|
242 | 245 | */ |
243 | 246 | public function onLoadingText($param) |
244 | 247 | { |
@@ -56,7 +56,7 @@ |
||
56 | 56 | } |
57 | 57 | |
58 | 58 | /** |
59 | - * @return array list of trigger callback options. |
|
59 | + * @return string list of trigger callback options. |
|
60 | 60 | */ |
61 | 61 | protected function getTriggerOptions() |
62 | 62 | { |
@@ -252,6 +252,7 @@ discard block |
||
252 | 252 | * method, be sure to call the parent implementation so that the event |
253 | 253 | * handler can be invoked. |
254 | 254 | * @param TCallbackEventParameter event parameter to be passed to the event handlers |
255 | + * @param TJuiAutoCompleteEventParameter $param |
|
255 | 256 | */ |
256 | 257 | public function onSuggest($param) |
257 | 258 | { |
@@ -264,6 +265,7 @@ discard block |
||
264 | 265 | * method, be sure to call the parent implementation so that the event |
265 | 266 | * handler can be invoked. |
266 | 267 | * @param TCallbackEventParameter event parameter to be passed to the event handlers |
268 | + * @param TJuiAutoCompleteEventParameter $param |
|
267 | 269 | */ |
268 | 270 | public function onSuggestionSelected($param) |
269 | 271 | { |
@@ -441,6 +443,7 @@ discard block |
||
441 | 443 | |
442 | 444 | /** |
443 | 445 | * Creates a new TCallbackEventParameter. |
446 | + * @param THttpResponse $response |
|
444 | 447 | */ |
445 | 448 | public function __construct($response, $parameter, $index=-1) |
446 | 449 | { |
@@ -78,7 +78,7 @@ discard block |
||
78 | 78 | |
79 | 79 | /** |
80 | 80 | * Publish the jQuery-ui style Css asset file. |
81 | - * @param file name |
|
81 | + * @param file string |
|
82 | 82 | * @return string Css file url. |
83 | 83 | */ |
84 | 84 | public function publishJuiStyle($file) |
@@ -153,7 +153,7 @@ discard block |
||
153 | 153 | * Gets a control instance named after a returned control id. |
154 | 154 | * Example: if a $param->draggable control id is returned from clientside, |
155 | 155 | * calling $param->DraggableControl will return the control instance |
156 | - * @return mixed control or null if not set. |
|
156 | + * @return null|TControl control or null if not set. |
|
157 | 157 | */ |
158 | 158 | public function __get($name) |
159 | 159 | { |
@@ -21,9 +21,24 @@ discard block |
||
21 | 21 | */ |
22 | 22 | interface IJuiOptions |
23 | 23 | { |
24 | + /** |
|
25 | + * @return string |
|
26 | + */ |
|
24 | 27 | public function getWidget(); |
28 | + |
|
29 | + /** |
|
30 | + * @return string |
|
31 | + */ |
|
25 | 32 | public function getWidgetID(); |
33 | + |
|
34 | + /** |
|
35 | + * @return TJuiControlOptions |
|
36 | + */ |
|
26 | 37 | public function getOptions(); |
38 | + |
|
39 | + /** |
|
40 | + * @return string[] |
|
41 | + */ |
|
27 | 42 | public function getValidOptions(); |
28 | 43 | public function getValidEvents(); |
29 | 44 | } |
@@ -139,7 +154,7 @@ discard block |
||
139 | 154 | |
140 | 155 | /** |
141 | 156 | * Only serialize the options itself, not the corresponding parent control. |
142 | - * @return mixed array with the names of all variables of that object that should be serialized. |
|
157 | + * @return string[] array with the names of all variables of that object that should be serialized. |
|
143 | 158 | */ |
144 | 159 | public function __sleep() { |
145 | 160 | return array('_options'); |
@@ -158,6 +158,9 @@ |
||
158 | 158 | $this->triggerClientMethod('close'); |
159 | 159 | } |
160 | 160 | |
161 | + /** |
|
162 | + * @param string $method |
|
163 | + */ |
|
161 | 164 | private function triggerClientMethod($method) |
162 | 165 | { |
163 | 166 | $cs = $this->getPage()->getClientScript(); |