Completed
Pull Request — master (#5258)
by Sean
11:38
created
model/FieldType/DBMoney.php 1 patch
Doc Comments   +8 added lines, -1 removed lines patch added patch discarded remove patch
@@ -101,6 +101,7 @@  discard block
 block discarded – undo
101 101
 
102 102
 	/**
103 103
 	 * @param string
104
+	 * @param string|null $currency
104 105
 	 */
105 106
 	public function setCurrency($currency, $markChanged = true) {
106 107
 		$this->setField('Currency', $currency, $markChanged);
@@ -151,6 +152,8 @@  discard block
 block discarded – undo
151 152
 	}
152 153
 
153 154
 	/**
155
+	 * @param string $currency
156
+	 * @param string $locale
154 157
 	 * @return string
155 158
 	 */
156 159
 	public function getSymbol($currency = null, $locale = null) {
@@ -162,6 +165,8 @@  discard block
 block discarded – undo
162 165
 	}
163 166
 
164 167
 	/**
168
+	 * @param string $currency
169
+	 * @param string $locale
165 170
 	 * @return string
166 171
 	 */
167 172
 	public function getShortName($currency = null, $locale = null) {
@@ -172,6 +177,8 @@  discard block
 block discarded – undo
172 177
 	}
173 178
 
174 179
 	/**
180
+	 * @param string $currency
181
+	 * @param string $locale
175 182
 	 * @return string
176 183
 	 */
177 184
 	public function getCurrencyName($currency = null, $locale = null) {
@@ -202,7 +209,7 @@  discard block
 block discarded – undo
202 209
 	 * Used by {@link SearchContext}, {@link ModelAdmin}, {@link DataObject::scaffoldFormFields()}
203 210
 	 *
204 211
 	 * @param string $title Optional. Localized title of the generated instance
205
-	 * @return FormField
212
+	 * @return MoneyField
206 213
 	 */
207 214
 	public function scaffoldFormField($title = null) {
208 215
 		$field = new MoneyField($this->getName());
Please login to merge, or discard this patch.
model/FieldType/DBTime.php 1 patch
Doc Comments   +3 added lines patch added patch discarded remove patch
@@ -55,6 +55,9 @@
 block discarded – undo
55 55
 		if($this->value) return date($format, strtotime($this->value));
56 56
 	}
57 57
 
58
+	/**
59
+	 * @param string[] $parts
60
+	 */
58 61
 	public function TwelveHour( $parts ) {
59 62
 		$hour = $parts[1];
60 63
 		$min = $parts[2];
Please login to merge, or discard this patch.
model/FieldType/DBYear.php 1 patch
Doc Comments   +3 added lines patch added patch discarded remove patch
@@ -18,6 +18,9 @@
 block discarded – undo
18 18
 		DB::require_field($this->tableName, $this->name, $values);
19 19
 	}
20 20
 
21
+	/**
22
+	 * @param string $title
23
+	 */
21 24
 	public function scaffoldFormField($title = null, $params = null) {
22 25
 		$selectBox = new DropdownField($this->name, $title);
23 26
 		$selectBox->setSource($this->getDefaultOptions());
Please login to merge, or discard this patch.
view/Requirements.php 1 patch
Doc Comments   +5 added lines, -3 removed lines patch added patch discarded remove patch
@@ -65,6 +65,7 @@  discard block
 block discarded – undo
65 65
 	 * while automatically busting this cache every time the file is changed.
66 66
 	 *
67 67
 	 * @param bool
68
+	 * @param boolean $var
68 69
 	 */
69 70
 	public static function set_suffix_requirements($var) {
70 71
 		self::backend()->setSuffixRequirements($var);
@@ -329,7 +330,7 @@  discard block
 block discarded – undo
329 330
 	 * </code>
330 331
 	 *
331 332
 	 * @param string $combinedFileName Filename of the combined file relative to docroot
332
-	 * @param array  $files            Array of filenames relative to docroot
333
+	 * @param string[]  $files            Array of filenames relative to docroot
333 334
 	 * @param string $media
334 335
 	 *
335 336
 	 * @return bool|void
@@ -754,6 +755,7 @@  discard block
 block discarded – undo
754 755
 	 * Forces the JavaScript requirements to the end of the body, right before the closing tag
755 756
 	 *
756 757
 	 * @param bool
758
+	 * @param boolean $var
757 759
 	 * @return $this
758 760
 	 */
759 761
 	public function setForceJSToBottom($var) {
@@ -1611,8 +1613,8 @@  discard block
 block discarded – undo
1611 1613
 	/**
1612 1614
 	 * Given a filename and list of files, generate a new filename unique to these files
1613 1615
 	 *
1614
-	 * @param string $name
1615
-	 * @param array $files
1616
+	 * @param array $fileList
1617
+	 * @param string $combinedFile
1616 1618
 	 * @return string
1617 1619
 	 */
1618 1620
 	protected function hashedCombinedFilename($combinedFile, $fileList) {
Please login to merge, or discard this patch.
model/Map.php 1 patch
Doc Comments   +4 added lines patch added patch discarded remove patch
@@ -41,6 +41,7 @@  discard block
 block discarded – undo
41 41
 	 * Set the key field for this map.
42 42
 	 *
43 43
 	 * @var string $keyField
44
+	 * @param string $keyField
44 45
 	 */
45 46
 	public function setKeyField($keyField) {
46 47
 		$this->keyField = $keyField;
@@ -50,6 +51,7 @@  discard block
 block discarded – undo
50 51
 	 * Set the value field for this map.
51 52
 	 *
52 53
 	 * @var string $valueField
54
+	 * @param string $valueField
53 55
 	 */
54 56
 	public function setValueField($valueField) {
55 57
 		$this->valueField = $valueField;
@@ -95,6 +97,7 @@  discard block
 block discarded – undo
95 97
 	 *
96 98
 	 * @var string $key
97 99
 	 * @var mixed $value
100
+	 * @param string $value
98 101
 	 */
99 102
 	public function unshift($key, $value) {
100 103
 		$oldItems = $this->firstItems;
@@ -114,6 +117,7 @@  discard block
 block discarded – undo
114 117
 	 *
115 118
 	 * @var string $key
116 119
 	 * @var mixed $value
120
+	 * @param string $value
117 121
 	 */
118 122
 	public function push($key, $value) {
119 123
 		$oldItems = $this->lastItems;
Please login to merge, or discard this patch.
tests/core/ObjectTest.php 1 patch
Doc Comments   +5 added lines patch added patch discarded remove patch
@@ -619,6 +619,11 @@
 block discarded – undo
619 619
 		'ObjectTest_Extending_Extension'
620 620
 	);
621 621
 
622
+	/**
623
+	 * @param integer $first
624
+	 * @param integer $second
625
+	 * @param integer $third
626
+	 */
622 627
 	public function getResults(&$first, &$second, &$third) {
623 628
 		// Before extending should be invoked second
624 629
 		$this->beforeExtending('updateResult', function(&$first, &$second, &$third) {
Please login to merge, or discard this patch.
core/Injectable.php 1 patch
Doc Comments   -3 removed lines patch added patch discarded remove patch
@@ -23,8 +23,6 @@  discard block
 block discarded – undo
23 23
 	 *    $list = DataList::create('SiteTree');
24 24
 	 *	  $list = SiteTree::get();
25 25
 	 *
26
-	 * @param string $class the class name
27
-	 * @param mixed $arguments,... arguments to pass to the constructor
28 26
 	 * @return static
29 27
 	 */
30 28
 	public static function create() {
@@ -47,7 +45,6 @@  discard block
 block discarded – undo
47 45
 	 * way to access instance methods which don't rely on instance
48 46
 	 * data (e.g. the custom SilverStripe static handling).
49 47
 	 *
50
-	 * @param string $className Optional classname (if called on Object directly)
51 48
 	 * @return static The singleton instance
52 49
 	 */
53 50
 	public static function singleton() {
Please login to merge, or discard this patch.
filesystem/Upload.php 1 patch
Doc Comments   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -114,7 +114,7 @@  discard block
 block discarded – undo
114 114
 	 * Set a different instance than {@link Upload_Validator}
115 115
 	 * for this upload session.
116 116
 	 *
117
-	 * @param object $validator
117
+	 * @param Upload_Validator $validator
118 118
 	 */
119 119
 	public function setValidator($validator) {
120 120
 		$this->validator = $validator;
@@ -363,7 +363,7 @@  discard block
 block discarded – undo
363 363
 	/**
364 364
 	 * Determines wether previous operations caused an error.
365 365
 	 *
366
-	 * @return boolean
366
+	 * @return integer
367 367
 	 */
368 368
 	public function isError() {
369 369
 		return (count($this->errors));
Please login to merge, or discard this patch.
forms/FieldList.php 1 patch
Doc Comments   +10 added lines, -2 removed lines patch added patch discarded remove patch
@@ -118,6 +118,7 @@  discard block
 block discarded – undo
118 118
 	 *                        or TabSet.Tab.Subtab.
119 119
 	 * This function will create any missing tabs.
120 120
 	 * @param array $fields An array of {@link FormField} objects.
121
+	 * @param string $insertBefore
121 122
 	 */
122 123
 	public function addFieldsToTab($tabName, $fields, $insertBefore = null) {
123 124
 		$this->flushFieldsCache();
@@ -157,7 +158,7 @@  discard block
 block discarded – undo
157 158
 	 * Removes a number of fields from a Tab/TabSet within this FieldList.
158 159
 	 *
159 160
 	 * @param string $tabName The name of the Tab or TabSet field
160
-	 * @param array $fields A list of fields, e.g. array('Name', 'Email')
161
+	 * @param string[] $fields A list of fields, e.g. array('Name', 'Email')
161 162
 	 */
162 163
 	public function removeFieldsFromTab($tabName, $fields) {
163 164
 		$this->flushFieldsCache();
@@ -440,6 +441,7 @@  discard block
 block discarded – undo
440 441
 
441 442
 	/**
442 443
 	 * Handler method called before the FieldList is going to be manipulated.
444
+	 * @param FormField $item
443 445
 	 */
444 446
 	protected function onBeforeInsert($item) {
445 447
 		$this->flushFieldsCache();
@@ -512,6 +514,7 @@  discard block
 block discarded – undo
512 514
 	 * Transform this FieldList with a given tranform method,
513 515
 	 * e.g. $this->transform(new ReadonlyTransformation())
514 516
 	 *
517
+	 * @param ReadonlyTransformation $trans
515 518
 	 * @return FieldList
516 519
 	 */
517 520
 	public function transform($trans) {
@@ -531,6 +534,9 @@  discard block
 block discarded – undo
531 534
 		else return $this;
532 535
 	}
533 536
 
537
+	/**
538
+	 * @param CompositeField $field
539
+	 */
534 540
 	public function setContainerField($field) {
535 541
 		$this->containerField = $field;
536 542
 		return $this;
@@ -549,6 +555,7 @@  discard block
 block discarded – undo
549 555
 	 * Transform the named field into a readonly feld.
550 556
 	 *
551 557
 	 * @param string|FormField
558
+	 * @param string $field
552 559
 	 */
553 560
 	public function makeFieldReadonly($field) {
554 561
 		$fieldName = ($field instanceof FormField) ? $field->getName() : $field;
@@ -598,6 +605,7 @@  discard block
 block discarded – undo
598 605
 	 * the children collection. Doesn't work recursively.
599 606
 	 *
600 607
 	 * @param string|FormField
608
+	 * @param string $field
601 609
 	 * @return int Position in children collection (first position starts with 0). Returns FALSE if the field can't
602 610
 	 *             be found.
603 611
 	 */
@@ -645,7 +653,7 @@  discard block
 block discarded – undo
645 653
 	 * Support function for backwards compatibility purposes.
646 654
 	 * Caution: Volatile API, might be removed in 3.1 or later.
647 655
 	 *
648
-	 * @param  String $tabname Path to a tab, e.g. "Root.Content.Main"
656
+	 * @param  string $name Path to a tab, e.g. "Root.Content.Main"
649 657
 	 * @return String Rewritten path, based on {@link tabPathRewrites}
650 658
 	 */
651 659
 	protected function rewriteTabPath($name) {
Please login to merge, or discard this patch.