@@ -730,7 +730,7 @@ discard block |
||
730 | 730 | /** |
731 | 731 | * All custom objects with the same number. E.g. 'Page 1' owns 'Custom 1' |
732 | 732 | * |
733 | - * @return DataList |
|
733 | + * @return SilverStripe\ORM\DataList |
|
734 | 734 | */ |
735 | 735 | public function Custom() { |
736 | 736 | $title = str_replace('Page', 'Custom', $this->Title); |
@@ -784,7 +784,7 @@ discard block |
||
784 | 784 | /** |
785 | 785 | * All pages with the same number. E.g. 'Page 1' owns 'Custom 1' |
786 | 786 | * |
787 | - * @return DataList |
|
787 | + * @return SilverStripe\ORM\DataList |
|
788 | 788 | */ |
789 | 789 | public function Pages() { |
790 | 790 | $title = str_replace('Custom', 'Page', $this->Title); |
@@ -99,7 +99,7 @@ discard block |
||
99 | 99 | * left. |
100 | 100 | * @param array $attributes an array of attributes to include on the link. |
101 | 101 | * |
102 | - * @return boolean The result of the operation. |
|
102 | + * @return boolean|null The result of the operation. |
|
103 | 103 | */ |
104 | 104 | public static function add_link($code, $menuTitle, $url, $priority = -1, $attributes = null) { |
105 | 105 | return self::add_menu_item($code, $menuTitle, $url, null, $priority, $attributes); |
@@ -119,7 +119,7 @@ discard block |
||
119 | 119 | * have the rights to access some other part of the admin area. |
120 | 120 | * @param int $priority |
121 | 121 | * @param array $attributes an array of attributes to include on the link. |
122 | - * @return bool Success |
|
122 | + * @return boolean|null Success |
|
123 | 123 | */ |
124 | 124 | public static function add_menu_item($code, $menuTitle, $url, $controllerClass = null, $priority = -1, |
125 | 125 | $attributes = null) { |
@@ -250,7 +250,7 @@ discard block |
||
250 | 250 | * have the rights to access some other part of the admin area. |
251 | 251 | * @param int $priority |
252 | 252 | * @param array $attributes an array of attributes to include on the link. |
253 | - * @return bool Success |
|
253 | + * @return boolean|null Success |
|
254 | 254 | */ |
255 | 255 | public static function replace_menu_item($code, $menuTitle, $url, $controllerClass = null, $priority = -1, |
256 | 256 | $attributes = null) { |
@@ -282,7 +282,7 @@ |
||
282 | 282 | * |
283 | 283 | * Must not raise SS_HTTPResponse_Exceptions - instead it should return |
284 | 284 | * |
285 | - * @param $request |
|
285 | + * @param SS_HTTPRequest $request |
|
286 | 286 | * @param $action |
287 | 287 | * @return SS_HTTPResponse |
288 | 288 | */ |
@@ -116,7 +116,7 @@ |
||
116 | 116 | * @param mixed $returnVal |
117 | 117 | * @param bool $ignoreAjax |
118 | 118 | * @param array $ignoredFunctions |
119 | - * @return mixed |
|
119 | + * @return string|null |
|
120 | 120 | */ |
121 | 121 | public static function backtrace($returnVal = false, $ignoreAjax = false, $ignoredFunctions = null) { |
122 | 122 | $plainText = Director::is_cli() || (Director::is_ajax() && !$ignoreAjax); |
@@ -258,7 +258,7 @@ discard block |
||
258 | 258 | * |
259 | 259 | * @param array $args Array of input shortcode arguments |
260 | 260 | * @param int $errorCode If the file is not found, or is inaccessible, this will be assigned to a HTTP error code. |
261 | - * @return File|null The File DataObject, if it can be found. |
|
261 | + * @return null|DataObject The File DataObject, if it can be found. |
|
262 | 262 | */ |
263 | 263 | public static function find_shortcode_record($args, &$errorCode = null) { |
264 | 264 | // Validate shortcode |
@@ -387,7 +387,7 @@ discard block |
||
387 | 387 | * Check if this file can be modified |
388 | 388 | * |
389 | 389 | * @param Member $member |
390 | - * @return boolean |
|
390 | + * @return boolean|string |
|
391 | 391 | */ |
392 | 392 | public function canEdit($member = null) { |
393 | 393 | if(!$member) { |
@@ -407,7 +407,7 @@ discard block |
||
407 | 407 | * |
408 | 408 | * @param Member $member |
409 | 409 | * @param array $context |
410 | - * @return boolean |
|
410 | + * @return boolean|string |
|
411 | 411 | */ |
412 | 412 | public function canCreate($member = null, $context = array()) { |
413 | 413 | if(!$member) { |
@@ -426,7 +426,7 @@ discard block |
||
426 | 426 | * Check if this file can be deleted |
427 | 427 | * |
428 | 428 | * @param Member $member |
429 | - * @return boolean |
|
429 | + * @return boolean|string |
|
430 | 430 | */ |
431 | 431 | public function canDelete($member = null) { |
432 | 432 | if(!$member) { |
@@ -627,7 +627,7 @@ discard block |
||
627 | 627 | * |
628 | 628 | * @param string $condition The PHP condition to be evaluated. The page will be called $item |
629 | 629 | * @param array $collator An array, passed by reference, to collect all of the matching descendants. |
630 | - * @return true|null |
|
630 | + * @return boolean|null |
|
631 | 631 | */ |
632 | 632 | public function collateDescendants($condition, &$collator) { |
633 | 633 | if($children = $this->Children()) { |
@@ -988,6 +988,7 @@ discard block |
||
988 | 988 | * |
989 | 989 | * @param String File extension, without dot prefix. Use an asterisk ('*') |
990 | 990 | * to specify a generic fallback if no mapping is found for an extension. |
991 | + * @param string $ext |
|
991 | 992 | * @return String Classname for a subclass of {@link File} |
992 | 993 | */ |
993 | 994 | public static function get_class_for_file_extension($ext) { |
@@ -1125,7 +1126,6 @@ discard block |
||
1125 | 1126 | * Note that the result will not have a leading slash, and should not be used |
1126 | 1127 | * with local file paths. |
1127 | 1128 | * |
1128 | - * @param string $part,... Parts |
|
1129 | 1129 | * @return string |
1130 | 1130 | */ |
1131 | 1131 | public static function join_paths() { |
@@ -195,7 +195,7 @@ discard block |
||
195 | 195 | /** |
196 | 196 | * Determine if the target folder for new uploads in is visible the field UI. |
197 | 197 | * |
198 | - * @return boolean |
|
198 | + * @return boolean|string |
|
199 | 199 | */ |
200 | 200 | public function canPreviewFolder() { |
201 | 201 | if(!$this->isActive()) { |
@@ -264,6 +264,10 @@ discard block |
||
264 | 264 | return $this->record; |
265 | 265 | } |
266 | 266 | |
267 | + /** |
|
268 | + * @param null|DataObject $value |
|
269 | + * @param DataObject $record |
|
270 | + */ |
|
267 | 271 | public function setValue($value, $record = null) { |
268 | 272 | // Extract value from underlying record |
269 | 273 | if(empty($value) && $this->getName() && $record instanceof DataObject) { |
@@ -370,7 +374,7 @@ discard block |
||
370 | 374 | /** |
371 | 375 | * Determine if the user has permission to upload. |
372 | 376 | * |
373 | - * @return boolean |
|
377 | + * @return boolean|string |
|
374 | 378 | */ |
375 | 379 | public function canUpload() { |
376 | 380 | if(!$this->isActive()) { |
@@ -507,7 +507,7 @@ discard block |
||
507 | 507 | * The callback can opt out of handling specific responses by returning NULL, |
508 | 508 | * in which case the default form behaviour will kick in. |
509 | 509 | * |
510 | - * @param $callback |
|
510 | + * @param Closure $callback |
|
511 | 511 | * @return self |
512 | 512 | */ |
513 | 513 | public function setValidationResponseCallback($callback) { |
@@ -567,7 +567,7 @@ discard block |
||
567 | 567 | /** |
568 | 568 | * Fields can have action to, let's check if anyone of the responds to $funcname them |
569 | 569 | * |
570 | - * @param SS_List|array $fields |
|
570 | + * @param FieldList|null $fields |
|
571 | 571 | * @param callable $funcName |
572 | 572 | * @return FormField |
573 | 573 | */ |
@@ -706,6 +706,7 @@ discard block |
||
706 | 706 | * Set actions that are exempt from validation |
707 | 707 | * |
708 | 708 | * @param array |
709 | + * @param string[] $actions |
|
709 | 710 | * @return $this |
710 | 711 | */ |
711 | 712 | public function setValidationExemptActions($actions) { |
@@ -1104,7 +1105,7 @@ discard block |
||
1104 | 1105 | * If set to false (the default), then the form method is only used to construct the default |
1105 | 1106 | * form. |
1106 | 1107 | * |
1107 | - * @param $bool boolean |
|
1108 | + * @param boolean $bool boolean |
|
1108 | 1109 | * @return $this |
1109 | 1110 | */ |
1110 | 1111 | public function setStrictFormMethodCheck($bool) { |
@@ -1662,7 +1663,7 @@ discard block |
||
1662 | 1663 | * and _form_enctype. These are the attributes of the form. These fields |
1663 | 1664 | * can be used to send the form to Ajax. |
1664 | 1665 | * |
1665 | - * @return DBHTMLText |
|
1666 | + * @return string |
|
1666 | 1667 | */ |
1667 | 1668 | public function formHtmlContent() { |
1668 | 1669 | $this->IncludeFormTag = false; |
@@ -1923,6 +1924,9 @@ discard block |
||
1923 | 1924 | |
1924 | 1925 | protected $form; |
1925 | 1926 | |
1927 | + /** |
|
1928 | + * @param Form $form |
|
1929 | + */ |
|
1926 | 1930 | public function __construct($form) { |
1927 | 1931 | $this->form = $form; |
1928 | 1932 | parent::__construct(); |
@@ -129,7 +129,7 @@ |
||
129 | 129 | /** |
130 | 130 | * |
131 | 131 | * @param GridField $gridField |
132 | - * @return array |
|
132 | + * @return string[] |
|
133 | 133 | */ |
134 | 134 | public function getActions($gridField) { |
135 | 135 | return array('addto'); |
@@ -78,9 +78,15 @@ |
||
78 | 78 | public function can($member) { |
79 | 79 | } |
80 | 80 | |
81 | + /** |
|
82 | + * @param \SilverStripe\Security\Member|null $member |
|
83 | + */ |
|
81 | 84 | public function canEdit($member) { |
82 | 85 | } |
83 | 86 | |
87 | + /** |
|
88 | + * @param \SilverStripe\Security\Member|null $member |
|
89 | + */ |
|
84 | 90 | public function canDelete($member) { |
85 | 91 | } |
86 | 92 |