@@ -215,7 +215,7 @@ discard block |
||
215 | 215 | * Find an attribute in a SimpleXMLElement object by name. |
216 | 216 | * @param SimpleXMLElement $object |
217 | 217 | * @param string $attribute Name of attribute to find |
218 | - * @return SimpleXMLElement object of the attribute |
|
218 | + * @return boolean object of the attribute |
|
219 | 219 | */ |
220 | 220 | public function findAttribute($object, $attribute) { |
221 | 221 | $found = false; |
@@ -245,7 +245,7 @@ discard block |
||
245 | 245 | * Note: characters are stripped from the content; make sure that your assertions take this into account. |
246 | 246 | * |
247 | 247 | * @param string $selector A basic CSS selector, e.g. 'li.jobs h3' |
248 | - * @param array|string $expectedMatches The content of at least one of the matched tags |
|
248 | + * @param string[] $expectedMatches The content of at least one of the matched tags |
|
249 | 249 | * @throws PHPUnit_Framework_AssertionFailedError |
250 | 250 | * @return boolean |
251 | 251 | */ |
@@ -342,7 +342,7 @@ discard block |
||
342 | 342 | * @param string $selector A basic CSS selector, e.g. 'li.jobs h3' |
343 | 343 | * @param array|string $expectedMatches The content of *all* matched tags as an array |
344 | 344 | * @throws PHPUnit_Framework_AssertionFailedError |
345 | - * @return boolean |
|
345 | + * @return boolean|null |
|
346 | 346 | */ |
347 | 347 | public function assertExactHTMLMatchBySelector($selector, $expectedMatches) { |
348 | 348 | $items = $this->cssParser()->getBySelector($selector); |
@@ -319,7 +319,7 @@ discard block |
||
319 | 319 | * @access private |
320 | 320 | * @param obj PHPUnit_Framework_Test, current test that is being run |
321 | 321 | * @param obj PHPUnit_Framework_AssertationFailedError, PHPUnit error |
322 | - * @return array |
|
322 | + * @return string |
|
323 | 323 | */ |
324 | 324 | private function getTestException(PHPUnit_Framework_Test $test, Exception $e) { |
325 | 325 | // get the name of the testFile from the test |
@@ -406,6 +406,9 @@ discard block |
||
406 | 406 | |
407 | 407 | } |
408 | 408 | |
409 | + /** |
|
410 | + * @param string $name |
|
411 | + */ |
|
409 | 412 | protected function testNameToPhrase($name) { |
410 | 413 | return ucfirst(preg_replace("/([a-z])([A-Z])/", "$1 $2", $name)); |
411 | 414 | } |
@@ -52,6 +52,7 @@ |
||
52 | 52 | |
53 | 53 | /** |
54 | 54 | * @param String Classname |
55 | + * @param string $name |
|
55 | 56 | * @return boolean |
56 | 57 | */ |
57 | 58 | protected function isValidClass($name) { |
@@ -264,7 +264,7 @@ |
||
264 | 264 | /** |
265 | 265 | * Find all test classes in a directory and return an array of them. |
266 | 266 | * @param string $directory To search in |
267 | - * @param array $ignore Ignore these test classes if they are found. |
|
267 | + * @param string[] $ignore Ignore these test classes if they are found. |
|
268 | 268 | * @return array |
269 | 269 | */ |
270 | 270 | protected function getTestsInDirectory($directory, $ignore = array()) { |
@@ -169,7 +169,7 @@ |
||
169 | 169 | * Note: Items marked as disabled through {@link setDisabledItems()} can still be |
170 | 170 | * selected by default through this method. |
171 | 171 | * |
172 | - * @param Array $items Collection of array keys, as defined in the $source array |
|
172 | + * @param integer[] $items Collection of array keys, as defined in the $source array |
|
173 | 173 | */ |
174 | 174 | public function setDefaultItems($items) { |
175 | 175 | $this->defaultItems = $items; |
@@ -94,6 +94,7 @@ discard block |
||
94 | 94 | |
95 | 95 | /** |
96 | 96 | * @param string |
97 | + * @param string $tag |
|
97 | 98 | */ |
98 | 99 | public function setTag($tag) { |
99 | 100 | $this->tag = $tag; |
@@ -110,6 +111,7 @@ discard block |
||
110 | 111 | |
111 | 112 | /** |
112 | 113 | * @param string |
114 | + * @param string $legend |
|
113 | 115 | */ |
114 | 116 | public function setLegend($legend) { |
115 | 117 | $this->legend = $legend; |
@@ -200,6 +202,9 @@ discard block |
||
200 | 202 | return false; |
201 | 203 | } |
202 | 204 | |
205 | + /** |
|
206 | + * @param string $name |
|
207 | + */ |
|
203 | 208 | public function fieldByName($name) { |
204 | 209 | return $this->children->fieldByName($name); |
205 | 210 | } |
@@ -224,6 +229,8 @@ discard block |
||
224 | 229 | |
225 | 230 | /** |
226 | 231 | * @uses FieldList->insertAfter() |
232 | + * @param string $insertAfter |
|
233 | + * @param FormField $field |
|
227 | 234 | */ |
228 | 235 | public function insertAfter($insertAfter, $field) { |
229 | 236 | $ret = $this->children->insertAfter($insertAfter, $field); |
@@ -309,6 +316,7 @@ discard block |
||
309 | 316 | * the children collection. Doesn't work recursively. |
310 | 317 | * |
311 | 318 | * @param string|FormField |
319 | + * @param string $field |
|
312 | 320 | * @return int Position in children collection (first position starts with 0). Returns FALSE if the field can't |
313 | 321 | * be found. |
314 | 322 | */ |
@@ -120,7 +120,7 @@ discard block |
||
120 | 120 | /** |
121 | 121 | * @param array $properties |
122 | 122 | * |
123 | - * @return HTMLText |
|
123 | + * @return string |
|
124 | 124 | */ |
125 | 125 | public function Field($properties = array()) { |
126 | 126 | Requirements::javascript(FRAMEWORK_DIR . '/thirdparty/jquery/jquery.js'); |
@@ -417,7 +417,7 @@ discard block |
||
417 | 417 | * |
418 | 418 | * @param DataObjectInterface $record |
419 | 419 | * |
420 | - * @return boolean |
|
420 | + * @return false|null |
|
421 | 421 | */ |
422 | 422 | public function saveInto(DataObjectInterface $record) { |
423 | 423 | if(!$this->isSaveable()) { |
@@ -130,7 +130,7 @@ |
||
130 | 130 | |
131 | 131 | /** |
132 | 132 | * @param array $properties |
133 | - * @return HTMLText |
|
133 | + * @return string |
|
134 | 134 | */ |
135 | 135 | public function Field($properties = array()) { |
136 | 136 | $source = $this->getSource(); |
@@ -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(); |
@@ -426,6 +427,7 @@ discard block |
||
426 | 427 | |
427 | 428 | /** |
428 | 429 | * Handler method called before the FieldList is going to be manipulated. |
430 | + * @param FormField $item |
|
429 | 431 | */ |
430 | 432 | protected function onBeforeInsert($item) { |
431 | 433 | $this->flushFieldsCache(); |
@@ -498,6 +500,7 @@ discard block |
||
498 | 500 | * Transform this FieldList with a given tranform method, |
499 | 501 | * e.g. $this->transform(new ReadonlyTransformation()) |
500 | 502 | * |
503 | + * @param ReadonlyTransformation $trans |
|
501 | 504 | * @return FieldList |
502 | 505 | */ |
503 | 506 | public function transform($trans) { |
@@ -517,6 +520,9 @@ discard block |
||
517 | 520 | else return $this; |
518 | 521 | } |
519 | 522 | |
523 | + /** |
|
524 | + * @param CompositeField $field |
|
525 | + */ |
|
520 | 526 | public function setContainerField($field) { |
521 | 527 | $this->containerField = $field; |
522 | 528 | return $this; |
@@ -535,6 +541,7 @@ discard block |
||
535 | 541 | * Transform the named field into a readonly feld. |
536 | 542 | * |
537 | 543 | * @param string|FormField |
544 | + * @param string $field |
|
538 | 545 | */ |
539 | 546 | public function makeFieldReadonly($field) { |
540 | 547 | $fieldName = ($field instanceof FormField) ? $field->getName() : $field; |
@@ -584,6 +591,7 @@ discard block |
||
584 | 591 | * the children collection. Doesn't work recursively. |
585 | 592 | * |
586 | 593 | * @param string|FormField |
594 | + * @param string $field |
|
587 | 595 | * @return int Position in children collection (first position starts with 0). Returns FALSE if the field can't |
588 | 596 | * be found. |
589 | 597 | */ |
@@ -631,7 +639,7 @@ discard block |
||
631 | 639 | * Support function for backwards compatibility purposes. |
632 | 640 | * Caution: Volatile API, might be removed in 3.1 or later. |
633 | 641 | * |
634 | - * @param String $tabname Path to a tab, e.g. "Root.Content.Main" |
|
642 | + * @param String $name Path to a tab, e.g. "Root.Content.Main" |
|
635 | 643 | * @return String Rewritten path, based on {@link tabPathRewrites} |
636 | 644 | */ |
637 | 645 | protected function rewriteTabPath($name) { |