@@ -213,7 +213,7 @@ |
||
| 213 | 213 | /** |
| 214 | 214 | * Returns the value to be validated. |
| 215 | 215 | * This methid is required by IValidatable interface. |
| 216 | - * @return mixed the value of the property to be validated. |
|
| 216 | + * @return string the value of the property to be validated. |
|
| 217 | 217 | */ |
| 218 | 218 | public function getValidationPropertyValue() |
| 219 | 219 | { |
@@ -164,6 +164,7 @@ |
||
| 164 | 164 | |
| 165 | 165 | /** |
| 166 | 166 | * @param TListControl control to validate |
| 167 | + * @param TControl $control |
|
| 167 | 168 | * @return array number of selected values and its values. |
| 168 | 169 | */ |
| 169 | 170 | protected function getSelection($control) |
@@ -281,6 +281,7 @@ |
||
| 281 | 281 | * controls be added into the collection. |
| 282 | 282 | * @param integer the speicified position. |
| 283 | 283 | * @param mixed new item |
| 284 | + * @param TWizardStep $item |
|
| 284 | 285 | * @throws TInvalidDataTypeException if the item to be inserted is neither a string nor a TControl. |
| 285 | 286 | */ |
| 286 | 287 | public function insertAt($index,$item) |
@@ -231,7 +231,7 @@ discard block |
||
| 231 | 231 | * into cache if needed. |
| 232 | 232 | * This method should only be used by framework developers. |
| 233 | 233 | * @param boolean whether the viewstate should be saved |
| 234 | - * @return array the collection of the control state (including its children's state). |
|
| 234 | + * @return string the collection of the control state (including its children's state). |
|
| 235 | 235 | */ |
| 236 | 236 | protected function &saveStateRecursive($needViewState=true) |
| 237 | 237 | { |
@@ -327,6 +327,7 @@ discard block |
||
| 327 | 327 | * Sets the prefix of the cache key. |
| 328 | 328 | * This method is used internally by {@link TTemplate}. |
| 329 | 329 | * @param string key prefix |
| 330 | + * @param string $value |
|
| 330 | 331 | */ |
| 331 | 332 | public function setCacheKeyPrefix($value) |
| 332 | 333 | { |
@@ -445,6 +446,7 @@ discard block |
||
| 445 | 446 | * The checking result should be saved by setting {@link TOutputCacheCheckDependencyEventParameter::setIsValid IsValid} |
| 446 | 447 | * property of the event parameter (which defaults to true). |
| 447 | 448 | * @param TOutputCacheCheckDependencyEventParameter event parameter |
| 449 | + * @param TOutputCacheCheckDependencyEventParameter $param |
|
| 448 | 450 | */ |
| 449 | 451 | public function onCheckDependency($param) |
| 450 | 452 | { |
@@ -458,6 +460,7 @@ discard block |
||
| 458 | 460 | * The value set in {@link TOutputCacheCalculateKeyEventParameter::setCacheKey CacheKey} of |
| 459 | 461 | * this event parameter will be appended to the default key calculation scheme. |
| 460 | 462 | * @param TOutputCacheCalculateKeyEventParameter event parameter |
| 463 | + * @param TOutputCacheCalculateKeyEventParameter $param |
|
| 461 | 464 | */ |
| 462 | 465 | public function onCalculateKey($param) |
| 463 | 466 | { |
@@ -333,6 +333,7 @@ discard block |
||
| 333 | 333 | |
| 334 | 334 | /** |
| 335 | 335 | * @param integer the zero-based index of the current page |
| 336 | + * @param integer $value |
|
| 336 | 337 | * @throws TInvalidDataValueException if the value is less than 0 |
| 337 | 338 | */ |
| 338 | 339 | protected function setCurrentPageIndex($value) |
@@ -352,6 +353,7 @@ discard block |
||
| 352 | 353 | |
| 353 | 354 | /** |
| 354 | 355 | * @param integer number of pages of data items available |
| 356 | + * @param integer $value |
|
| 355 | 357 | * @throws TInvalidDataValueException if the value is less than 0 |
| 356 | 358 | */ |
| 357 | 359 | protected function setPageCount($value) |
@@ -446,6 +448,9 @@ discard block |
||
| 446 | 448 | * @param string caption of the button. |
| 447 | 449 | * @param string CommandName corresponding to the OnCommand event of the button. |
| 448 | 450 | * @param string CommandParameter corresponding to the OnCommand event of the button |
| 451 | + * @param TPagerButtonType $buttonType |
|
| 452 | + * @param boolean $enabled |
|
| 453 | + * @param string $commandName |
|
| 449 | 454 | * @return mixed the button instance |
| 450 | 455 | */ |
| 451 | 456 | protected function createPagerButton($buttonType,$enabled,$text,$commandName,$commandParameter) |
@@ -660,6 +665,7 @@ discard block |
||
| 660 | 665 | /** |
| 661 | 666 | * This event is raised when page index is changed due to a page button click. |
| 662 | 667 | * @param TPagerPageChangedEventParameter event parameter |
| 668 | + * @param TPagerPageChangedEventParameter $param |
|
| 663 | 669 | */ |
| 664 | 670 | public function onPageIndexChanged($param) |
| 665 | 671 | { |
@@ -96,6 +96,7 @@ discard block |
||
| 96 | 96 | |
| 97 | 97 | /** |
| 98 | 98 | * @param boolean true to perform strict comparison (i.e. strictly less than max and/or strictly greater than min). |
| 99 | + * @param boolean $value |
|
| 99 | 100 | */ |
| 100 | 101 | public function setStrictComparison($value) |
| 101 | 102 | { |
@@ -191,6 +192,7 @@ discard block |
||
| 191 | 192 | /** |
| 192 | 193 | * Determine if the value is within the integer range. |
| 193 | 194 | * @param string value to validate true |
| 195 | + * @param string $value |
|
| 194 | 196 | * @return boolean true if within integer range. |
| 195 | 197 | */ |
| 196 | 198 | protected function isValidInteger($value) |
@@ -220,6 +222,7 @@ discard block |
||
| 220 | 222 | /** |
| 221 | 223 | * Determine if the value is within the specified float range. |
| 222 | 224 | * @param string value to validate |
| 225 | + * @param string $value |
|
| 223 | 226 | * @return boolean true if within range. |
| 224 | 227 | */ |
| 225 | 228 | protected function isValidFloat($value) |
@@ -240,6 +243,7 @@ discard block |
||
| 240 | 243 | * Determine if the date is within the specified range. |
| 241 | 244 | * Uses pradoParseDate and strtotime to get the date from string. |
| 242 | 245 | * @param string date as string to validate |
| 246 | + * @param string $value |
|
| 243 | 247 | * @return boolean true if within range. |
| 244 | 248 | */ |
| 245 | 249 | protected function isValidDate($value) |
@@ -275,6 +279,7 @@ discard block |
||
| 275 | 279 | * Compare the string with a minimum and a maxiumum value. |
| 276 | 280 | * Uses strcmp for comparision. |
| 277 | 281 | * @param string value to compare with. |
| 282 | + * @param string $value |
|
| 278 | 283 | * @return boolean true if the string is within range. |
| 279 | 284 | */ |
| 280 | 285 | protected function isValidString($value) |
@@ -292,6 +297,7 @@ discard block |
||
| 292 | 297 | |
| 293 | 298 | /** |
| 294 | 299 | * @param string string for comparision |
| 300 | + * @param string $value |
|
| 295 | 301 | * @return boolean true if min and max string length are satisfied. |
| 296 | 302 | */ |
| 297 | 303 | protected function isValidStringLength($value) |
@@ -132,6 +132,7 @@ |
||
| 132 | 132 | |
| 133 | 133 | /** |
| 134 | 134 | * @param float rating value |
| 135 | + * @param double $rating |
|
| 135 | 136 | * @return int rating as integer |
| 136 | 137 | */ |
| 137 | 138 | protected function getRatingIndex($rating) |
@@ -464,6 +464,7 @@ discard block |
||
| 464 | 464 | * This method invokes {@link createItem} to create a new repeater item. |
| 465 | 465 | * @param integer zero-based item index. |
| 466 | 466 | * @param TListItemType item type |
| 467 | + * @param integer $itemIndex |
|
| 467 | 468 | * @return TControl the created item, null if item is not created |
| 468 | 469 | */ |
| 469 | 470 | private function createItemInternal($itemIndex,$itemType) |
@@ -485,6 +486,7 @@ discard block |
||
| 485 | 486 | * @param integer zero-based item index. |
| 486 | 487 | * @param TListItemType item type |
| 487 | 488 | * @param mixed data to be associated with the item |
| 489 | + * @param integer $itemIndex |
|
| 488 | 490 | * @return TControl the created item, null if item is not created |
| 489 | 491 | */ |
| 490 | 492 | private function createItemWithDataInternal($itemIndex,$itemType,$dataItem) |
@@ -718,6 +720,7 @@ discard block |
||
| 718 | 720 | * If you override this method, be sure to call parent's implementation |
| 719 | 721 | * so that event handlers have chance to respond to the event. |
| 720 | 722 | * @param TRepeaterItemEventParameter event parameter |
| 723 | + * @param TRepeaterItemEventParameter $param |
|
| 721 | 724 | */ |
| 722 | 725 | public function onItemCreated($param) |
| 723 | 726 | { |
@@ -732,6 +735,7 @@ discard block |
||
| 732 | 735 | * If you override this method, be sure to call parent's implementation |
| 733 | 736 | * so that event handlers have chance to respond to the event. |
| 734 | 737 | * @param TRepeaterItemEventParameter event parameter |
| 738 | + * @param TRepeaterItemEventParameter $param |
|
| 735 | 739 | */ |
| 736 | 740 | public function onItemDataBound($param) |
| 737 | 741 | { |
@@ -751,6 +755,7 @@ discard block |
||
| 751 | 755 | * Be sure to call parent's implementation so that |
| 752 | 756 | * event handlers have chance to respond to the event. |
| 753 | 757 | * @param TRepeaterCommandEventParameter event parameter |
| 758 | + * @param TRepeaterCommandEventParameter $param |
|
| 754 | 759 | */ |
| 755 | 760 | public function onItemCommand($param) |
| 756 | 761 | { |
@@ -765,6 +770,7 @@ discard block |
||
| 765 | 770 | * Otherwise, an exception will be raised. |
| 766 | 771 | * @param mixed data item |
| 767 | 772 | * @param mixed field name |
| 773 | + * @param string $field |
|
| 768 | 774 | * @return mixed data value at the specified field |
| 769 | 775 | * @throws TInvalidDataValueException if the data is invalid |
| 770 | 776 | */ |
@@ -796,6 +802,7 @@ discard block |
||
| 796 | 802 | /** |
| 797 | 803 | * Constructor. |
| 798 | 804 | * @param TControl repeater item related with the corresponding event |
| 805 | + * @param TControl $item |
|
| 799 | 806 | */ |
| 800 | 807 | public function __construct($item) |
| 801 | 808 | { |
@@ -49,6 +49,7 @@ discard block |
||
| 49 | 49 | * @param TRepeatInfo repeat information |
| 50 | 50 | * @param string item type |
| 51 | 51 | * @param integer zero-based index of the item being rendered |
| 52 | + * @return void |
|
| 52 | 53 | */ |
| 53 | 54 | public function renderItem($writer,$repeatInfo,$itemType,$index); |
| 54 | 55 | } |
@@ -218,6 +219,7 @@ discard block |
||
| 218 | 219 | * Renders contents in raw format. |
| 219 | 220 | * @param THtmlWriter writer for the rendering purpose |
| 220 | 221 | * @param IRepeatInfoUser repeat information user |
| 222 | + * @param IRepeatInfoUser $user |
|
| 221 | 223 | */ |
| 222 | 224 | protected function renderRawContents($writer,$user) |
| 223 | 225 | { |
@@ -241,6 +243,7 @@ discard block |
||
| 241 | 243 | * Renders contents in horizontal repeat direction. |
| 242 | 244 | * @param THtmlWriter writer for the rendering purpose |
| 243 | 245 | * @param IRepeatInfoUser repeat information user |
| 246 | + * @param IRepeatInfoUser $user |
|
| 244 | 247 | */ |
| 245 | 248 | protected function renderHorizontalContents($writer,$user) |
| 246 | 249 | { |
@@ -323,6 +326,7 @@ discard block |
||
| 323 | 326 | * Renders contents in veritcal repeat direction. |
| 324 | 327 | * @param THtmlWriter writer for the rendering purpose |
| 325 | 328 | * @param IRepeatInfoUser repeat information user |
| 329 | + * @param IRepeatInfoUser $user |
|
| 326 | 330 | */ |
| 327 | 331 | protected function renderVerticalContents($writer,$user) |
| 328 | 332 | { |
@@ -456,6 +460,8 @@ discard block |
||
| 456 | 460 | * @param boolean whether to render using table layout |
| 457 | 461 | * @param integer number of columns to be rendered |
| 458 | 462 | * @param boolean if a line break is needed at the end |
| 463 | + * @param boolean $tableLayout |
|
| 464 | + * @param boolean $needBreak |
|
| 459 | 465 | */ |
| 460 | 466 | protected function renderHeader($writer,$user,$tableLayout,$columns,$needBreak) |
| 461 | 467 | { |
@@ -489,6 +495,7 @@ discard block |
||
| 489 | 495 | * @param IRepeatInfoUser repeat information user |
| 490 | 496 | * @param boolean whether to render using table layout |
| 491 | 497 | * @param integer number of columns to be rendered |
| 498 | + * @param boolean $tableLayout |
|
| 492 | 499 | */ |
| 493 | 500 | protected function renderFooter($writer,$user,$tableLayout,$columns) |
| 494 | 501 | { |