@@ -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 | */ |
@@ -267,6 +267,7 @@ discard block |
||
267 | 267 | |
268 | 268 | /** |
269 | 269 | * @param string the public key used for generating the token. A random one will be generated if this is not set. |
270 | + * @param string $value |
|
270 | 271 | */ |
271 | 272 | public function setPublicKey($value) |
272 | 273 | { |
@@ -322,6 +323,7 @@ discard block |
||
322 | 323 | /** |
323 | 324 | * Validates a user input with the token. |
324 | 325 | * @param string user input |
326 | + * @param string $input |
|
325 | 327 | * @return boolean if the user input is not the same as the token. |
326 | 328 | */ |
327 | 329 | public function validate($input) |
@@ -447,6 +449,11 @@ discard block |
||
447 | 449 | * @param string private key |
448 | 450 | * @param integer the length of the token |
449 | 451 | * @param boolean whether the token is case sensitive |
452 | + * @param string $publicKey |
|
453 | + * @param string $privateKey |
|
454 | + * @param string $alphabet |
|
455 | + * @param integer $tokenLength |
|
456 | + * @param boolean $caseSensitive |
|
450 | 457 | * @return string the token generated. |
451 | 458 | */ |
452 | 459 | protected function generateToken($publicKey,$privateKey,$alphabet,$tokenLength,$caseSensitive) |
@@ -459,6 +466,7 @@ discard block |
||
459 | 466 | * Converts a hash string into a string with characters consisting of alphanumeric characters. |
460 | 467 | * @param string the hexadecimal representation of the hash string |
461 | 468 | * @param string the alphabet used to represent the converted string. If empty, it means '234578adefhijmnrtwyABDEFGHIJLMNQRTWY', which excludes those confusing characters. |
469 | + * @param string $hex |
|
462 | 470 | * @return string the converted string |
463 | 471 | */ |
464 | 472 | protected function hash2string($hex,$alphabet='') |
@@ -79,7 +79,7 @@ discard block |
||
79 | 79 | } |
80 | 80 | |
81 | 81 | /** |
82 | - * @return TCaptchaControl the CAPTCHA control to be validated against |
|
82 | + * @return TCaptcha the CAPTCHA control to be validated against |
|
83 | 83 | * @throws TConfigurationException if the CAPTCHA cannot be found according to {@link setCaptchaControl CaptchaControl} |
84 | 84 | */ |
85 | 85 | protected function findCaptchaControl() |
@@ -115,6 +115,9 @@ discard block |
||
115 | 115 | return $options; |
116 | 116 | } |
117 | 117 | |
118 | + /** |
|
119 | + * @param string $token |
|
120 | + */ |
|
118 | 121 | private function generateTokenHash($token) |
119 | 122 | { |
120 | 123 | for($h=0,$i=strlen($token)-1;$i>=0;--$i) |
@@ -117,7 +117,7 @@ discard block |
||
117 | 117 | |
118 | 118 | /** |
119 | 119 | * Returns the value of the property that needs validation. |
120 | - * @return mixed the property value to be validated |
|
120 | + * @return boolean the property value to be validated |
|
121 | 121 | */ |
122 | 122 | public function getValidationPropertyValue() |
123 | 123 | { |
@@ -184,6 +184,7 @@ discard block |
||
184 | 184 | |
185 | 185 | /** |
186 | 186 | * @param TTextAlign the alignment of the text caption. Valid values include Left and Right. |
187 | + * @param TTextAlign $value |
|
187 | 188 | */ |
188 | 189 | public function setTextAlign($value) |
189 | 190 | { |
@@ -244,6 +245,7 @@ discard block |
||
244 | 245 | /** |
245 | 246 | * Sets a value indicating whether clicking on the checkbox will post the page. |
246 | 247 | * @param boolean whether clicking on the checkbox will post the page. |
248 | + * @param boolean $value |
|
247 | 249 | */ |
248 | 250 | public function setAutoPostBack($value) |
249 | 251 | { |
@@ -261,6 +263,7 @@ discard block |
||
261 | 263 | /** |
262 | 264 | * Sets the value indicating whether postback event trigger by this checkbox will cause input validation. |
263 | 265 | * @param boolean whether postback event trigger by this checkbox will cause input validation. |
266 | + * @param boolean $value |
|
264 | 267 | */ |
265 | 268 | public function setCausesValidation($value) |
266 | 269 | { |
@@ -277,6 +280,7 @@ discard block |
||
277 | 280 | |
278 | 281 | /** |
279 | 282 | * @param string the group of validators which the checkbox causes validation upon postback |
283 | + * @param string $value |
|
280 | 284 | */ |
281 | 285 | public function setValidationGroup($value) |
282 | 286 | { |
@@ -410,6 +414,7 @@ discard block |
||
410 | 414 | |
411 | 415 | /** |
412 | 416 | * @param boolean whether to render javascript. |
417 | + * @param boolean $value |
|
413 | 418 | */ |
414 | 419 | public function setEnableClientScript($value) |
415 | 420 | { |
@@ -186,6 +186,8 @@ |
||
186 | 186 | * Parse the pair of values into the appropriate value type. |
187 | 187 | * @param string value one |
188 | 188 | * @param string second value |
189 | + * @param string $value1 |
|
190 | + * @param string $value2 |
|
189 | 191 | * @return array appropriate type of the value pair, array($value1, $value2); |
190 | 192 | */ |
191 | 193 | protected function getComparisonValues($value1, $value2) |
@@ -281,6 +281,7 @@ discard block |
||
281 | 281 | * |
282 | 282 | * @param string the name of the viewstate value to be returned |
283 | 283 | * @param mixed the default value. If $key is not found in viewstate, $defaultValue will be returned |
284 | + * @param string $key |
|
284 | 285 | * @return mixed the viewstate value corresponding to $key |
285 | 286 | */ |
286 | 287 | protected function getViewState($key,$defaultValue=null) |
@@ -295,6 +296,7 @@ discard block |
||
295 | 296 | * @param string the name of the viewstate value |
296 | 297 | * @param mixed the viewstate value to be set |
297 | 298 | * @param mixed default value. If $value===$defaultValue, the item will be cleared from the viewstate. |
299 | + * @param string $key |
|
298 | 300 | */ |
299 | 301 | protected function setViewState($key,$value,$defaultValue=null) |
300 | 302 | { |
@@ -356,6 +358,7 @@ discard block |
||
356 | 358 | * If the data is a component, the field is used as the name of a property. |
357 | 359 | * @param mixed data containing the field of value |
358 | 360 | * @param string the data field |
361 | + * @param string $field |
|
359 | 362 | * @return mixed data value at the specified field |
360 | 363 | * @throws TInvalidDataValueException if the data or the field is invalid. |
361 | 364 | */ |
@@ -515,6 +518,7 @@ discard block |
||
515 | 518 | * as the first and second parameters in {@link sprintf}. |
516 | 519 | * @param string format string |
517 | 520 | * @param mixed the data to be formatted |
521 | + * @param string $formatString |
|
518 | 522 | * @return string the formatted result |
519 | 523 | */ |
520 | 524 | protected function formatDataValue($formatString,$value) |
@@ -82,6 +82,7 @@ |
||
82 | 82 | /** |
83 | 83 | * Determine if the given value is of a particular type using RegExp. |
84 | 84 | * @param string value to check |
85 | + * @param string $value |
|
85 | 86 | * @return boolean true if value fits the type expression. |
86 | 87 | */ |
87 | 88 | protected function evaluateDataTypeCheck($value) |
@@ -55,7 +55,7 @@ |
||
55 | 55 | |
56 | 56 | /** |
57 | 57 | * Returns an array of javascript validator options. |
58 | - * @return array javascript validator options. |
|
58 | + * @return boolean javascript validator options. |
|
59 | 59 | */ |
60 | 60 | public function evaluateIsValid() |
61 | 61 | { |
@@ -49,7 +49,7 @@ |
||
49 | 49 | } |
50 | 50 | |
51 | 51 | /** |
52 | - * @return Tells whether buffering of output can continue after this point |
|
52 | + * @return boolean whether buffering of output can continue after this point |
|
53 | 53 | */ |
54 | 54 | public function getContinueBuffering() |
55 | 55 | { |