Completed
Pull Request — 3.3 (#6342)
by Damian
07:25
created
forms/FormAction.php 1 patch
Doc Comments   +3 added lines, -2 removed lines patch added patch discarded remove patch
@@ -76,7 +76,7 @@  discard block
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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) {
Please login to merge, or discard this patch.
forms/FormScaffolder.php 1 patch
Doc Comments   -1 removed lines patch added patch discarded remove patch
@@ -49,7 +49,6 @@
 block discarded – undo
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;
Please login to merge, or discard this patch.
forms/gridfield/GridField.php 1 patch
Doc Comments   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -197,7 +197,7 @@  discard block
 block discarded – undo
197 197
 	 *
198 198
 	 * @todo refactor this into GridFieldComponent
199 199
 	 *
200
-	 * @param mixed $value
200
+	 * @param string $value
201 201
 	 * @param string|array $castingDefinition
202 202
 	 *
203 203
 	 * @return mixed
@@ -569,7 +569,7 @@  discard block
 block discarded – undo
569 569
 	 * @param int $index
570 570
 	 * @param DataObject $record
571 571
 	 *
572
-	 * @return array
572
+	 * @return string[]
573 573
 	 */
574 574
 	protected function newRowClasses($total, $index, $record) {
575 575
 		$classes = array('ss-gridfield-item');
Please login to merge, or discard this patch.
forms/gridfield/GridFieldAddExistingAutocompleter.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -129,7 +129,7 @@
 block discarded – undo
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');
Please login to merge, or discard this patch.
forms/gridfield/GridFieldComponent.php 1 patch
Doc Comments   +4 added lines, -1 removed lines patch added patch discarded remove patch
@@ -33,6 +33,7 @@  discard block
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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
 block discarded – undo
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);
Please login to merge, or discard this patch.
forms/gridfield/GridFieldConfig.php 1 patch
Doc Comments   +2 added lines patch added patch discarded remove patch
@@ -78,6 +78,7 @@  discard block
 block discarded – undo
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
 block discarded – undo
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) {
Please login to merge, or discard this patch.
forms/gridfield/GridFieldDataColumns.php 1 patch
Doc Comments   +2 added lines, -1 removed lines patch added patch discarded remove patch
@@ -70,6 +70,7 @@  discard block
 block discarded – undo
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
 block discarded – undo
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) {
Please login to merge, or discard this patch.
forms/gridfield/GridFieldDeleteAction.php 1 patch
Doc Comments   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -80,7 +80,7 @@  discard block
 block discarded – undo
80 80
 	 * Which columns are handled by this component
81 81
 	 *
82 82
 	 * @param GridField $gridField
83
-	 * @return array
83
+	 * @return string[]
84 84
 	 */
85 85
 	public function getColumnsHandled($gridField) {
86 86
 		return array('Actions');
@@ -90,7 +90,7 @@  discard block
 block discarded – undo
90 90
 	 * Which GridField actions are this component handling
91 91
 	 *
92 92
 	 * @param GridField $gridField
93
-	 * @return array
93
+	 * @return string[]
94 94
 	 */
95 95
 	public function getActions($gridField) {
96 96
 		return array('deleterecord', 'unlinkrelation');
Please login to merge, or discard this patch.
forms/gridfield/GridFieldEditButton.php 1 patch
Doc Comments   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -55,7 +55,7 @@  discard block
 block discarded – undo
55 55
 	 * Which columns are handled by this component
56 56
 	 *
57 57
 	 * @param GridField $gridField
58
-	 * @return array
58
+	 * @return string[]
59 59
 	 */
60 60
 	public function getColumnsHandled($gridField) {
61 61
 		return array('Actions');
@@ -76,7 +76,7 @@  discard block
 block discarded – undo
76 76
 	 * @param DataObject $record
77 77
 	 * @param string $columnName
78 78
 	 *
79
-	 * @return string - the HTML for the column
79
+	 * @return HTMLText - the HTML for the column
80 80
 	 */
81 81
 	public function getColumnContent($gridField, $record, $columnName) {
82 82
 		// No permission checks, handled through GridFieldDetailForm,
Please login to merge, or discard this patch.