@@ -261,6 +261,9 @@ discard block |
||
| 261 | 261 | |
| 262 | 262 | |
| 263 | 263 | |
| 264 | + /** |
|
| 265 | + * @param boolean $disabled |
|
| 266 | + */ |
|
| 264 | 267 | public function setDisabled($disabled) |
| 265 | 268 | { |
| 266 | 269 | parent::setDisabled($disabled); |
@@ -270,6 +273,9 @@ discard block |
||
| 270 | 273 | return $this; |
| 271 | 274 | } |
| 272 | 275 | |
| 276 | + /** |
|
| 277 | + * @param boolean $readonly |
|
| 278 | + */ |
|
| 273 | 279 | public function setReadonly($readonly) |
| 274 | 280 | { |
| 275 | 281 | parent::setReadonly($readonly); |
@@ -362,6 +368,10 @@ discard block |
||
| 362 | 368 | $this->children->removeByName($fieldName, $dataFieldOnly); |
| 363 | 369 | } |
| 364 | 370 | |
| 371 | + /** |
|
| 372 | + * @param string $fieldName |
|
| 373 | + * @param FormField $newField |
|
| 374 | + */ |
|
| 365 | 375 | public function replaceField($fieldName, $newField) |
| 366 | 376 | { |
| 367 | 377 | return $this->children->replaceField($fieldName, $newField); |
@@ -437,6 +447,9 @@ discard block |
||
| 437 | 447 | return $clone; |
| 438 | 448 | } |
| 439 | 449 | |
| 450 | + /** |
|
| 451 | + * @return boolean |
|
| 452 | + */ |
|
| 440 | 453 | public function IsReadonly() |
| 441 | 454 | { |
| 442 | 455 | return $this->readonly; |
@@ -447,6 +460,7 @@ discard block |
||
| 447 | 460 | * the children collection. Doesn't work recursively. |
| 448 | 461 | * |
| 449 | 462 | * @param string|FormField |
| 463 | + * @param string $field |
|
| 450 | 464 | * @return int Position in children collection (first position starts with 0). Returns FALSE if the field can't |
| 451 | 465 | * be found. |
| 452 | 466 | */ |
@@ -103,6 +103,11 @@ discard block |
||
| 103 | 103 | */ |
| 104 | 104 | protected $valueObj = null; |
| 105 | 105 | |
| 106 | + /** |
|
| 107 | + * @param string $name |
|
| 108 | + * @param string $title |
|
| 109 | + * @param string $value |
|
| 110 | + */ |
|
| 106 | 111 | public function __construct($name, $title = null, $value = null) |
| 107 | 112 | { |
| 108 | 113 | if (!$this->locale) { |
@@ -311,7 +316,7 @@ discard block |
||
| 311 | 316 | } |
| 312 | 317 | |
| 313 | 318 | /** |
| 314 | - * @param mixed $class |
|
| 319 | + * @param string $class |
|
| 315 | 320 | * @return FormField |
| 316 | 321 | */ |
| 317 | 322 | public function castedCopy($class) |
@@ -86,6 +86,9 @@ discard block |
||
| 86 | 86 | $this->sequentialSaveableSet = null; |
| 87 | 87 | } |
| 88 | 88 | |
| 89 | + /** |
|
| 90 | + * @param FormField[] $list |
|
| 91 | + */ |
|
| 89 | 92 | protected function collateDataFields(&$list, $saveableOnly = false) |
| 90 | 93 | { |
| 91 | 94 | foreach ($this as $field) { |
@@ -191,7 +194,7 @@ discard block |
||
| 191 | 194 | * Removes a number of fields from a Tab/TabSet within this FieldList. |
| 192 | 195 | * |
| 193 | 196 | * @param string $tabName The name of the Tab or TabSet field |
| 194 | - * @param array $fields A list of fields, e.g. array('Name', 'Email') |
|
| 197 | + * @param string[] $fields A list of fields, e.g. array('Name', 'Email') |
|
| 195 | 198 | */ |
| 196 | 199 | public function removeFieldsFromTab($tabName, $fields) |
| 197 | 200 | { |
@@ -618,7 +621,7 @@ discard block |
||
| 618 | 621 | } |
| 619 | 622 | |
| 620 | 623 | /** |
| 621 | - * @param $field |
|
| 624 | + * @param CompositeField $field |
|
| 622 | 625 | * @return $this |
| 623 | 626 | */ |
| 624 | 627 | public function setContainerField($field) |
@@ -700,6 +703,7 @@ discard block |
||
| 700 | 703 | * the children collection. Doesn't work recursively. |
| 701 | 704 | * |
| 702 | 705 | * @param string|FormField |
| 706 | + * @param string $field |
|
| 703 | 707 | * @return int Position in children collection (first position starts with 0). |
| 704 | 708 | * Returns FALSE if the field can't be found. |
| 705 | 709 | */ |
@@ -93,7 +93,7 @@ discard block |
||
| 93 | 93 | |
| 94 | 94 | /** |
| 95 | 95 | * @param array $properties |
| 96 | - * @return string |
|
| 96 | + * @return \SilverStripe\ORM\FieldType\DBHTMLText |
|
| 97 | 97 | */ |
| 98 | 98 | public function Field($properties = array()) |
| 99 | 99 | { |
@@ -277,7 +277,6 @@ discard block |
||
| 277 | 277 | * for each of these categories |
| 278 | 278 | * |
| 279 | 279 | * @param string $category Category name |
| 280 | - * @param string,... $categories Additional category names |
|
| 281 | 280 | * @return $this |
| 282 | 281 | */ |
| 283 | 282 | public function setAllowedFileCategories($category) |
@@ -214,6 +214,7 @@ |
||
| 214 | 214 | * Enable or disable the rendering of this action as a <button /> |
| 215 | 215 | * |
| 216 | 216 | * @param boolean |
| 217 | + * @param boolean $bool |
|
| 217 | 218 | * @return $this |
| 218 | 219 | */ |
| 219 | 220 | public function setUseButtonTag($bool) |
@@ -154,7 +154,7 @@ discard block |
||
| 154 | 154 | /** |
| 155 | 155 | * |
| 156 | 156 | * @param GridField $gridField |
| 157 | - * @return array |
|
| 157 | + * @return string[] |
|
| 158 | 158 | */ |
| 159 | 159 | public function getActions($gridField) |
| 160 | 160 | { |
@@ -296,7 +296,7 @@ discard block |
||
| 296 | 296 | } |
| 297 | 297 | |
| 298 | 298 | /** |
| 299 | - * @param array $fields |
|
| 299 | + * @param string[] $fields |
|
| 300 | 300 | * @return $this |
| 301 | 301 | */ |
| 302 | 302 | public function setSearchFields($fields) |
@@ -92,6 +92,9 @@ discard block |
||
| 92 | 92 | parent::__construct(); |
| 93 | 93 | } |
| 94 | 94 | |
| 95 | + /** |
|
| 96 | + * @param string $action |
|
| 97 | + */ |
|
| 95 | 98 | public function Link($action = null) |
| 96 | 99 | { |
| 97 | 100 | return Controller::join_links( |
@@ -341,6 +344,9 @@ discard block |
||
| 341 | 344 | return $c; |
| 342 | 345 | } |
| 343 | 346 | |
| 347 | + /** |
|
| 348 | + * @return string |
|
| 349 | + */ |
|
| 344 | 350 | protected function getBackLink() |
| 345 | 351 | { |
| 346 | 352 | // TODO Coupling with CMS |
@@ -448,6 +454,9 @@ discard block |
||
| 448 | 454 | } |
| 449 | 455 | } |
| 450 | 456 | |
| 457 | + /** |
|
| 458 | + * @param integer $errorCode |
|
| 459 | + */ |
|
| 451 | 460 | public function httpError($errorCode, $errorMessage = null) |
| 452 | 461 | { |
| 453 | 462 | $controller = $this->getToplevelController(); |
@@ -65,7 +65,7 @@ discard block |
||
| 65 | 65 | * Which columns are handled by this component |
| 66 | 66 | * |
| 67 | 67 | * @param GridField $gridField |
| 68 | - * @return array |
|
| 68 | + * @return string[] |
|
| 69 | 69 | */ |
| 70 | 70 | public function getColumnsHandled($gridField) |
| 71 | 71 | { |
@@ -87,7 +87,7 @@ discard block |
||
| 87 | 87 | * @param GridField $gridField |
| 88 | 88 | * @param DataObject $record |
| 89 | 89 | * @param string $columnName |
| 90 | - * @return string The HTML for the column |
|
| 90 | + * @return \SilverStripe\ORM\FieldType\DBHTMLText The HTML for the column |
|
| 91 | 91 | */ |
| 92 | 92 | public function getColumnContent($gridField, $record, $columnName) |
| 93 | 93 | { |
@@ -75,7 +75,7 @@ discard block |
||
| 75 | 75 | * export is an action button |
| 76 | 76 | * |
| 77 | 77 | * @param GridField $gridField |
| 78 | - * @return array |
|
| 78 | + * @return string[] |
|
| 79 | 79 | */ |
| 80 | 80 | public function getActions($gridField) |
| 81 | 81 | { |
@@ -149,7 +149,7 @@ discard block |
||
| 149 | 149 | * Generate export fields for CSV. |
| 150 | 150 | * |
| 151 | 151 | * @param GridField $gridField |
| 152 | - * @return array |
|
| 152 | + * @return string |
|
| 153 | 153 | */ |
| 154 | 154 | public function generateExportFileData($gridField) |
| 155 | 155 | { |