Completed
Pull Request — master (#5824)
by Sam
11:23
created
forms/MemberDatetimeOptionsetField.php 1 patch
Doc Comments   +3 added lines patch added patch discarded remove patch
@@ -105,6 +105,9 @@
 block discarded – undo
105 105
 		return $this->descriptionTemplate;
106 106
 	}
107 107
 
108
+	/**
109
+	 * @param string $template
110
+	 */
108 111
 	public function setDescriptionTemplate($template) {
109 112
 		$this->descriptionTemplate = $template;
110 113
 	}
Please login to merge, or discard this patch.
ORM/ArrayList.php 1 patch
Doc Comments   +2 added lines, -6 removed lines patch added patch discarded remove patch
@@ -379,7 +379,7 @@  discard block
 block discarded – undo
379 379
 	 *
380 380
 	 * Note that columns may be double quoted as per ANSI sql standard
381 381
 	 *
382
-	 * @return DataList
382
+	 * @return ArrayList
383 383
 	 * @see SS_List::sort()
384 384
 	 * @example $list->sort('Name'); // default ASC sorting
385 385
 	 * @example $list->sort('Name DESC'); // DESC sorting
@@ -515,7 +515,7 @@  discard block
 block discarded – undo
515 515
 	 *          $list = $list->filterAny(array('Name'=>array('bob','phil'), 'Age'=>array(21, 43)));
516 516
 	 *
517 517
 	 * @param string|array See {@link filter()}
518
-	 * @return DataList
518
+	 * @return ArrayList
519 519
 	 */
