@@ -409,7 +409,7 @@ |
||
| 409 | 409 | * |
| 410 | 410 | * @param DataObjectInterface $record |
| 411 | 411 | * |
| 412 | - * @return boolean |
|
| 412 | + * @return false|null |
|
| 413 | 413 | */ |
| 414 | 414 | public function saveInto(DataObjectInterface $record) { |
| 415 | 415 | if(!$this->isSaveable()) { |
@@ -732,6 +732,9 @@ discard block |
||
| 732 | 732 | return $result; |
| 733 | 733 | } |
| 734 | 734 | |
| 735 | + /** |
|
| 736 | + * @param string $mode |
|
| 737 | + */ |
|
| 735 | 738 | protected function _get($dir, $mode, $tags = array()) |
| 736 | 739 | { |
| 737 | 740 | if (!is_dir($dir)) { |
@@ -819,6 +822,7 @@ discard block |
||
| 819 | 822 | /** |
| 820 | 823 | * Compute & return the expire time |
| 821 | 824 | * |
| 825 | + * @param integer $lifetime |
|
| 822 | 826 | * @return int expire time (unix timestamp) |
| 823 | 827 | */ |
| 824 | 828 | protected function _expireTime($lifetime) |
@@ -625,6 +625,9 @@ discard block |
||
| 625 | 625 | } |
| 626 | 626 | |
| 627 | 627 | |
| 628 | + /** |
|
| 629 | + * @param string $fileID |
|
| 630 | + */ |
|
| 628 | 631 | public function getOriginalFilename($fileID) { |
| 629 | 632 | return parent::getOriginalFilename($fileID); |
| 630 | 633 | } |
@@ -633,6 +636,9 @@ discard block |
||
| 633 | 636 | return parent::removeVariant($fileID); |
| 634 | 637 | } |
| 635 | 638 | |
| 639 | + /** |
|
| 640 | + * @param null|string $variant |
|
| 641 | + */ |
|
| 636 | 642 | public function getDefaultConflictResolution($variant) { |
| 637 | 643 | return parent::getDefaultConflictResolution($variant); |
| 638 | 644 | } |
@@ -619,6 +619,11 @@ |
||
| 619 | 619 | 'ObjectTest_Extending_Extension' |
| 620 | 620 | ); |
| 621 | 621 | |
| 622 | + /** |
|
| 623 | + * @param integer $first |
|
| 624 | + * @param integer $second |
|
| 625 | + * @param integer $third |
|
| 626 | + */ |
|
| 622 | 627 | public function getResults(&$first, &$second, &$third) { |
| 623 | 628 | // Before extending should be invoked second |
| 624 | 629 | $this->beforeExtending('updateResult', function(&$first, &$second, &$third) { |
@@ -114,7 +114,7 @@ discard block |
||
| 114 | 114 | * Set a different instance than {@link Upload_Validator} |
| 115 | 115 | * for this upload session. |
| 116 | 116 | * |
| 117 | - * @param object $validator |
|
| 117 | + * @param Upload_Validator $validator |
|
| 118 | 118 | */ |
| 119 | 119 | public function setValidator($validator) { |
| 120 | 120 | $this->validator = $validator; |
@@ -363,7 +363,7 @@ discard block |
||
| 363 | 363 | /** |
| 364 | 364 | * Determines wether previous operations caused an error. |
| 365 | 365 | * |
| 366 | - * @return boolean |
|
| 366 | + * @return integer |
|
| 367 | 367 | */ |
| 368 | 368 | public function isError() { |
| 369 | 369 | return (count($this->errors)); |
@@ -118,6 +118,7 @@ discard block |
||
| 118 | 118 | * or TabSet.Tab.Subtab. |
| 119 | 119 | * This function will create any missing tabs. |
| 120 | 120 | * @param array $fields An array of {@link FormField} objects. |
| 121 | + * @param string $insertBefore |
|
| 121 | 122 | */ |
| 122 | 123 | public function addFieldsToTab($tabName, $fields, $insertBefore = null) { |
| 123 | 124 | $this->flushFieldsCache(); |
@@ -157,7 +158,7 @@ discard block |
||
| 157 | 158 | * Removes a number of fields from a Tab/TabSet within this FieldList. |
| 158 | 159 | * |
| 159 | 160 | * @param string $tabName The name of the Tab or TabSet field |
| 160 | - * @param array $fields A list of fields, e.g. array('Name', 'Email') |
|
| 161 | + * @param string[] $fields A list of fields, e.g. array('Name', 'Email') |
|
| 161 | 162 | */ |
| 162 | 163 | public function removeFieldsFromTab($tabName, $fields) { |
| 163 | 164 | $this->flushFieldsCache(); |
@@ -440,6 +441,7 @@ discard block |
||
| 440 | 441 | |
| 441 | 442 | /** |
| 442 | 443 | * Handler method called before the FieldList is going to be manipulated. |
| 444 | + * @param FormField $item |
|
| 443 | 445 | */ |
| 444 | 446 | protected function onBeforeInsert($item) { |
| 445 | 447 | $this->flushFieldsCache(); |
@@ -512,6 +514,7 @@ discard block |
||
| 512 | 514 | * Transform this FieldList with a given tranform method, |
| 513 | 515 | * e.g. $this->transform(new ReadonlyTransformation()) |
| 514 | 516 | * |
| 517 | + * @param ReadonlyTransformation $trans |
|
| 515 | 518 | * @return FieldList |
| 516 | 519 | */ |
| 517 | 520 | public function transform($trans) { |
@@ -531,6 +534,9 @@ discard block |
||
| 531 | 534 | else return $this; |
| 532 | 535 | } |
| 533 | 536 | |
| 537 | + /** |
|
| 538 | + * @param CompositeField $field |
|
| 539 | + */ |
|
| 534 | 540 | public function setContainerField($field) { |
| 535 | 541 | $this->containerField = $field; |
| 536 | 542 | return $this; |
@@ -549,6 +555,7 @@ discard block |
||
| 549 | 555 | * Transform the named field into a readonly feld. |
| 550 | 556 | * |
| 551 | 557 | * @param string|FormField |
| 558 | + * @param string $field |
|
| 552 | 559 | */ |
| 553 | 560 | public function makeFieldReadonly($field) { |
| 554 | 561 | $fieldName = ($field instanceof FormField) ? $field->getName() : $field; |
@@ -598,6 +605,7 @@ discard block |
||
| 598 | 605 | * the children collection. Doesn't work recursively. |
| 599 | 606 | * |
| 600 | 607 | * @param string|FormField |
| 608 | + * @param string $field |
|
| 601 | 609 | * @return int Position in children collection (first position starts with 0). Returns FALSE if the field can't |
| 602 | 610 | * be found. |
| 603 | 611 | */ |
@@ -645,7 +653,7 @@ discard block |
||
| 645 | 653 | * Support function for backwards compatibility purposes. |
| 646 | 654 | * Caution: Volatile API, might be removed in 3.1 or later. |
| 647 | 655 | * |
| 648 | - * @param String $tabname Path to a tab, e.g. "Root.Content.Main" |
|
| 656 | + * @param string $name Path to a tab, e.g. "Root.Content.Main" |
|
| 649 | 657 | * @return String Rewritten path, based on {@link tabPathRewrites} |
| 650 | 658 | */ |
| 651 | 659 | protected function rewriteTabPath($name) { |
@@ -185,6 +185,7 @@ discard block |
||
| 185 | 185 | |
| 186 | 186 | /** |
| 187 | 187 | * @param String |
| 188 | + * @param string $class |
|
| 188 | 189 | */ |
| 189 | 190 | public function setItemRequestClass($class) { |
| 190 | 191 | $this->itemRequestClass = $class; |
@@ -292,6 +293,9 @@ discard block |
||
| 292 | 293 | parent::__construct(); |
| 293 | 294 | } |
| 294 | 295 | |
| 296 | + /** |
|
| 297 | + * @param string $action |
|
| 298 | + */ |
|
| 295 | 299 | public function Link($action = null) { |
| 296 | 300 | return Controller::join_links($this->gridField->Link('item'), |
| 297 | 301 | $this->record->ID ? $this->record->ID : 'new', $action); |
@@ -320,6 +324,9 @@ discard block |
||
| 320 | 324 | } |
| 321 | 325 | } |
| 322 | 326 | |
| 327 | + /** |
|
| 328 | + * @param SS_HTTPRequest $request |
|
| 329 | + */ |
|
| 323 | 330 | public function edit($request) { |
| 324 | 331 | $controller = $this->getToplevelController(); |
| 325 | 332 | $form = $this->ItemEditForm($this->gridField, $request); |
@@ -515,6 +522,9 @@ discard block |
||
| 515 | 522 | return $c; |
| 516 | 523 | } |
| 517 | 524 | |
| 525 | + /** |
|
| 526 | + * @return string |
|
| 527 | + */ |
|
| 518 | 528 | protected function getBackLink(){ |
| 519 | 529 | // TODO Coupling with CMS |
| 520 | 530 | $backlink = ''; |
@@ -616,6 +626,9 @@ discard block |
||
| 616 | 626 | } |
| 617 | 627 | } |
| 618 | 628 | |
| 629 | + /** |
|
| 630 | + * @param integer $errorCode |
|
| 631 | + */ |
|
| 619 | 632 | public function httpError($errorCode, $errorMessage = null) { |
| 620 | 633 | $controller = $this->getToplevelController(); |
| 621 | 634 | return $controller->httpError($errorCode, $errorMessage); |
@@ -50,14 +50,7 @@ discard block |
||
| 50 | 50 | /** |
| 51 | 51 | * Gets a field from this object. |
| 52 | 52 | * |
| 53 | - * @param string $field |
|
| 54 | - * |
|
| 55 | - * If the value is an object but not an instance of |
|
| 56 | - * ViewableData, it will be converted recursively to an |
|
| 57 | - * ArrayData. |
|
| 58 | - * |
|
| 59 | - * If the value is an associative array, it will likewise be |
|
| 60 | - * converted recursively to an ArrayData. |
|
| 53 | + * @param string $f |
|
| 61 | 54 | */ |
| 62 | 55 | public function getField($f) { |
| 63 | 56 | $value = $this->array[$f]; |
@@ -83,6 +76,7 @@ discard block |
||
| 83 | 76 | * Check array to see if field isset |
| 84 | 77 | * |
| 85 | 78 | * @param string Field Key |
| 79 | + * @param string $f |
|
| 86 | 80 | * @return bool |
| 87 | 81 | */ |
| 88 | 82 | public function hasField($f) { |
@@ -27,6 +27,9 @@ |
||
| 27 | 27 | return $this->can(__FUNCTION__, $member, $context); |
| 28 | 28 | } |
| 29 | 29 | |
| 30 | + /** |
|
| 31 | + * @param string $perm |
|
| 32 | + */ |
|
| 30 | 33 | public function can($perm, $member = null, $context = array()) { |
| 31 | 34 | $perms = [ |
| 32 | 35 | "PERM_{$perm}", |