@@ -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); |
@@ -392,7 +392,7 @@ |
||
392 | 392 | /** |
393 | 393 | * Get location of all editor.css files |
394 | 394 | * |
395 | - * @return array |
|
395 | + * @return string[] |
|
396 | 396 | */ |
397 | 397 | protected function getEditorCSS() { |
398 | 398 | $editor = array(); |
@@ -470,11 +470,17 @@ discard block |
||
470 | 470 | |
471 | 471 | protected $extraConfigSources = array(); |
472 | 472 | |
473 | + /** |
|
474 | + * @param string $class |
|
475 | + */ |
|
473 | 476 | public function extraConfigSourcesChanged($class) { |
474 | 477 | unset($this->extraConfigSources[$class]); |
475 | 478 | $this->cache->clean("__{$class}"); |
476 | 479 | } |
477 | 480 | |
481 | + /** |
|
482 | + * @param integer $sourceOptions |
|
483 | + */ |
|
478 | 484 | protected function getUncached($class, $name, $sourceOptions, &$result, $suppress, &$tags) { |
479 | 485 | $tags[] = "__{$class}"; |
480 | 486 | $tags[] = "__{$class}__{$name}"; |
@@ -602,7 +608,7 @@ discard block |
||
602 | 608 | * replace the current array value, you'll need to call remove first. |
603 | 609 | * |
604 | 610 | * @param $class string - The class to update a configuration value for |
605 | - * @param $name string - The configuration property name to update |
|
611 | + * @param string $name string - The configuration property name to update |
|
606 | 612 | * @param $value any - The value to update with |
607 | 613 | * |
608 | 614 | * Arrays are recursively merged into current configuration as "latest" - for associative arrays the passed value |
@@ -647,15 +653,6 @@ discard block |
||
647 | 653 | * |
648 | 654 | * @param string $class The class to remove a configuration value from |
649 | 655 | * @param string $name The configuration name |
650 | - * @param mixed $key An optional key to filter against. |
|
651 | - * If referenced config value is an array, only members of that array that match this key will be removed |
|
652 | - * Must also match value if provided to be removed |
|
653 | - * @param mixed $value And optional value to filter against. |
|
654 | - * If referenced config value is an array, only members of that array that match this value will be removed |
|
655 | - * If referenced config value is not an array, value will be removed only if it matches this argument |
|
656 | - * Must also match key if provided and referenced config value is an array to be removed |
|
657 | - * |
|
658 | - * Matching is always by "==", not by "===" |
|
659 | 656 | */ |
660 | 657 | public function remove($class, $name /*,$key = null*/ /*,$value = null*/) { |
661 | 658 | $argc = func_num_args(); |
@@ -734,6 +731,10 @@ discard block |
||
734 | 731 | $this->cache = $cloned; |
735 | 732 | } |
736 | 733 | |
734 | + /** |
|
735 | + * @param integer $key |
|
736 | + * @param integer $val |
|
737 | + */ |
|
737 | 738 | public function set($key, $val, $tags = array()) { |
738 | 739 | // Find an index to set at |
739 | 740 | $replacing = null; |
@@ -769,6 +770,11 @@ discard block |
||
769 | 770 | return $this->miss ? ($this->hit / $this->miss) : 0; |
770 | 771 | } |
771 | 772 | |
773 | + /** |
|
774 | + * @param integer $key |
|
775 | + * |
|
776 | + * @return boolean |
|
777 | + */ |
|
772 | 778 | public function get($key) { |
773 | 779 | if (isset($this->indexing[$key])) { |
774 | 780 | $this->hit++; |
@@ -782,6 +788,9 @@ discard block |
||
782 | 788 | return false; |
783 | 789 | } |
784 | 790 | |
791 | + /** |
|
792 | + * @param string $tag |
|
793 | + */ |
|
785 | 794 | public function clean($tag = null) { |
786 | 795 | if ($tag) { |
787 | 796 | foreach ($this->cache as $i => $v) { |
@@ -813,6 +822,10 @@ discard block |
||
813 | 822 | $this->cache = array(); |
814 | 823 | } |
815 | 824 | |
825 | + /** |
|
826 | + * @param integer $key |
|
827 | + * @param integer $val |
|
828 | + */ |
|
816 | 829 | public function set($key, $val, $tags = array()) { |
817 | 830 | foreach($tags as $t) { |
818 | 831 | if(!isset($this->tags[$t])) { |
@@ -831,6 +844,11 @@ discard block |
||
831 | 844 | return $this->miss ? ($this->hit / $this->miss) : 0; |
832 | 845 | } |
833 | 846 | |
847 | + /** |
|
848 | + * @param integer $key |
|
849 | + * |
|
850 | + * @return boolean |
|
851 | + */ |
|
834 | 852 | public function get($key) { |
835 | 853 | if(isset($this->cache[$key])) { |
836 | 854 | ++$this->hit; |
@@ -841,6 +859,9 @@ discard block |
||
841 | 859 | return false; |
842 | 860 | } |
843 | 861 | |
862 | + /** |
|
863 | + * @param string $tag |
|
864 | + */ |
|
844 | 865 | public function clean($tag = null) { |
845 | 866 | if($tag) { |
846 | 867 | if(isset($this->tags[$tag])) { |
@@ -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) { |
@@ -59,7 +59,7 @@ |
||
59 | 59 | * Returns a <select> tag containing all the appropriate <option> tags |
60 | 60 | * |
61 | 61 | * @param array $properties |
62 | - * @return string |
|
62 | + * @return DBField |
|
63 | 63 | */ |
64 | 64 | public function Field($properties = array()) { |
65 | 65 | $properties = array_merge($properties, array( |
@@ -36,6 +36,10 @@ discard block |
||
36 | 36 | */ |
37 | 37 | protected $fieldCurrency = null; |
38 | 38 | |
39 | + /** |
|
40 | + * @param string $name |
|
41 | + * @param string $title |
|
42 | + */ |
|
39 | 43 | public function __construct($name, $title = null, $value = "") { |
40 | 44 | // naming with underscores to prevent values from actually being saved somewhere |
41 | 45 | $this->fieldAmount = new NumericField("{$name}[Amount]", _t('MoneyField.FIELDLABELAMOUNT', 'Amount')); |
@@ -46,7 +50,7 @@ discard block |
||
46 | 50 | |
47 | 51 | /** |
48 | 52 | * @param array |
49 | - * @return HTMLText |
|
53 | + * @return DBField |
|
50 | 54 | */ |
51 | 55 | public function Field($properties = array()) { |
52 | 56 | return DBField::create_field('HTMLText', |
@@ -139,6 +143,7 @@ discard block |
||
139 | 143 | /** |
140 | 144 | * @todo Implement removal of readonly state with $bool=false |
141 | 145 | * @todo Set readonly state whenever field is recreated, e.g. in setAllowedCurrencies() |
146 | + * @param boolean $bool |
|
142 | 147 | */ |
143 | 148 | public function setReadonly($bool) { |
144 | 149 | parent::setReadonly($bool); |