@@ -317,6 +317,9 @@ |
||
| 317 | 317 | { |
| 318 | 318 | private $_template; |
| 319 | 319 | |
| 320 | + /** |
|
| 321 | + * @param string $template |
|
| 322 | + */ |
|
| 320 | 323 | public function __construct($template) |
| 321 | 324 | { |
| 322 | 325 | $this->_template = $template; |
@@ -215,6 +215,7 @@ discard block |
||
| 215 | 215 | |
| 216 | 216 | /** |
| 217 | 217 | * @param string javascript package path. |
| 218 | + * @param string $base |
|
| 218 | 219 | * @return array tuple($path,$url). |
| 219 | 220 | */ |
| 220 | 221 | protected function getPackagePathUrl($base) |
@@ -496,6 +497,8 @@ discard block |
||
| 496 | 497 | * @param string a unique key identifying the hidden field |
| 497 | 498 | * @param string|array hidden field value, if the value is an array, every element |
| 498 | 499 | * in the array will be rendered as a hidden field value. |
| 500 | + * @param string $name |
|
| 501 | + * @param string $value |
|
| 499 | 502 | */ |
| 500 | 503 | public function registerHiddenField($name,$value) |
| 501 | 504 | { |
@@ -735,6 +738,7 @@ discard block |
||
| 735 | 738 | |
| 736 | 739 | /** |
| 737 | 740 | * @param THtmlWriter writer for the rendering purpose |
| 741 | + * @param boolean $initial |
|
| 738 | 742 | */ |
| 739 | 743 | protected function renderHiddenFieldsInt($writer, $initial) |
| 740 | 744 | { |
@@ -799,6 +803,7 @@ discard block |
||
| 799 | 803 | * javascript statements. |
| 800 | 804 | * @param string option name |
| 801 | 805 | * @param string javascript statements. |
| 806 | + * @param string $name |
|
| 802 | 807 | */ |
| 803 | 808 | protected function setFunction($name, $code) |
| 804 | 809 | { |
@@ -808,6 +813,7 @@ discard block |
||
| 808 | 813 | } |
| 809 | 814 | |
| 810 | 815 | /** |
| 816 | + * @param string $name |
|
| 811 | 817 | * @return string gets a particular option, null if not set. |
| 812 | 818 | */ |
| 813 | 819 | protected function getOption($name) |
@@ -278,6 +278,9 @@ discard block |
||
| 278 | 278 | $this->unloadRecursive(); |
| 279 | 279 | } |
| 280 | 280 | |
| 281 | + /** |
|
| 282 | + * @param string $enc |
|
| 283 | + */ |
|
| 281 | 284 | protected static function decodeUTF8($data, $enc) |
| 282 | 285 | { |
| 283 | 286 | if(is_array($data)) |
@@ -451,6 +454,7 @@ discard block |
||
| 451 | 454 | * Returns a list of registered validators. |
| 452 | 455 | * If validation group is specified, only the validators in that group will be returned. |
| 453 | 456 | * @param string validation group |
| 457 | + * @param string $validationGroup |
|
| 454 | 458 | * @return TList registered validators in the requested group. If the group is null, all validators will be returned. |
| 455 | 459 | */ |
| 456 | 460 | public function getValidators($validationGroup=null) |
@@ -562,6 +566,7 @@ discard block |
||
| 562 | 566 | * Applies a skin in the current theme to a control. |
| 563 | 567 | * This method should only be used by framework developers. |
| 564 | 568 | * @param TControl a control to be applied skin with |
| 569 | + * @param TControl $control |
|
| 565 | 570 | */ |
| 566 | 571 | public function applyControlSkin($control) |
| 567 | 572 | { |
@@ -856,6 +861,7 @@ discard block |
||
| 856 | 861 | * Processes post data. |
| 857 | 862 | * @param TMap post data to be processed |
| 858 | 863 | * @param boolean whether this method is invoked before {@link onLoad OnLoad}. |
| 864 | + * @param boolean $beforeLoad |
|
| 859 | 865 | */ |
| 860 | 866 | protected function processPostData($postData,$beforeLoad) |
| 861 | 867 | { |
@@ -981,6 +987,7 @@ discard block |
||
| 981 | 987 | /** |
| 982 | 988 | * Sets input focus on a control after the page is rendered to users. |
| 983 | 989 | * @param TControl|string control to receive focus, or the ID of the element on the page to receive focus |
| 990 | + * @param TControl $value |
|
| 984 | 991 | */ |
| 985 | 992 | public function setFocus($value) |
| 986 | 993 | { |
@@ -1066,6 +1073,7 @@ discard block |
||
| 1066 | 1073 | * Sets the state to be stored on the client side. |
| 1067 | 1074 | * This method should only be used by framework and control developers. |
| 1068 | 1075 | * @param string the state to be stored on the client side |
| 1076 | + * @param string $state |
|
| 1069 | 1077 | */ |
| 1070 | 1078 | public function setClientState($state) |
| 1071 | 1079 | { |
@@ -1185,6 +1193,8 @@ discard block |
||
| 1185 | 1193 | * referring to the context object (e.g. Page, Page.ClientScript). |
| 1186 | 1194 | * @param string method name of the context object |
| 1187 | 1195 | * @param array list of parameters to be passed to the action method |
| 1196 | + * @param string $context |
|
| 1197 | + * @param string $funcName |
|
| 1188 | 1198 | */ |
| 1189 | 1199 | public function registerCachingAction($context,$funcName,$funcParams) |
| 1190 | 1200 | { |
@@ -1230,15 +1240,18 @@ discard block |
||
| 1230 | 1240 | { |
| 1231 | 1241 | /** |
| 1232 | 1242 | * @param TPage the page that this persister works for |
| 1243 | + * @return TPage |
|
| 1233 | 1244 | */ |
| 1234 | 1245 | public function getPage(); |
| 1235 | 1246 | /** |
| 1236 | 1247 | * @param TPage the page that this persister works for |
| 1248 | + * @return void |
|
| 1237 | 1249 | */ |
| 1238 | 1250 | public function setPage(TPage $page); |
| 1239 | 1251 | /** |
| 1240 | 1252 | * Saves state to persistent storage. |
| 1241 | 1253 | * @param mixed state to be stored |
| 1254 | + * @return void |
|
| 1242 | 1255 | */ |
| 1243 | 1256 | public function save($state); |
| 1244 | 1257 | /** |
@@ -1272,6 +1285,7 @@ discard block |
||
| 1272 | 1285 | /** |
| 1273 | 1286 | * @param TPage |
| 1274 | 1287 | * @param mixed state data |
| 1288 | + * @param TPage $page |
|
| 1275 | 1289 | * @return string serialized data |
| 1276 | 1290 | */ |
| 1277 | 1291 | public static function serialize($page,$data) |
@@ -1291,6 +1305,7 @@ discard block |
||
| 1291 | 1305 | /** |
| 1292 | 1306 | * @param TPage |
| 1293 | 1307 | * @param string serialized data |
| 1308 | + * @param TPage $page |
|
| 1294 | 1309 | * @return mixed unserialized state data, null if data is corrupted |
| 1295 | 1310 | */ |
| 1296 | 1311 | public static function unserialize($page,$data) |
@@ -144,6 +144,7 @@ discard block |
||
| 144 | 144 | * Registers a content control. |
| 145 | 145 | * @param string ID of the content |
| 146 | 146 | * @param TContent |
| 147 | + * @param string $id |
|
| 147 | 148 | */ |
| 148 | 149 | public function registerContent($id,TContent $object) |
| 149 | 150 | { |
@@ -158,6 +159,7 @@ discard block |
||
| 158 | 159 | * This method should only be used by framework and control developers. |
| 159 | 160 | * @param string placeholder ID |
| 160 | 161 | * @param TContentPlaceHolder placeholder control |
| 162 | + * @param string $id |
|
| 161 | 163 | */ |
| 162 | 164 | public function registerContentPlaceHolder($id,TContentPlaceHolder $object) |
| 163 | 165 | { |
@@ -184,7 +186,7 @@ discard block |
||
| 184 | 186 | } |
| 185 | 187 | |
| 186 | 188 | /** |
| 187 | - * @return TTemplateControl|null master control associated with this control, null if none |
|
| 189 | + * @return TTemplateControl master control associated with this control, null if none |
|
| 188 | 190 | */ |
| 189 | 191 | public function getMaster() |
| 190 | 192 | { |
@@ -76,7 +76,7 @@ |
||
| 76 | 76 | /** |
| 77 | 77 | * This method creates the template object for the given class |
| 78 | 78 | * |
| 79 | - * @param string $p_class The class to create the template from |
|
| 79 | + * @param string $parentClass |
|
| 80 | 80 | * @return void |
| 81 | 81 | * @throws TConfigurationException if a template control directive is invalid |
| 82 | 82 | */ |
@@ -69,6 +69,7 @@ discard block |
||
| 69 | 69 | |
| 70 | 70 | /** |
| 71 | 71 | * Loads the template from the specified file. |
| 72 | + * @param string $fileName |
|
| 72 | 73 | * @return ITemplate template parsed from the specified file, null if the file doesn't exist. |
| 73 | 74 | */ |
| 74 | 75 | public function getTemplateByFileName($fileName) |
@@ -415,6 +416,7 @@ discard block |
||
| 415 | 416 | * @param TControl control to be configured |
| 416 | 417 | * @param string property name |
| 417 | 418 | * @param mixed property initial value |
| 419 | + * @param TControl $control |
|
| 418 | 420 | */ |
| 419 | 421 | protected function configureControl($control,$name,$value) |
| 420 | 422 | { |
@@ -431,6 +433,7 @@ discard block |
||
| 431 | 433 | * @param TComponent component to be configured |
| 432 | 434 | * @param string property name |
| 433 | 435 | * @param mixed property initial value |
| 436 | + * @param TComponent $component |
|
| 434 | 437 | */ |
| 435 | 438 | protected function configureComponent($component,$name,$value) |
| 436 | 439 | { |
@@ -817,6 +820,8 @@ discard block |
||
| 817 | 820 | /** |
| 818 | 821 | * Parses the attributes of a tag from a string. |
| 819 | 822 | * @param string the string to be parsed. |
| 823 | + * @param string $str |
|
| 824 | + * @param string $offset |
|
| 820 | 825 | * @return array attribute values indexed by names. |
| 821 | 826 | */ |
| 822 | 827 | protected function parseAttributes($str,$offset) |
@@ -851,6 +856,9 @@ discard block |
||
| 851 | 856 | return $attributes; |
| 852 | 857 | } |
| 853 | 858 | |
| 859 | + /** |
|
| 860 | + * @param string $content |
|
| 861 | + */ |
|
| 854 | 862 | protected function parseTemplateProperty($content,$offset) |
| 855 | 863 | { |
| 856 | 864 | $line=$this->_startingLine+count(explode("\n",substr($this->_content,0,$offset)))-1; |
@@ -860,6 +868,7 @@ discard block |
||
| 860 | 868 | /** |
| 861 | 869 | * Parses a single attribute. |
| 862 | 870 | * @param string the string to be parsed. |
| 871 | + * @param string $value |
|
| 863 | 872 | * @return array attribute initialization |
| 864 | 873 | */ |
| 865 | 874 | protected function parseAttribute($value) |
@@ -1002,6 +1011,8 @@ discard block |
||
| 1002 | 1011 | * @param Exception template exception |
| 1003 | 1012 | * @param int line number |
| 1004 | 1013 | * @param string template string if no source file is used |
| 1014 | + * @param Exception $e |
|
| 1015 | + * @param integer $line |
|
| 1005 | 1016 | */ |
| 1006 | 1017 | protected function handleException($e,$line,$input=null) |
| 1007 | 1018 | { |
@@ -54,6 +54,9 @@ discard block |
||
| 54 | 54 | return $caseSensitive?$token:strtoupper($token); |
| 55 | 55 | } |
| 56 | 56 | |
| 57 | +/** |
|
| 58 | + * @param string $hex |
|
| 59 | + */ |
|
| 57 | 60 | function hash2string($hex,$alphabet) |
| 58 | 61 | { |
| 59 | 62 | if(strlen($alphabet)<2) |
@@ -121,6 +124,11 @@ discard block |
||
| 121 | 124 | imagedestroy($image); |
| 122 | 125 | } |
| 123 | 126 | |
| 127 | +/** |
|
| 128 | + * @param resource $image |
|
| 129 | + * @param double $width |
|
| 130 | + * @param double $height |
|
| 131 | + */ |
|
| 124 | 132 | function addBackground($image,$width,$height,$opaque,$noisy,$hasGrid,$hasScribble,$morph) |
| 125 | 133 | { |
| 126 | 134 | $background=imagecreatetruecolor($width*2,$height*2); |
@@ -148,6 +156,9 @@ discard block |
||
| 148 | 156 | imagecolortransparent($image,$white); |
| 149 | 157 | } |
| 150 | 158 | |
| 159 | +/** |
|
| 160 | + * @param resource $image |
|
| 161 | + */ |
|
| 151 | 162 | function addNoise($image,$width,$height) |
| 152 | 163 | { |
| 153 | 164 | for($x=0;$x<$width;++$x) |
@@ -164,6 +175,9 @@ discard block |
||
| 164 | 175 | } |
| 165 | 176 | } |
| 166 | 177 | |
| 178 | +/** |
|
| 179 | + * @param resource $image |
|
| 180 | + */ |
|
| 167 | 181 | function addGrid($image,$width,$height) |
| 168 | 182 | { |
| 169 | 183 | for($i=0;$i<$width;$i+=rand(15,25)) |
@@ -182,6 +196,9 @@ discard block |
||
| 182 | 196 | } |
| 183 | 197 | } |
| 184 | 198 | |
| 199 | +/** |
|
| 200 | + * @param resource $image |
|
| 201 | + */ |
|
| 185 | 202 | function addScribble($image,$width,$height) |
| 186 | 203 | { |
| 187 | 204 | for($i=0;$i<8;$i++) |
@@ -199,6 +216,9 @@ discard block |
||
| 199 | 216 | } |
| 200 | 217 | } |
| 201 | 218 | |
| 219 | +/** |
|
| 220 | + * @param resource $image |
|
| 221 | + */ |
|
| 202 | 222 | function morphImage($image,$width,$height) |
| 203 | 223 | { |
| 204 | 224 | $tempImage=imagecreatetruecolor($width,$height); |
@@ -166,6 +166,7 @@ |
||
| 166 | 166 | * Otherwise, an exception will be raised. |
| 167 | 167 | * @param mixed data item |
| 168 | 168 | * @param mixed field name |
| 169 | + * @param string $field |
|
| 169 | 170 | * @return mixed data value at the specified field |
| 170 | 171 | * @throws TInvalidDataValueException if the data is invalid |
| 171 | 172 | */ |
@@ -182,6 +182,7 @@ discard block |
||
| 182 | 182 | * TBaseValidator::$_clientClass, be sure to update the corresponding |
| 183 | 183 | * "Javascript/validation3.js" file as well. |
| 184 | 184 | * @param TControl control to validate. |
| 185 | + * @param TControl $control |
|
| 185 | 186 | * @return string control type for client-side validation. |
| 186 | 187 | */ |
| 187 | 188 | private function getClientControlClass($control) |
@@ -259,7 +260,7 @@ discard block |
||
| 259 | 260 | /** |
| 260 | 261 | * Update the ControlToValidate component's css class depending |
| 261 | 262 | * if the ControlCssClass property is set, and whether this is valid. |
| 262 | - * @return boolean true if change, false otherwise. |
|
| 263 | + * @return boolean|null true if change, false otherwise. |
|
| 263 | 264 | */ |
| 264 | 265 | protected function updateControlCssClass() |
| 265 | 266 | { |
@@ -384,6 +385,7 @@ discard block |
||
| 384 | 385 | * The ID path is the dot-connected IDs of the controls reaching from |
| 385 | 386 | * the validator's naming container to the target control. |
| 386 | 387 | * @param string the ID path |
| 388 | + * @param string $value |
|
| 387 | 389 | */ |
| 388 | 390 | public function setControlToValidate($value) |
| 389 | 391 | { |
@@ -549,6 +551,7 @@ discard block |
||
| 549 | 551 | |
| 550 | 552 | /** |
| 551 | 553 | * @param string the css class that is applied to the control being validated in case the validation fails |
| 554 | + * @param string $value |
|
| 552 | 555 | */ |
| 553 | 556 | public function setControlCssClass($value) |
| 554 | 557 | { |
@@ -691,7 +694,7 @@ discard block |
||
| 691 | 694 | } |
| 692 | 695 | |
| 693 | 696 | /** |
| 694 | - * @return boolean true to observe changes. |
|
| 697 | + * @return boolean|string true to observe changes. |
|
| 695 | 698 | */ |
| 696 | 699 | public function getObserveChanges() |
| 697 | 700 | { |