@@ -532,7 +532,7 @@ discard block |
||
532 | 532 | /** |
533 | 533 | * Fields can have action to, let's check if anyone of the responds to $funcname them |
534 | 534 | * |
535 | - * @param SS_List|array $fields |
|
535 | + * @param FieldList|null $fields |
|
536 | 536 | * @param callable $funcName |
537 | 537 | * @return FormField |
538 | 538 | */ |
@@ -791,6 +791,7 @@ discard block |
||
791 | 791 | } |
792 | 792 | |
793 | 793 | /** |
794 | + * @param string $name |
|
794 | 795 | * @return string $name |
795 | 796 | */ |
796 | 797 | public function getAttribute($name) { |
@@ -825,6 +826,7 @@ discard block |
||
825 | 826 | * |
826 | 827 | * @param array Custom attributes to process. Falls back to {@link getAttributes()}. |
827 | 828 | * If at least one argument is passed as a string, all arguments act as excludes by name. |
829 | + * @param string $attrs |
|
828 | 830 | * |
829 | 831 | * @return string HTML attributes, ready for insertion into an HTML tag |
830 | 832 | */ |
@@ -1032,7 +1034,7 @@ discard block |
||
1032 | 1034 | * If set to false (the default), then the form method is only used to construct the default |
1033 | 1035 | * form. |
1034 | 1036 | * |
1035 | - * @param $bool boolean |
|
1037 | + * @param boolean $bool boolean |
|
1036 | 1038 | * @return $this |
1037 | 1039 | */ |
1038 | 1040 | public function setStrictFormMethodCheck($bool) { |
@@ -1529,7 +1531,7 @@ discard block |
||
1529 | 1531 | * This is returned when you access a form as $FormObject rather |
1530 | 1532 | * than <% with FormObject %> |
1531 | 1533 | * |
1532 | - * @return HTML |
|
1534 | + * @return HTMLText |
|
1533 | 1535 | */ |
1534 | 1536 | public function forTemplate() { |
1535 | 1537 | $return = $this->renderWith(array_merge( |
@@ -1549,7 +1551,7 @@ discard block |
||
1549 | 1551 | * It triggers slightly different behaviour, such as disabling the rewriting |
1550 | 1552 | * of # links. |
1551 | 1553 | * |
1552 | - * @return HTML |
|
1554 | + * @return HTMLText |
|
1553 | 1555 | */ |
1554 | 1556 | public function forAjaxTemplate() { |
1555 | 1557 | $view = new SSViewer(array( |
@@ -1572,7 +1574,7 @@ discard block |
||
1572 | 1574 | * and _form_enctype. These are the attributes of the form. These fields |
1573 | 1575 | * can be used to send the form to Ajax. |
1574 | 1576 | * |
1575 | - * @return HTML |
|
1577 | + * @return string |
|
1576 | 1578 | */ |
1577 | 1579 | public function formHtmlContent() { |
1578 | 1580 | $this->IncludeFormTag = false; |
@@ -1830,6 +1832,9 @@ discard block |
||
1830 | 1832 | |
1831 | 1833 | protected $form; |
1832 | 1834 | |
1835 | + /** |
|
1836 | + * @param Form $form |
|
1837 | + */ |
|
1833 | 1838 | public function __construct($form) { |
1834 | 1839 | $this->form = $form; |
1835 | 1840 | parent::__construct(); |
@@ -532,6 +532,7 @@ discard block |
||
532 | 532 | * |
533 | 533 | * Caution: this doesn't work on all fields, see {@link setAttribute()}. |
534 | 534 | * |
535 | + * @param string $name |
|
535 | 536 | * @return null|string |
536 | 537 | */ |
537 | 538 | public function getAttribute($name) { |
@@ -643,7 +644,6 @@ discard block |
||
643 | 644 | * Set the field value. |
644 | 645 | * |
645 | 646 | * @param mixed $value |
646 | - * @param null|array|DataObject $data {@see Form::loadDataFrom} |
|
647 | 647 | * |
648 | 648 | * @return $this |
649 | 649 | */ |
@@ -1185,7 +1185,7 @@ discard block |
||
1185 | 1185 | * |
1186 | 1186 | * @param FieldList $containerFieldList |
1187 | 1187 | * |
1188 | - * @return FieldList |
|
1188 | + * @return FormField |
|
1189 | 1189 | */ |
1190 | 1190 | public function setContainerFieldList($containerFieldList) { |
1191 | 1191 | $this->containerFieldList = $containerFieldList; |
@@ -164,6 +164,7 @@ discard block |
||
164 | 164 | |
165 | 165 | /** |
166 | 166 | * @param String |
167 | + * @param string $class |
|
167 | 168 | */ |
168 | 169 | public function setItemRequestClass($class) { |
169 | 170 | $this->itemRequestClass = $class; |
@@ -271,6 +272,9 @@ discard block |
||
271 | 272 | parent::__construct(); |
272 | 273 | } |
273 | 274 | |
275 | + /** |
|
276 | + * @param string $action |
|
277 | + */ |
|
274 | 278 | public function Link($action = null) { |
275 | 279 | return Controller::join_links($this->gridField->Link('item'), |
276 | 280 | $this->record->ID ? $this->record->ID : 'new', $action); |
@@ -299,6 +303,9 @@ discard block |
||
299 | 303 | } |
300 | 304 | } |
301 | 305 | |
306 | + /** |
|
307 | + * @param SS_HTTPRequest $request |
|
308 | + */ |
|
302 | 309 | public function edit($request) { |
303 | 310 | $controller = $this->getToplevelController(); |
304 | 311 | $form = $this->ItemEditForm($this->gridField, $request); |
@@ -202,7 +202,6 @@ discard block |
||
202 | 202 | * @param string $title The field label. |
203 | 203 | * @param SS_List $items If no items are defined, the field will try to auto-detect an existing relation on |
204 | 204 | * @link $record}, with the same name as the field name. |
205 | - * @param Form $form Reference to the container form |
|
206 | 205 | */ |
207 | 206 | public function __construct($name, $title = null, SS_List $items = null) { |
208 | 207 | |
@@ -1052,7 +1051,7 @@ discard block |
||
1052 | 1051 | |
1053 | 1052 | /** |
1054 | 1053 | * @param SS_HTTPRequest $request |
1055 | - * @return UploadField_ItemHandler |
|
1054 | + * @return UploadField_SelectHandler |
|
1056 | 1055 | */ |
1057 | 1056 | public function handleSelect(SS_HTTPRequest $request) { |
1058 | 1057 | if(!$this->canAttachExisting()) return $this->httpError(403); |
@@ -1341,7 +1340,7 @@ discard block |
||
1341 | 1340 | |
1342 | 1341 | /** |
1343 | 1342 | * @param UploadFIeld $parent |
1344 | - * @param int $item |
|
1343 | + * @param int $itemID |
|
1345 | 1344 | */ |
1346 | 1345 | public function __construct($parent, $itemID) { |
1347 | 1346 | $this->parent = $parent; |
@@ -1410,7 +1409,7 @@ discard block |
||
1410 | 1409 | * Action to handle editing of a single file |
1411 | 1410 | * |
1412 | 1411 | * @param SS_HTTPRequest $request |
1413 | - * @return ViewableData_Customised |
|
1412 | + * @return HTMLText |
|
1414 | 1413 | */ |
1415 | 1414 | public function edit(SS_HTTPRequest $request) { |
1416 | 1415 | // Check form field state |
@@ -47,6 +47,7 @@ discard block |
||
47 | 47 | /** |
48 | 48 | * Clear the aggregate cache for a given type, or pass nothing to clear all aggregate caches. |
49 | 49 | * {@link $class} is just effective if the cache backend supports tags. |
50 | + * @param string $class |
|
50 | 51 | */ |
51 | 52 | public static function flushCache($class=null) { |
52 | 53 | $cache = self::cache(); |
@@ -85,7 +86,7 @@ discard block |
||
85 | 86 | * Build the SQLSelect to calculate the aggregate |
86 | 87 | * This is a seperate function so that subtypes of Aggregate can change just this bit |
87 | 88 | * @param string $attr - the SQL field statement for selection (i.e. "MAX(LastUpdated)") |
88 | - * @return SQLSelect |
|
89 | + * @return DataList |
|
89 | 90 | */ |
90 | 91 | protected function query($attr) { |
91 | 92 | $query = DataList::create($this->type)->where($this->filter); |
@@ -152,7 +152,7 @@ |
||
152 | 152 | /** |
153 | 153 | * Returns the timestamp of the time that the database was last built |
154 | 154 | * |
155 | - * @return string Returns the timestamp of the time that the database was |
|
155 | + * @return integer|null Returns the timestamp of the time that the database was |
|
156 | 156 | * last built |
157 | 157 | */ |
158 | 158 | public static function lastBuilt() { |
@@ -217,9 +217,8 @@ discard block |
||
217 | 217 | * Given the database configuration, this method will create the correct |
218 | 218 | * subclass of {@link SS_Database}. |
219 | 219 | * |
220 | - * @param array $database A map of options. The 'type' is the name of the subclass of SS_Database to use. For the |
|
220 | + * @param array $databaseConfig A map of options. The 'type' is the name of the subclass of SS_Database to use. For the |
|
221 | 221 | * rest of the options, see the specific class. |
222 | - * @param string $name identifier for the connection |
|
223 | 222 | * |
224 | 223 | * @return SS_Database |
225 | 224 | */ |
@@ -413,7 +412,7 @@ discard block |
||
413 | 412 | |
414 | 413 | /** |
415 | 414 | * Create a new table. |
416 | - * @param string $tableName The name of the table |
|
415 | + * @param string $table The name of the table |
|
417 | 416 | * @param array$fields A map of field names to field types |
418 | 417 | * @param array $indexes A map of indexes |
419 | 418 | * @param array $options An map of additional options. The available keys are as follows: |
@@ -500,6 +499,8 @@ discard block |
||
500 | 499 | |
501 | 500 | /** |
502 | 501 | * @deprecated since version 4.0 Use DB::require_field instead |
502 | + * @param string $field |
|
503 | + * @param string $spec |
|
503 | 504 | */ |
504 | 505 | public static function requireField($table, $field, $spec) { |
505 | 506 | Deprecation::notice('4.0', 'Use DB::require_field instead'); |
@@ -563,7 +564,7 @@ discard block |
||
563 | 564 | /** |
564 | 565 | * Checks a table's integrity and repairs it if necessary. |
565 | 566 | * |
566 | - * @param string $tableName The name of the table. |
|
567 | + * @param string $table The name of the table. |
|
567 | 568 | * @return boolean Return true if the table has integrity after the method is complete. |
568 | 569 | */ |
569 | 570 | public static function check_and_repair_table($table) { |
@@ -115,6 +115,9 @@ |
||
115 | 115 | $this->query("ALTER TABLE \"$tableName\" $alterations"); |
116 | 116 | } |
117 | 117 | |
118 | + /** |
|
119 | + * @param string $tableName |
|
120 | + */ |
|
118 | 121 | public function isView($tableName) { |
119 | 122 | $info = $this->query("SHOW /*!50002 FULL*/ TABLES LIKE '$tableName'")->record(); |
120 | 123 | return $info && strtoupper($info['Table_type']) == 'VIEW'; |
@@ -52,6 +52,9 @@ |
||
52 | 52 | return 0; |
53 | 53 | } |
54 | 54 | |
55 | + /** |
|
56 | + * @param integer $value |
|
57 | + */ |
|
55 | 58 | public function prepValueForDB($value) { |
56 | 59 | if($value === true) { |
57 | 60 | return 1; |