@@ -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) { |
@@ -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}", |
@@ -83,7 +83,6 @@ discard block |
||
| 83 | 83 | /** |
| 84 | 84 | * Adds a file to the concatenation/compression process. |
| 85 | 85 | * |
| 86 | - * @param String $path Path to the file to include in the compressed package/output. |
|
| 87 | 86 | */ |
| 88 | 87 | public function &addFile($file) { |
| 89 | 88 | $this->files .= ($this->files ? "," : "") . $file; |
@@ -256,7 +255,7 @@ discard block |
||
| 256 | 255 | /** |
| 257 | 256 | * Renders a script tag that loads the TinyMCE script. |
| 258 | 257 | * |
| 259 | - * @param Array $settings Name/value array with settings for the script tag. |
|
| 258 | + * @param Array $tagSettings Name/value array with settings for the script tag. |
|
| 260 | 259 | * @param Bool $return The script tag is return instead of being output if true |
| 261 | 260 | * @return String the tag is returned if $return is true |
| 262 | 261 | */ |
@@ -139,6 +139,7 @@ discard block |
||
| 139 | 139 | |
| 140 | 140 | /** |
| 141 | 141 | * Set the manifest to be used to look up test classes by helper functions |
| 142 | + * @param SS_ClassManifest $manifest |
|
| 142 | 143 | */ |
| 143 | 144 | public static function set_test_class_manifest($manifest) { |
| 144 | 145 | self::$test_class_manifest = $manifest; |
@@ -422,7 +423,7 @@ discard block |
||
| 422 | 423 | * Will collate all IDs form all fixtures if multiple fixtures are provided. |
| 423 | 424 | * |
| 424 | 425 | * @param string $className |
| 425 | - * @return array A map of fixture-identifier => object-id |
|
| 426 | + * @return A A map of fixture-identifier => object-id |
|
| 426 | 427 | */ |
| 427 | 428 | protected function allFixtureIDs($className) { |
| 428 | 429 | return $this->getFixtureFactory()->getIds($className); |
@@ -582,10 +583,10 @@ discard block |
||
| 582 | 583 | /** |
| 583 | 584 | * Assert that the matching email was sent since the last call to clearEmails() |
| 584 | 585 | * All of the parameters can either be a string, or, if they start with "/", a PREG-compatible regular expression. |
| 585 | - * @param $to |
|
| 586 | + * @param string $to |
|
| 586 | 587 | * @param $from |
| 587 | - * @param $subject |
|
| 588 | - * @param $content |
|
| 588 | + * @param string $subject |
|
| 589 | + * @param string $content |
|
| 589 | 590 | * @return array Contains the keys: 'type', 'to', 'from', 'subject', 'content', 'plainContent', 'attachedFiles', |
| 590 | 591 | * 'customHeaders', 'htmlContent', inlineImages' |
| 591 | 592 | */ |
@@ -753,7 +754,7 @@ discard block |
||
| 753 | 754 | * @param string $expectedSQL |
| 754 | 755 | * @param string $actualSQL |
| 755 | 756 | * @param string $message |
| 756 | - * @param float $delta |
|
| 757 | + * @param integer $delta |
|
| 757 | 758 | * @param integer $maxDepth |
| 758 | 759 | * @param boolean $canonicalize |
| 759 | 760 | * @param boolean $ignoreCase |
@@ -1039,9 +1040,9 @@ discard block |
||
| 1039 | 1040 | /** |
| 1040 | 1041 | * Test against a theme. |
| 1041 | 1042 | * |
| 1042 | - * @param $themeBaseDir string - themes directory |
|
| 1043 | - * @param $theme string - theme name |
|
| 1044 | - * @param $callback Closure |
|
| 1043 | + * @param string $themeBaseDir string - themes directory |
|
| 1044 | + * @param string $theme string - theme name |
|
| 1045 | + * @param Closure $callback Closure |
|
| 1045 | 1046 | */ |
| 1046 | 1047 | protected function useTestTheme($themeBaseDir, $theme, $callback) { |
| 1047 | 1048 | Config::nest(); |
@@ -23,8 +23,6 @@ |
||
| 23 | 23 | * $list = DataList::create('SiteTree'); |
| 24 | 24 | * $list = SiteTree::get(); |
| 25 | 25 | * |
| 26 | - * @param string $class the class name |
|
| 27 | - * @param mixed $arguments,... arguments to pass to the constructor |
|
| 28 | 26 | * @return static |
| 29 | 27 | */ |
| 30 | 28 | public static function create() { |
@@ -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 | |
@@ -39,7 +39,7 @@ discard block |
||
| 39 | 39 | /** |
| 40 | 40 | * Given a TinyMCE pattern (close to unix glob style), create a regex that does the match |
| 41 | 41 | * |
| 42 | - * @param $str - The TinyMCE pattern |
|
| 42 | + * @param string|null $str - The TinyMCE pattern |
|
| 43 | 43 | * @return string - The equivalent regex |
| 44 | 44 | */ |
| 45 | 45 | protected function patternToRegex($str) { |
@@ -180,6 +180,7 @@ discard block |
||
| 180 | 180 | /** |
| 181 | 181 | * Given an attribute name, return the rule structure for that attribute |
| 182 | 182 | * @param string $name - The attribute name |
| 183 | + * @param stdClass $elementRule |
|
| 183 | 184 | * @return stdClass - The attribute rule |
| 184 | 185 | */ |
| 185 | 186 | protected function getRuleForAttribute($elementRule, $name) { |