@@ -85,7 +85,7 @@ discard block |
||
| 85 | 85 | |
| 86 | 86 | /** |
| 87 | 87 | * @param array $properties |
| 88 | - * @return HTMLText |
|
| 88 | + * @return string |
|
| 89 | 89 | */ |
| 90 | 90 | public function Field($properties = array()) { |
| 91 | 91 | $properties = array_merge($properties, array( |
@@ -249,7 +249,6 @@ discard block |
||
| 249 | 249 | * for each of these categories |
| 250 | 250 | * |
| 251 | 251 | * @param string $category Category name |
| 252 | - * @param string,... $categories Additional category names |
|
| 253 | 252 | * @return $this |
| 254 | 253 | */ |
| 255 | 254 | public function setAllowedFileCategories($category) { |
@@ -76,7 +76,7 @@ discard block |
||
| 76 | 76 | |
| 77 | 77 | /** |
| 78 | 78 | * @param array $properties |
| 79 | - * @return HTMLText |
|
| 79 | + * @return string |
|
| 80 | 80 | */ |
| 81 | 81 | public function Field($properties = array()) { |
| 82 | 82 | $properties = array_merge( |
@@ -93,7 +93,7 @@ discard block |
||
| 93 | 93 | |
| 94 | 94 | /** |
| 95 | 95 | * @param array $properties |
| 96 | - * @return HTMLText |
|
| 96 | + * @return string |
|
| 97 | 97 | */ |
| 98 | 98 | public function FieldHolder($properties = array()) { |
| 99 | 99 | return $this->Field($properties); |
@@ -157,6 +157,7 @@ discard block |
||
| 157 | 157 | * Enable or disable the rendering of this action as a <button /> |
| 158 | 158 | * |
| 159 | 159 | * @param boolean |
| 160 | + * @param boolean $bool |
|
| 160 | 161 | * @return $this |
| 161 | 162 | */ |
| 162 | 163 | public function setUseButtonTag($bool) { |
@@ -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 | */ |
@@ -1116,6 +1116,7 @@ discard block |
||
| 1116 | 1116 | * @todo Make this abstract. |
| 1117 | 1117 | * |
| 1118 | 1118 | * @param Validator |
| 1119 | + * @param RequiredFields $validator |
|
| 1119 | 1120 | * |
| 1120 | 1121 | * @return bool |
| 1121 | 1122 | */ |
@@ -1185,7 +1186,7 @@ discard block |
||
| 1185 | 1186 | * |
| 1186 | 1187 | * @param FieldList $containerFieldList |
| 1187 | 1188 | * |
| 1188 | - * @return FieldList |
|
| 1189 | + * @return FormField |
|
| 1189 | 1190 | */ |
| 1190 | 1191 | public function setContainerFieldList($containerFieldList) { |
| 1191 | 1192 | $this->containerFieldList = $containerFieldList; |
@@ -49,7 +49,6 @@ |
||
| 49 | 49 | |
| 50 | 50 | /** |
| 51 | 51 | * @param DataObject $obj |
| 52 | - * @param array $params |
|
| 53 | 52 | */ |
| 54 | 53 | public function __construct($obj) { |
| 55 | 54 | $this->obj = $obj; |
@@ -199,7 +199,7 @@ discard block |
||
| 199 | 199 | * |
| 200 | 200 | * @todo refactor this into GridFieldComponent |
| 201 | 201 | * |
| 202 | - * @param mixed $value |
|
| 202 | + * @param string $value |
|
| 203 | 203 | * @param string|array $castingDefinition |
| 204 | 204 | * |
| 205 | 205 | * @return mixed |
@@ -286,7 +286,7 @@ discard block |
||
| 286 | 286 | * |
| 287 | 287 | * @param array $properties |
| 288 | 288 | * |
| 289 | - * @return HTMLText |
|
| 289 | + * @return DBField |
|
| 290 | 290 | */ |
| 291 | 291 | public function FieldHolder($properties = array()) { |
| 292 | 292 | Requirements::css(THIRDPARTY_DIR . '/jquery-ui-themes/smoothness/jquery-ui.css'); |
@@ -571,7 +571,7 @@ discard block |
||
| 571 | 571 | * @param int $index |
| 572 | 572 | * @param DataObject $record |
| 573 | 573 | * |
| 574 | - * @return array |
|
| 574 | + * @return string[] |
|
| 575 | 575 | */ |
| 576 | 576 | protected function newRowClasses($total, $index, $record) { |
| 577 | 577 | $classes = array('ss-gridfield-item'); |
@@ -596,7 +596,7 @@ discard block |
||
| 596 | 596 | /** |
| 597 | 597 | * @param array $properties |
| 598 | 598 | * |
| 599 | - * @return HTMLText |
|
| 599 | + * @return DBField |
|
| 600 | 600 | */ |
| 601 | 601 | public function Field($properties = array()) { |
| 602 | 602 | return $this->FieldHolder($properties); |
@@ -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'); |
@@ -33,6 +33,7 @@ discard block |
||
| 33 | 33 | * If you attempt to return HTML for a fragment that doesn't exist, an |
| 34 | 34 | * exception will be thrown when the {@link GridField} is rendered. |
| 35 | 35 | * |
| 36 | + * @param GridField $gridField |
|
| 36 | 37 | * @return array |
| 37 | 38 | */ |
| 38 | 39 | public function getHTMLFragments($gridField); |
@@ -57,6 +58,7 @@ discard block |
||
| 57 | 58 | * @param GridField $gridField |
| 58 | 59 | * @param arary $columns List of columns |
| 59 | 60 | * @param array - List reference of all column names. |
| 61 | + * @return void |
|
| 60 | 62 | */ |
| 61 | 63 | public function augmentColumns($gridField, &$columns); |
| 62 | 64 | |
@@ -139,6 +141,7 @@ discard block |
||
| 139 | 141 | * @param String Action identifier, see {@link getActions()}. |
| 140 | 142 | * @param Array Arguments relevant for this |
| 141 | 143 | * @param Array All form data |
| 144 | + * @param string $actionName |
|
| 142 | 145 | */ |
| 143 | 146 | public function handleAction(GridField $gridField, $actionName, $arguments, $data); |
| 144 | 147 | } |
@@ -189,6 +192,7 @@ discard block |
||
| 189 | 192 | * |
| 190 | 193 | * Handler methods will be called on the component, rather than the |
| 191 | 194 | * {@link GridField}. |
| 195 | + * @param GridField $gridField |
|
| 192 | 196 | */ |
| 193 | 197 | public function getURLHandlers($gridField); |
| 194 | 198 | } |
@@ -205,7 +209,6 @@ discard block |
||
| 205 | 209 | /** |
| 206 | 210 | * Called when a grid field is saved - i.e. the form is submitted. |
| 207 | 211 | * |
| 208 | - * @param GridField $field |
|
| 209 | 212 | * @param DataObjectInterface $record |
| 210 | 213 | */ |
| 211 | 214 | public function handleSave(GridField $grid, DataObjectInterface $record); |
@@ -78,6 +78,7 @@ discard block |
||
| 78 | 78 | |
| 79 | 79 | /** |
| 80 | 80 | * @param String Class name or interface |
| 81 | + * @param string $type |
|
| 81 | 82 | * @return GridFieldConfig $this |
| 82 | 83 | */ |
| 83 | 84 | public function removeComponentsByType($type) { |
@@ -116,6 +117,7 @@ discard block |
||
| 116 | 117 | * Returns the first available component with the given class or interface. |
| 117 | 118 | * |
| 118 | 119 | * @param String ClassName |
| 120 | + * @param string $type |
|
| 119 | 121 | * @return GridFieldComponent |
| 120 | 122 | */ |
| 121 | 123 | public function getComponentByType($type) { |
@@ -70,6 +70,7 @@ discard block |
||
| 70 | 70 | /** |
| 71 | 71 | * Get the DisplayFields |
| 72 | 72 | * |
| 73 | + * @param GridField $gridField |
|
| 73 | 74 | * @return array |
| 74 | 75 | * @see GridFieldDataColumns::setDisplayFields |
| 75 | 76 | */ |
@@ -174,7 +175,7 @@ discard block |
||
| 174 | 175 | * e.g. to set a title for a search column header. |
| 175 | 176 | * |
| 176 | 177 | * @param GridField $gridField |
| 177 | - * @param string $columnName |
|
| 178 | + * @param string $column |
|
| 178 | 179 | * @return array - Map of arbitrary metadata identifiers to their values. |
| 179 | 180 | */ |
| 180 | 181 | public function getColumnMetadata($gridField, $column) { |