@@ -125,8 +125,6 @@ discard block |
||
125 | 125 | * $list = DataList::create('SiteTree'); |
126 | 126 | * $list = SiteTree::get(); |
127 | 127 | * |
128 | - * @param string $class the class name |
|
129 | - * @param mixed $arguments,... arguments to pass to the constructor |
|
130 | 128 | * @return static |
131 | 129 | */ |
132 | 130 | public static function create() { |
@@ -149,7 +147,6 @@ discard block |
||
149 | 147 | * way to access instance methods which don't rely on instance |
150 | 148 | * data (e.g. the custom SilverStripe static handling). |
151 | 149 | * |
152 | - * @param string $className Optional classname (if called on Object directly) |
|
153 | 150 | * @return static The singleton instance |
154 | 151 | */ |
155 | 152 | public static function singleton() { |
@@ -334,8 +331,6 @@ discard block |
||
334 | 331 | * Similar to {@link Object::create()}, except that classes are only overloaded if you set the $strong parameter to |
335 | 332 | * TRUE when using {@link Object::useCustomClass()} |
336 | 333 | * |
337 | - * @param string $class the class name |
|
338 | - * @param mixed $arguments,... arguments to pass to the constructor |
|
339 | 334 | * @return static |
340 | 335 | */ |
341 | 336 | public static function strong_create() { |
@@ -387,8 +382,8 @@ discard block |
||
387 | 382 | * without any inheritance, merging or parent lookup if it doesn't exist on the given class. |
388 | 383 | * |
389 | 384 | * @static |
390 | - * @param $class - The class to get the static from |
|
391 | - * @param $name - The property to get from the class |
|
385 | + * @param string $class - The class to get the static from |
|
386 | + * @param string $name - The property to get from the class |
|
392 | 387 | * @param null $default - The value to return if property doesn't exist on class |
393 | 388 | * @return any - The value of the static property $name on class $class, or $default if that property is not |
394 | 389 | * defined |
@@ -914,6 +909,7 @@ discard block |
||
914 | 909 | |
915 | 910 | /** |
916 | 911 | * @see Object::get_static() |
912 | + * @param string $name |
|
917 | 913 | */ |
918 | 914 | public function stat($name, $uncached = false) { |
919 | 915 | return Config::inst()->get(($this->class ? $this->class : get_class($this)), $name, Config::FIRST_SET); |
@@ -921,6 +917,8 @@ discard block |
||
921 | 917 | |
922 | 918 | /** |
923 | 919 | * @see Object::set_static() |
920 | + * @param string $name |
|
921 | + * @param string $value |
|
924 | 922 | */ |
925 | 923 | public function set_stat($name, $value) { |
926 | 924 | Config::inst()->update(($this->class ? $this->class : get_class($this)), $name, $value); |
@@ -928,6 +926,7 @@ discard block |
||
928 | 926 | |
929 | 927 | /** |
930 | 928 | * @see Object::uninherited_static() |
929 | + * @param string $name |
|
931 | 930 | */ |
932 | 931 | public function uninherited($name) { |
933 | 932 | return Config::inst()->get(($this->class ? $this->class : get_class($this)), $name, Config::UNINHERITED); |
@@ -978,7 +977,7 @@ discard block |
||
978 | 977 | * all results into an array |
979 | 978 | * |
980 | 979 | * @param string $method the method name to call |
981 | - * @param mixed $argument a single argument to pass |
|
980 | + * @param string $argument a single argument to pass |
|
982 | 981 | * @return mixed |
983 | 982 | * @todo integrate inheritance rules |
984 | 983 | */ |
@@ -1001,7 +1000,7 @@ discard block |
||
1001 | 1000 | * The extension methods are defined during {@link __construct()} in {@link defineMethods()}. |
1002 | 1001 | * |
1003 | 1002 | * @param string $method the name of the method to call on each extension |
1004 | - * @param mixed $a1,... up to 7 arguments to be passed to the method |
|
1003 | + * @param DataObject $a4 |
|
1005 | 1004 | * @return array |
1006 | 1005 | */ |
1007 | 1006 | public function extend($method, &$a1=null, &$a2=null, &$a3=null, &$a4=null, &$a5=null, &$a6=null, &$a7=null) { |
@@ -126,6 +126,7 @@ |
||
126 | 126 | * |
127 | 127 | * @param string $title |
128 | 128 | * @param string $title |
129 | + * @param string|false $subtitle |
|
129 | 130 | */ |
130 | 131 | public function writeInfo($title, $subtitle, $description=false) { |
131 | 132 | echo '<div class="info">'; |
@@ -142,6 +142,7 @@ discard block |
||
142 | 142 | |
143 | 143 | /** |
144 | 144 | * Set the manifest to be used to look up test classes by helper functions |
145 | + * @param SS_ClassManifest $manifest |
|
145 | 146 | */ |
146 | 147 | public static function set_test_class_manifest($manifest) { |
147 | 148 | self::$test_class_manifest = $manifest; |
@@ -394,7 +395,7 @@ discard block |
||
394 | 395 | /** |
395 | 396 | * Get the ID of an object from the fixture. |
396 | 397 | * |
397 | - * @param $className The data class, as specified in your fixture file. Parent classes won't work |
|
398 | + * @param string $className The data class, as specified in your fixture file. Parent classes won't work |
|
398 | 399 | * @param $identifier The identifier string, as provided in your fixture file |
399 | 400 | * @return int |
400 | 401 | */ |
@@ -417,7 +418,7 @@ discard block |
||
417 | 418 | * Will collate all IDs form all fixtures if multiple fixtures are provided. |
418 | 419 | * |
419 | 420 | * @param string $className |
420 | - * @return array A map of fixture-identifier => object-id |
|
421 | + * @return A A map of fixture-identifier => object-id |
|
421 | 422 | */ |
422 | 423 | protected function allFixtureIDs($className) { |
423 | 424 | return $this->getFixtureFactory()->getIds($className); |
@@ -574,10 +575,10 @@ discard block |
||
574 | 575 | /** |
575 | 576 | * Assert that the matching email was sent since the last call to clearEmails() |
576 | 577 | * All of the parameters can either be a string, or, if they start with "/", a PREG-compatible regular expression. |
577 | - * @param $to |
|
578 | + * @param string $to |
|
578 | 579 | * @param $from |
579 | - * @param $subject |
|
580 | - * @param $content |
|
580 | + * @param string $subject |
|
581 | + * @param string $content |
|
581 | 582 | * @return array Contains the keys: 'type', 'to', 'from', 'subject', 'content', 'plainContent', 'attachedFiles', |
582 | 583 | * 'customHeaders', 'htmlContent', inlineImages' |
583 | 584 | */ |
@@ -738,7 +739,7 @@ discard block |
||
738 | 739 | * @param string $expectedSQL |
739 | 740 | * @param string $actualSQL |
740 | 741 | * @param string $message |
741 | - * @param float $delta |
|
742 | + * @param integer $delta |
|
742 | 743 | * @param integer $maxDepth |
743 | 744 | * @param boolean $canonicalize |
744 | 745 | * @param boolean $ignoreCase |
@@ -937,6 +938,7 @@ discard block |
||
937 | 938 | /** |
938 | 939 | * Create a member and group with the given permission code, and log in with it. |
939 | 940 | * Returns the member ID. |
941 | + * @return integer |
|
940 | 942 | */ |
941 | 943 | public function logInWithPermission($permCode = "ADMIN") { |
942 | 944 | if(!isset($this->cache_generatedMembers[$permCode])) { |
@@ -976,9 +978,9 @@ discard block |
||
976 | 978 | /** |
977 | 979 | * Test against a theme. |
978 | 980 | * |
979 | - * @param $themeBaseDir string - themes directory |
|
980 | - * @param $theme string - theme name |
|
981 | - * @param $callback Closure |
|
981 | + * @param string $themeBaseDir string - themes directory |
|
982 | + * @param string $theme string - theme name |
|
983 | + * @param Closure $callback Closure |
|
982 | 984 | */ |
983 | 985 | protected function useTestTheme($themeBaseDir, $theme, $callback) { |
984 | 986 | Config::nest(); |
@@ -102,7 +102,7 @@ discard block |
||
102 | 102 | * Set a different instance than {@link Upload_Validator} |
103 | 103 | * for this upload session. |
104 | 104 | * |
105 | - * @param object $validator |
|
105 | + * @param Upload_Validator $validator |
|
106 | 106 | */ |
107 | 107 | public function setValidator($validator) { |
108 | 108 | $this->validator = $validator; |
@@ -223,7 +223,7 @@ discard block |
||
223 | 223 | * |
224 | 224 | * @param array $tmpFile |
225 | 225 | * @param File $file |
226 | - * @return Boolean |
|
226 | + * @return boolean|string |
|
227 | 227 | */ |
228 | 228 | public function loadIntoFile($tmpFile, $file, $folderPath = false) { |
229 | 229 | $this->file = $file; |
@@ -231,7 +231,8 @@ discard block |
||
231 | 231 | } |
232 | 232 | |
233 | 233 | /** |
234 | - * @return Boolean |
|
234 | + * @param boolean $bool |
|
235 | + * @return boolean|null |
|
235 | 236 | */ |
236 | 237 | public function setReplaceFile($bool) { |
237 | 238 | $this->replaceFile = $bool; |
@@ -295,7 +296,7 @@ discard block |
||
295 | 296 | /** |
296 | 297 | * Determines wether previous operations caused an error. |
297 | 298 | * |
298 | - * @return boolean |
|
299 | + * @return integer |
|
299 | 300 | */ |
300 | 301 | public function isError() { |
301 | 302 | return (count($this->errors)); |
@@ -45,7 +45,7 @@ discard block |
||
45 | 45 | * |
46 | 46 | * @param string $name The internal field name, passed to forms. |
47 | 47 | * @param string $title The human-readable field label. |
48 | - * @param mixed $value The value of the field. |
|
48 | + * @param integer $value The value of the field. |
|
49 | 49 | * @param string $config HTMLEditorConfig identifier to be used. Default to the active one. |
50 | 50 | */ |
51 | 51 | public function __construct($name, $title = null, $value = '', $config = null) { |
@@ -169,6 +169,10 @@ discard block |
||
169 | 169 | |
170 | 170 | protected $controller, $name; |
171 | 171 | |
172 | + /** |
|
173 | + * @param Controller|null $controller |
|
174 | + * @param string $name |
|
175 | + */ |
|
172 | 176 | public function __construct($controller, $name) { |
173 | 177 | parent::__construct(); |
174 | 178 | |
@@ -197,7 +201,7 @@ discard block |
||
197 | 201 | /** |
198 | 202 | * Searches the SiteTree for display in the dropdown |
199 | 203 | * |
200 | - * @return callback |
|
204 | + * @return DataList |
|
201 | 205 | */ |
202 | 206 | public function siteTreeSearchCallback($sourceObject, $labelField, $search) { |
203 | 207 | return DataObject::get($sourceObject)->filterAny(array( |
@@ -563,7 +567,7 @@ discard block |
||
563 | 567 | /** |
564 | 568 | * Find all anchors available on the given page. |
565 | 569 | * |
566 | - * @return array |
|
570 | + * @return string |
|
567 | 571 | */ |
568 | 572 | public function getanchors() { |
569 | 573 | $id = (int)$this->getRequest()->getVar('PageID'); |
@@ -607,6 +611,7 @@ discard block |
||
607 | 611 | * not the "master record" in the database - hence there's no form or saving logic. |
608 | 612 | * |
609 | 613 | * @param String Relative or absolute URL to file |
614 | + * @param HtmlEditorField_File $file |
|
610 | 615 | * @return FieldList |
611 | 616 | */ |
612 | 617 | protected function getFieldsForFile($url, $file) { |
@@ -628,6 +633,7 @@ discard block |
||
628 | 633 | } |
629 | 634 | |
630 | 635 | /** |
636 | + * @param HtmlEditorField_Embed $file |
|
631 | 637 | * @return FieldList |
632 | 638 | */ |
633 | 639 | protected function getFieldsForOembed($url, $file) { |
@@ -837,6 +843,7 @@ discard block |
||
837 | 843 | |
838 | 844 | /** |
839 | 845 | * @param Int |
846 | + * @param integer $parentID |
|
840 | 847 | * @return DataList |
841 | 848 | */ |
842 | 849 | protected function getFiles($parentID = null) { |
@@ -73,6 +73,9 @@ |
||
73 | 73 | return $this; |
74 | 74 | } |
75 | 75 | |
76 | + /** |
|
77 | + * @return string |
|
78 | + */ |
|
76 | 79 | public static function joinPhoneNumber( $value ) { |
77 | 80 | if( is_array( $value ) ) { |
78 | 81 | $completeNumber = ''; |
@@ -76,7 +76,7 @@ discard block |
||
76 | 76 | * |
77 | 77 | * @param string $name the field name |
78 | 78 | * @param string $title the field label |
79 | - * @param string|array $sourceObject The object-type to list in the tree. This could |
|
79 | + * @param string $sourceObject The object-type to list in the tree. This could |
|
80 | 80 | * be one of the following: |
81 | 81 | * - A DataObject class name with the {@link Hierarchy} extension. |
82 | 82 | * - An array of key/value pairs, like a {@link DropdownField} source. In |
@@ -204,7 +204,7 @@ discard block |
||
204 | 204 | } |
205 | 205 | |
206 | 206 | /** |
207 | - * @return HTMLText |
|
207 | + * @return string |
|
208 | 208 | */ |
209 | 209 | public function Field($properties = array()) { |
210 | 210 | Requirements::add_i18n_javascript(FRAMEWORK_DIR . '/javascript/lang'); |
@@ -385,7 +385,7 @@ discard block |
||
385 | 385 | * If a filter function has been set, that will be called. And if search text is set, |
386 | 386 | * filter on that too. Return true if all applicable conditions are true, false otherwise. |
387 | 387 | * @param $node |
388 | - * @return unknown_type |
|
388 | + * @return boolean |
|
389 | 389 | */ |
390 | 390 | public function filterMarking($node) { |
391 | 391 | if ($this->filterCallback && !call_user_func($this->filterCallback, $node)) return false; |
@@ -436,7 +436,6 @@ discard block |
||
436 | 436 | } |
437 | 437 | |
438 | 438 | /** |
439 | - * @param String $field |
|
440 | 439 | */ |
441 | 440 | public function setSourceObject($class) { |
442 | 441 | $this->sourceObject = $class; |
@@ -385,6 +385,7 @@ discard block |
||
385 | 385 | * - minutes |
386 | 386 | * - seconds |
387 | 387 | * This includes the singular forms as well |
388 | + * @param string $date |
|
388 | 389 | * @return string SQL datetime expression to query for a datetime (YYYY-MM-DD hh:mm:ss) which is the result of |
389 | 390 | * the addition |
390 | 391 | */ |
@@ -398,6 +399,7 @@ discard block |
||
398 | 399 | * e.g. '"SiteTree"."Created"' |
399 | 400 | * @param string $date2 to be substracted of $date1, can be either 'now', literal datetime |
400 | 401 | * like '1973-10-14 10:30:00' or field name, e.g. '"SiteTree"."Created"' |
402 | + * @param string $date1 |
|
401 | 403 | * @return string SQL datetime expression to query for the interval between $date1 and $date2 in seconds which |
402 | 404 | * is the result of the substraction |
403 | 405 | */ |
@@ -625,7 +627,7 @@ discard block |
||
625 | 627 | * @param boolean $create Flag indicating whether the database should be created |
626 | 628 | * if it doesn't exist. If $create is false and the database doesn't exist |
627 | 629 | * then an error will be raised |
628 | - * @param int|boolean $errorLevel The level of error reporting to enable for the query, or false if no error |
|
630 | + * @param boolean $errorLevel The level of error reporting to enable for the query, or false if no error |
|
629 | 631 | * should be raised |
630 | 632 | * @return boolean Flag indicating success |
631 | 633 | */ |
@@ -785,6 +787,7 @@ discard block |
||
785 | 787 | |
786 | 788 | /** |
787 | 789 | * @deprecated since version 4.0 Use DB::field_list instead |
790 | + * @param string $table |
|
788 | 791 | */ |
789 | 792 | public function fieldList($table) { |
790 | 793 | Deprecation::notice('4.0', 'Use DB::field_list instead'); |
@@ -589,7 +589,7 @@ discard block |
||
589 | 589 | /** |
590 | 590 | * Resize this image for the CMS. Use in templates with $CMSThumbnail |
591 | 591 | * |
592 | - * @return Image_Cached|null |
|
592 | + * @return Image|null |
|
593 | 593 | */ |
594 | 594 | public function CMSThumbnail() { |
595 | 595 | return $this->Pad($this->stat('cms_thumbnail_width'),$this->stat('cms_thumbnail_height')); |
@@ -631,7 +631,7 @@ discard block |
||
631 | 631 | /** |
632 | 632 | * Resize this image for use as a thumbnail in a strip. Use in templates with $StripThumbnail. |
633 | 633 | * |
634 | - * @return Image_Cached|null |
|
634 | + * @return Image|null |
|
635 | 635 | */ |
636 | 636 | public function StripThumbnail() { |
637 | 637 | return $this->Fill($this->stat('strip_thumbnail_width'),$this->stat('strip_thumbnail_height')); |
@@ -868,7 +868,7 @@ discard block |
||
868 | 868 | /** |
869 | 869 | * Generate patterns that will help to match filenames of cached images |
870 | 870 | * @param string $filename Filename of source image |
871 | - * @return array |
|
871 | + * @return string |
|
872 | 872 | */ |
873 | 873 | private function getFilenamePatterns($filename) { |
874 | 874 | $methodNames = $this->allMethodNames(true); |
@@ -1024,7 +1024,7 @@ discard block |
||
1024 | 1024 | |
1025 | 1025 | /** |
1026 | 1026 | * Get the orientation of this image. |
1027 | - * @return ORIENTATION_SQUARE | ORIENTATION_PORTRAIT | ORIENTATION_LANDSCAPE |
|
1027 | + * @return integer | ORIENTATION_PORTRAIT | ORIENTATION_LANDSCAPE |
|
1028 | 1028 | */ |
1029 | 1029 | public function getOrientation() { |
1030 | 1030 | $width = $this->getWidth(); |