@@ -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) { |
@@ -138,7 +138,7 @@ |
||
138 | 138 | * Get the current value of an option |
139 | 139 | * |
140 | 140 | * @param string $key The key of the option to get |
141 | - * @return mixed The value of the specified option |
|
141 | + * @return string The value of the specified option |
|
142 | 142 | */ |
143 | 143 | abstract public function getOption($key); |
144 | 144 |
@@ -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])) { |
@@ -766,7 +766,7 @@ |
||
766 | 766 | /** |
767 | 767 | * Returns the current logged in user |
768 | 768 | * |
769 | - * @return Member|null |
|
769 | + * @return DataObject|null |
|
770 | 770 | */ |
771 | 771 | public static function currentUser() { |
772 | 772 | $id = Member::currentUserID(); |
@@ -152,7 +152,7 @@ discard block |
||
152 | 152 | * @param string $arg Optional argument (e.g. a permissions for a specific page) |
153 | 153 | * @param bool $strict Use "strict" checking (which means a permission |
154 | 154 | * will be granted if the key does not exist at all)? |
155 | - * @return int|bool The ID of the permission record if the permission |
|
155 | + * @return boolean The ID of the permission record if the permission |
|
156 | 156 | * exists; FALSE otherwise. If "strict" checking is |
157 | 157 | * disabled, TRUE will be returned if the permission does not exist at all. |
158 | 158 | */ |
@@ -656,7 +656,7 @@ discard block |
||
656 | 656 | * Recursively traverse the nested list of declared permissions and create |
657 | 657 | * a linear list. |
658 | 658 | * |
659 | - * @param aeeay $declared Nested structure of permissions. |
|
659 | + * @param boolean $declared Nested structure of permissions. |
|
660 | 660 | * @param $list List of permissions in the structure. The result will be |
661 | 661 | * written to this array. |
662 | 662 | */ |
@@ -744,7 +744,7 @@ discard block |
||
744 | 744 | /** |
745 | 745 | * Get permissions |
746 | 746 | * |
747 | - * @return array Associative array of permissions in this permission |
|
747 | + * @return string Associative array of permissions in this permission |
|
748 | 748 | * group. The array indicies are the permission codes as |
749 | 749 | * used in {@link Permission::check()}. The value is |
750 | 750 | * suitable for using in an interface. |
@@ -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) { |
@@ -76,6 +76,9 @@ discard block |
||
76 | 76 | return $this->token; |
77 | 77 | } |
78 | 78 | |
79 | + /** |
|
80 | + * @param string $token |
|
81 | + */ |
|
79 | 82 | public function setToken($token) { |
80 | 83 | $this->token = $token; |
81 | 84 | } |
@@ -92,7 +95,7 @@ discard block |
||
92 | 95 | /** |
93 | 96 | * Creates a new random token and hashes it using the |
94 | 97 | * member information |
95 | - * @param Member The logged in user |
|
98 | + * @param Member Member logged in user |
|
96 | 99 | * @return string The hash to be stored in the database |
97 | 100 | */ |
98 | 101 | public function getNewHash(Member $member){ |
@@ -106,7 +109,7 @@ discard block |
||
106 | 109 | * The device is assigned a globally unique device ID |
107 | 110 | * The returned login hash stores the hashed token in the |
108 | 111 | * database, for this device and this member |
109 | - * @param Member The logged in user |
|
112 | + * @param Member Member logged in user |
|
110 | 113 | * @return RememberLoginHash The generated login hash |
111 | 114 | */ |
112 | 115 | public static function generate(Member $member) { |
@@ -149,6 +152,7 @@ discard block |
||
149 | 152 | * Deletes existing tokens for this member |
150 | 153 | * if logout_across_devices is true, all tokens are deleted, otherwise |
151 | 154 | * only the token for the provided device ID will be removed |
155 | + * @param string $alcDevice |
|
152 | 156 | */ |
153 | 157 | public static function clear(Member $member, $alcDevice = null) { |
154 | 158 | if(!$member->exists()) { return; } |
@@ -44,6 +44,7 @@ discard block |
||
44 | 44 | * Create a new DataQuery. |
45 | 45 | * |
46 | 46 | * @param String The name of the DataObject class that you wish to query |
47 | + * @param string $dataClass |
|
47 | 48 | */ |
48 | 49 | public function __construct($dataClass) { |
49 | 50 | $this->dataClass = $dataClass; |
@@ -166,7 +167,7 @@ discard block |
||
166 | 167 | /** |
167 | 168 | * Ensure that the query is ready to execute. |
168 | 169 | * |
169 | - * @param array|null $queriedColumns Any columns to filter the query by |
|
170 | + * @param string[] $queriedColumns Any columns to filter the query by |
|
170 | 171 | * @return SQLSelect The finalised sql query |
171 | 172 | */ |
172 | 173 | public function getFinalisedQuery($queriedColumns = null) { |
@@ -641,7 +642,7 @@ discard block |
||
641 | 642 | * mappings to the query object state. This has to be called |
642 | 643 | * in any overloaded {@link SearchFilter->apply()} methods manually. |
643 | 644 | * |
644 | - * @param String|array $relation The array/dot-syntax relation to follow |
|
645 | + * @param string $relation The array/dot-syntax relation to follow |
|
645 | 646 | * @param bool $linearOnly Set to true to restrict to linear relations only. Set this |
646 | 647 | * if this relation will be used for sorting, and should not include duplicate rows. |
647 | 648 | * @return The model class of the related item |
@@ -917,6 +918,7 @@ discard block |
||
917 | 918 | |
918 | 919 | /** |
919 | 920 | * Set an arbitrary query parameter, that can be used by decorators to add additional meta-data to the query. |
921 | + * @param string $key |
|
920 | 922 | */ |
921 | 923 | public function getQueryParam($key) { |
922 | 924 | if(isset($this->queryParams[$key])) return $this->queryParams[$key]; |
@@ -949,6 +951,9 @@ discard block |
||
949 | 951 | */ |
950 | 952 | protected $whereQuery; |
951 | 953 | |
954 | + /** |
|
955 | + * @param string $connective |
|
956 | + */ |
|
952 | 957 | public function __construct(DataQuery $base, $connective) { |
953 | 958 | $this->dataClass = $base->dataClass; |
954 | 959 | $this->query = $base->query; |
@@ -958,6 +963,9 @@ discard block |
||
958 | 963 | $base->where($this); |
959 | 964 | } |
960 | 965 | |
966 | + /** |
|
967 | + * @param string $filter |
|
968 | + */ |
|
961 | 969 | public function where($filter) { |
962 | 970 | if($filter) { |
963 | 971 | $this->whereQuery->addWhere($filter); |