@@ -41,6 +41,7 @@ |
||
41 | 41 | * Useful for keeping a decorator/paginated list configuration intact while modifying |
42 | 42 | * the underlying list. |
43 | 43 | * |
44 | + * @param SS_List $list |
|
44 | 45 | * @return SS_List |
45 | 46 | */ |
46 | 47 | public function setList($list) |
@@ -162,6 +162,7 @@ discard block |
||
162 | 162 | * currently viewing) is included in the URL. |
163 | 163 | * |
164 | 164 | * @inheritdoc |
165 | + * @param string $action |
|
165 | 166 | */ |
166 | 167 | public function Link($action = null) |
167 | 168 | { |
@@ -441,7 +442,7 @@ discard block |
||
441 | 442 | /** |
442 | 443 | * Generate a CSV import form for a single {@link DataObject} subclass. |
443 | 444 | * |
444 | - * @return Form|false |
|
445 | + * @return Form |
|
445 | 446 | */ |
446 | 447 | public function ImportForm() |
447 | 448 | { |
@@ -33,6 +33,10 @@ discard block |
||
33 | 33 | */ |
34 | 34 | protected $underlay; |
35 | 35 | |
36 | + /** |
|
37 | + * @param ViewableData $item |
|
38 | + * @param ViewableData $inheritedScope |
|
39 | + */ |
|
36 | 40 | public function __construct($item, $overlay = null, $underlay = null, $inheritedScope = null) |
37 | 41 | { |
38 | 42 | parent::__construct($item, $inheritedScope); |
@@ -65,6 +69,9 @@ discard block |
||
65 | 69 | $this->underlay = $underlay ? $underlay : array(); |
66 | 70 | } |
67 | 71 | |
72 | + /** |
|
73 | + * @param string $variableMethod |
|
74 | + */ |
|
68 | 75 | protected function createCallableArray(&$extraArray, $interfaceToQuery, $variableMethod, $createObject = false) |
69 | 76 | { |
70 | 77 | $implementers = ClassInfo::implementorsOf($interfaceToQuery); |
@@ -136,6 +136,9 @@ discard block |
||
136 | 136 | return Injector::inst()->get($className); |
137 | 137 | } |
138 | 138 | |
139 | +/** |
|
140 | + * @return string |
|
141 | + */ |
|
139 | 142 | function project() |
140 | 143 | { |
141 | 144 | global $project; |
@@ -152,12 +155,6 @@ discard block |
||
152 | 155 | * @param string $entity Entity that identifies the string. It must be in the form |
153 | 156 | * "Namespace.Entity" where Namespace will be usually the class name where this |
154 | 157 | * string is used and Entity identifies the string inside the namespace. |
155 | - * @param mixed $arg,... Additional arguments are parsed as such: |
|
156 | - * - Next string argument is a default. Pass in a `|` pipe-delimeted value with `{count}` |
|
157 | - * to do pluralisation. |
|
158 | - * - Any other string argument after default is context for i18nTextCollector |
|
159 | - * - Any array argument in any order is an injection parameter list. Pass in a `count` |
|
160 | - * injection parameter to pluralise. |
|
161 | 158 | * @return string |
162 | 159 | */ |
163 | 160 | function _t($entity, $arg = null) |
@@ -171,7 +168,7 @@ discard block |
||
171 | 168 | * Only increases up to the maximum defined in {@link set_increase_memory_limit_max()}, |
172 | 169 | * and defaults to the 'memory_limit' setting in the PHP configuration. |
173 | 170 | * |
174 | - * @param string|int $memoryLimit A memory limit string, such as "64M". If omitted, unlimited memory will be set. |
|
171 | + * @param integer $memoryLimit A memory limit string, such as "64M". If omitted, unlimited memory will be set. |
|
175 | 172 | * @return Boolean TRUE indicates a successful change, FALSE a denied change. |
176 | 173 | */ |
177 | 174 | function increase_memory_limit_to($memoryLimit = -1) |
@@ -117,7 +117,7 @@ discard block |
||
117 | 117 | * @param array $attributes an array of attributes to include on the link. |
118 | 118 | * @param string $iconClass |
119 | 119 | * |
120 | - * @return boolean The result of the operation. |
|
120 | + * @return boolean|null The result of the operation. |
|
121 | 121 | */ |
122 | 122 | public static function add_link($code, $menuTitle, $url, $priority = -1, $attributes = null, $iconClass = null) |
123 | 123 | { |
@@ -140,7 +140,7 @@ discard block |
||
140 | 140 | * @param array $attributes an array of attributes to include on the link. |
141 | 141 | * @param string $iconClass |
142 | 142 | * |
143 | - * @return bool Success |
|
143 | + * @return boolean|null Success |
|
144 | 144 | */ |
145 | 145 | public static function add_menu_item( |
146 | 146 | $code, |
@@ -322,7 +322,7 @@ discard block |
||
322 | 322 | * @param array $attributes an array of attributes to include on the link. |
323 | 323 | * @param string $iconClass |
324 | 324 | * |
325 | - * @return bool Success |
|
325 | + * @return boolean|null Success |
|
326 | 326 | */ |
327 | 327 | public static function replace_menu_item( |
328 | 328 | $code, |
@@ -92,6 +92,9 @@ |
||
92 | 92 | return $return; |
93 | 93 | } |
94 | 94 | |
95 | + /** |
|
96 | + * @param boolean $index |
|
97 | + */ |
|
95 | 98 | function f($index) { |
96 | 99 | return stripslashes($this->row[$index]); |
97 | 100 | } |
@@ -92,6 +92,9 @@ |
||
92 | 92 | return $return; |
93 | 93 | } |
94 | 94 | |
95 | + /** |
|
96 | + * @param boolean $index |
|
97 | + */ |
|
95 | 98 | function f($index) { |
96 | 99 | return stripslashes($this->row[$index]); |
97 | 100 | } |
@@ -42,6 +42,9 @@ |
||
42 | 42 | ] |
43 | 43 | ); |
44 | 44 | |
45 | + /** |
|
46 | + * @param string $root |
|
47 | + */ |
|
45 | 48 | public function __construct($root = null, $writeFlags = LOCK_EX, $linkHandling = self::DISALLOW_LINKS) |
46 | 49 | { |
47 | 50 | // Get root path, and ensure that this exists and is safe |
@@ -89,6 +89,9 @@ discard block |
||
89 | 89 | $this->sequentialSaveableSet = null; |
90 | 90 | } |
91 | 91 | |
92 | + /** |
|
93 | + * @param FormField[] $list |
|
94 | + */ |
|
92 | 95 | protected function collateDataFields(&$list, $saveableOnly = false) |
93 | 96 | { |
94 | 97 | if (!isset($list)) { |
@@ -198,7 +201,7 @@ discard block |
||
198 | 201 | * Removes a number of fields from a Tab/TabSet within this FieldList. |
199 | 202 | * |
200 | 203 | * @param string $tabName The name of the Tab or TabSet field |
201 | - * @param array $fields A list of fields, e.g. array('Name', 'Email') |
|
204 | + * @param string[] $fields A list of fields, e.g. array('Name', 'Email') |
|
202 | 205 | */ |
203 | 206 | public function removeFieldsFromTab($tabName, $fields) |
204 | 207 | { |
@@ -625,7 +628,7 @@ discard block |
||
625 | 628 | } |
626 | 629 | |
627 | 630 | /** |
628 | - * @param $field |
|
631 | + * @param CompositeField $field |
|
629 | 632 | * @return $this |
630 | 633 | */ |
631 | 634 | public function setContainerField($field) |
@@ -707,6 +710,7 @@ discard block |
||
707 | 710 | * the children collection. Doesn't work recursively. |
708 | 711 | * |
709 | 712 | * @param string|FormField |
713 | + * @param string $field |
|
710 | 714 | * @return int Position in children collection (first position starts with 0). |
711 | 715 | * Returns FALSE if the field can't be found. |
712 | 716 | */ |