520 520
 	public function filterAny() {
521 521
 		$keepUs = call_user_func_array(array($this, 'normaliseFilterArgs'), func_get_args());
@@ -666,7 +666,6 @@  discard block
 block discarded – undo
666 666
 	/**
667 667
 	 * Returns whether an item with $key exists
668 668
 	 *
669
-	 * @param mixed $key
670 669
 	 * @return bool
671 670
 	 */
672 671
 	public function offsetExists($offset) {
@@ -676,7 +675,6 @@  discard block
 block discarded – undo
676 675
 	/**
677 676
 	 * Returns item stored in list with index $key
678 677
 	 *
679
-	 * @param mixed $key
680 678
 	 * @return DataObject
681 679
 	 */
682 680
 	public function offsetGet($offset) {
@@ -686,7 +684,6 @@  discard block
 block discarded – undo
686 684
 	/**
687 685
 	 * Set an item with the key in $key
688 686
 	 *
689
-	 * @param mixed $key
690 687
 	 * @param mixed $value
691 688
 	 */
692 689
 	public function offsetSet($offset, $value) {
@@ -700,7 +697,6 @@  discard block
 block discarded – undo
700 697
 	/**
701 698
 	 * Unset an item with the key in $key
702 699
 	 *
703
-	 * @param mixed $key
704 700
 	 */
705 701
 	public function offsetUnset($offset) {
706 702
 		unset($this->items[$offset]);
Please login to merge, or discard this patch.
tests/forms/RequirementsTest.php 1 patch
Doc Comments   +9 added lines patch added patch discarded remove patch
@@ -118,6 +118,11 @@  discard block
 block discarded – undo
118 118
 		);
119 119
 	}
120 120
 	
121
+	/**
122
+	 * @param Requirements_Backend $backend
123
+	 * @param boolean $async
124
+	 * @param boolean $defer
125
+	 */
121 126
 	protected function setupCombinedRequirementsJavascriptAsyncDefer($backend, $async, $defer) {
122 127
         $basePath = $this->getCurrentRelativePath();
123 128
         $this->setupRequirements($backend);
@@ -805,6 +810,10 @@  discard block
 block discarded – undo
805 810
 		}
806 811
 	}
807 812
 
813
+	/**
814
+	 * @param Requirements_Backend $backend
815
+	 * @param string $type
816
+	 */
808 817
 	public function assertFileNotIncluded($backend, $type, $files) {
809 818
 		$includedFiles = $this->getBackendFiles($backend, $type);
810 819
 		if(is_array($files)) {
Please login to merge, or discard this patch.
forms/CompositeField.php 1 patch
Doc Comments   +1 added lines patch added patch discarded remove patch
@@ -352,6 +352,7 @@
 block discarded – undo
352 352
 	 * the children collection. Doesn't work recursively.
353 353
 	 *
354 354
 	 * @param string|FormField
355
+	 * @param string $field
355 356
 	 * @return int Position in children collection (first position starts with 0). Returns FALSE if the field can't
356 357
 	 *             be found.
357 358
 	 */
Please login to merge, or discard this patch.
forms/SelectionGroup.php 1 patch
Doc Comments   +6 added lines patch added patch discarded remove patch
@@ -152,6 +152,9 @@  discard block
 block discarded – undo
152 152
 		return $this->title;
153 153
 	}
154 154
 
155
+	/**
156
+	 * @param string $title
157
+	 */
155 158
 	function setTitle($title) {
156 159
 		$this->title = $title;
157 160
 		return $this;
@@ -161,6 +164,9 @@  discard block
 block discarded – undo
161 164
 		return $this->value;
162 165
 	}
163 166
 
167
+	/**
168
+	 * @param string $Value
169
+	 */
164 170
 	function setValue($Value) {
165 171
 		$this->value = $Value;
166 172
 		return $this;
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
@@ -193,7 +193,7 @@  discard block
 block discarded – undo
193 193
 	}
194 194
 
195 195
 	/**
196
-	 * @return ArrayList
196
+	 * @return SilverStripe\ORM\ArrayList
197 197
 	 */
198 198
 	public function getComponents() {
199 199
 		return $this->config->getComponents();
@@ -204,7 +204,7 @@  discard block
 block discarded – undo
204 204
 	 *
205 205
 	 * @todo refactor this into GridFieldComponent
206 206
 	 *
207
-	 * @param mixed $value
207
+	 * @param string $value
208 208
 	 * @param string|array $castingDefinition
209 209
 	 *
210 210
 	 * @return mixed
Please login to merge, or discard this patch.
forms/DatetimeField.php 1 patch
Doc Comments   +18 added lines, -3 removed lines patch added patch discarded remove patch
@@ -63,6 +63,10 @@  discard block
 block discarded – undo
63 63
 	 */
64 64
 	protected $config;
65 65
 
66
+	/**
67
+	 * @param string $name
68
+	 * @param string $title
69
+	 */
66 70
 	public function __construct($name, $title = null, $value = ""){
67 71
 		$this->config = $this->config()->default_config;
68 72
 
@@ -75,6 +79,9 @@  discard block
 block discarded – undo
75 79
 		parent::__construct($name, $title, $value);
76 80
 	}
77 81
 
82
+	/**
83
+	 * @param Form $form
84
+	 */
78 85
 	public function setForm($form) {
79 86
 		parent::setForm($form);
80 87
 
@@ -85,6 +92,9 @@  discard block
 block discarded – undo
85 92
 		return $this;
86 93
 	}
87 94
 
95
+	/**
96
+	 * @param string $name
97
+	 */
88 98
 	public function setName($name) {
89 99
 		parent::setName($name);
90 100
 
@@ -97,7 +107,7 @@  discard block
 block discarded – undo
97 107
 
98 108
 	/**
99 109
 	 * @param array $properties
100
-	 * @return string
110
+	 * @return DBHTMLText
101 111
 	 */
102 112
 	public function FieldHolder($properties = array()) {
103 113
 		$config = array(
@@ -249,6 +259,7 @@  discard block
 block discarded – undo
249 259
 
250 260
 	/**
251 261
 	 * @param FormField
262
+	 * @param DateField $field
252 263
 	 */
253 264
 	public function setDateField($field) {
254 265
 		$expected = $this->getName() . '[date]';
@@ -274,6 +285,7 @@  discard block
 block discarded – undo
274 285
 
275 286
 	/**
276 287
 	 * @param FormField
288
+	 * @param TimeField $field
277 289
 	 */
278 290
 	public function setTimeField($field) {
279 291
 		$expected = $this->getName() . '[time]';
@@ -312,7 +324,7 @@  discard block
 block discarded – undo
312 324
 	 * to set field-specific config options.
313 325
 	 *
314 326
 	 * @param string $name
315
-	 * @param mixed $val
327
+	 * @param string $val
316 328
 	 */
317 329
 	public function setConfig($name, $val) {
318 330
 		$this->config[$name] = $val;
@@ -330,7 +342,7 @@  discard block
 block discarded – undo
330 342
 	 * to get field-specific config options.
331 343
 	 *
332 344
 	 * @param String $name Optional, returns the whole configuration array if empty
333
-	 * @return mixed
345
+	 * @return string|null
334 346
 	 */
335 347
 	public function getConfig($name = null) {
336 348
 		if($name) {
@@ -340,6 +352,9 @@  discard block
 block discarded – undo
340 352
 		}
341 353
 	}
342 354
 
355
+	/**
356
+	 * @param RequiredFields $validator
357
+	 */
343 358
 	public function validate($validator) {
344 359
 		$dateValid = $this->dateField->validate($validator);
345 360
 		$timeValid = $this->timeField->validate($validator);
Please login to merge, or discard this patch.
forms/FileField.php 1 patch
Doc Comments   +1 added lines, -2 removed lines patch added patch discarded remove patch
@@ -87,7 +87,7 @@  discard block
 block discarded – undo
87 87
 
88 88
 	/**
89 89
 	 * @param array $properties
90
-	 * @return string
90
+	 * @return DBHTMLText
91 91
 	 */
92 92
 	public function Field($properties = array()) {
93 93
 		$properties = array_merge($properties, array(
@@ -251,7 +251,6 @@  discard block
 block discarded – undo
251 251
 	 * for each of these categories
252 252
 	 *
253 253
 	 * @param string $category Category name
254
-	 * @param string,... $categories Additional category names
255 254
 	 * @return $this
256 255
 	 */
257 256
 	public function setAllowedFileCategories($category) {
Please login to merge, or discard this patch.
forms/FormAction.php 1 patch
Doc Comments   +2 added lines, -1 removed lines patch added patch discarded remove patch
@@ -93,7 +93,7 @@  discard block
 block discarded – undo
93 93
 
94 94
 	/**
95 95
 	 * @param array $properties
96
-	 * @return string
96
+	 * @return DBHTMLText
97 97
 	 */
98 98
 	public function Field($properties = array()) {
99 99
 		$properties = array_merge(
@@ -158,6 +158,7 @@  discard block
 block discarded – undo
158 158
 	 * Enable or disable the rendering of this action as a <button />
159 159
 	 *
160 160
 	 * @param boolean
161
+	 * @param boolean $bool
161 162
 	 * @return $this
162 163
 	 */
163 164
 	public function setUseButtonTag($bool) {
Please login to merge, or discard this patch.