Completed
Pull Request — 3.7 (#8242)
by Sam
09:16
created
forms/DatetimeField.php 1 patch
Doc Comments   +19 added lines, -4 removed lines patch added patch discarded remove patch
@@ -56,6 +56,10 @@  discard block
 block discarded – undo
56 56
 	 */
57 57
 	protected $config;
58 58
 
59
+	/**
60
+	 * @param string $name
61
+	 * @param string $title
62
+	 */
59 63
 	public function __construct($name, $title = null, $value = ""){
60 64
 		$this->config = $this->config()->default_config;
61 65
 
@@ -68,6 +72,9 @@  discard block
 block discarded – undo
68 72
 		parent::__construct($name, $title, $value);
69 73
 	}
70 74
 
75
+	/**
76
+	 * @param Form $form
77
+	 */
71 78
 	public function setForm($form) {
72 79
 		parent::setForm($form);
73 80
 
@@ -78,6 +85,9 @@  discard block
 block discarded – undo
78 85
 		return $this;
79 86
 	}
80 87
 
88
+	/**
89
+	 * @param string $name
90
+	 */
81 91
 	public function setName($name) {
82 92
 		parent::setName($name);
83 93
 
@@ -90,7 +100,7 @@  discard block
 block discarded – undo
90 100
 
91 101
 	/**
92 102
 	 * @param array $properties
93
-	 * @return HTMLText
103
+	 * @return string
94 104
 	 */
95 105
 	public function FieldHolder($properties = array()) {
96 106
 		$config = array(
@@ -105,7 +115,7 @@  discard block
 block discarded – undo
105 115
 
106 116
 	/**
107 117
 	 * @param array $properties
108
-	 * @return HTMLText
118
+	 * @return string
109 119
 	 */
110 120
 	public function Field($properties = array()) {
111 121
 		Requirements::css(FRAMEWORK_DIR . '/css/DatetimeField.css');
@@ -234,6 +244,7 @@  discard block
 block discarded – undo
234 244
 
235 245
 	/**
236 246
 	 * @param FormField
247
+	 * @param DateField $field
237 248
 	 */
238 249
 	public function setDateField($field) {
239 250
 		$expected = $this->getName() . '[date]';
@@ -259,6 +270,7 @@  discard block
 block discarded – undo
259 270
 
260 271
 	/**
261 272
 	 * @param FormField
273
+	 * @param TimeField $field
262 274
 	 */
263 275
 	public function setTimeField($field) {
264 276
 		$expected = $this->getName() . '[time]';
@@ -297,7 +309,7 @@  discard block
 block discarded – undo
297 309
 	 * to set field-specific config options.
298 310
 	 *
299 311
 	 * @param string $name
300
-	 * @param mixed $val
312
+	 * @param string $val
301 313
 	 */
302 314
 	public function setConfig($name, $val) {
303 315
 		$this->config[$name] = $val;
@@ -315,7 +327,7 @@  discard block
 block discarded – undo
315 327
 	 * to get field-specific config options.
316 328
 	 *
317 329
 	 * @param String $name Optional, returns the whole configuration array if empty
318
-	 * @return mixed
330
+	 * @return string|null
319 331
 	 */
320 332
 	public function getConfig($name = null) {
321 333
 		if($name) {
@@ -325,6 +337,9 @@  discard block
 block discarded – undo
325 337
 		}
326 338
 	}
327 339
 
340
+	/**
341
+	 * @param RequiredFields $validator
342
+	 */
328 343
 	public function validate($validator) {
329 344
 		$dateValid = $this->dateField->validate($validator);
330 345
 		$timeValid = $this->timeField->validate($validator);
Please login to merge, or discard this patch.
forms/gridfield/GridFieldPaginator.php 1 patch
Doc Comments   +3 added lines patch added patch discarded remove patch
@@ -50,6 +50,7 @@  discard block
 block discarded – undo
50 50
 	 *
51 51
 	 * By default, this is set to true so that it's clearer what's happening, but the predefined
52 52
 	 * {@link GridFieldConfig} subclasses set this to false for flexibility.
53
+	 * @param boolean $throwExceptionOnBadDataType
53 54
 	 */
54 55
 	public function setThrowExceptionOnBadDataType($throwExceptionOnBadDataType) {
55 56
 		$this->throwExceptionOnBadDataType = $throwExceptionOnBadDataType;
@@ -65,6 +66,7 @@  discard block
 block discarded – undo
65 66
 	/**
66 67
 	 * Check that this dataList is of the right data type.
67 68
 	 * Returns false if it's a bad data type, and if appropriate, throws an exception.
69
+	 * @param SS_List $dataList
68 70
 	 */
69 71
 	protected function checkDataType($dataList) {
70 72
 		if($dataList instanceof SS_Limitable) {
@@ -271,6 +273,7 @@  discard block
 block discarded – undo
271 273
 
272 274
 	/**
273 275
 	 * @param Int
276
+	 * @param integer $num
274 277
 	 */
275 278
 	public function setItemsPerPage($num) {
276 279
 		$this->itemsPerPage = $num;
Please login to merge, or discard this patch.
model/fieldtypes/DBInt.php 1 patch
Doc Comments   +3 added lines patch added patch discarded remove patch
@@ -52,6 +52,9 @@
 block discarded – undo
52 52
 		return 0;
53 53
 	}
54 54
 
55
+	/**
56
+	 * @param integer $value
57
+	 */
55 58
 	public function prepValueForDB($value) {
56 59
 		if($value === true) {
57 60
 			return 1;
Please login to merge, or discard this patch.
model/Versioned.php 1 patch
Doc Comments   +6 added lines, -6 removed lines patch added patch discarded remove patch
@@ -765,7 +765,7 @@  discard block
 block discarded – undo
765 765
 	 * Extend permissions to include additional security for objects that are not published to live.
766 766
 	 *
767 767
 	 * @param Member $member
768
-	 * @return bool|null
768
+	 * @return false|null
769 769
 	 */
770 770
 	public function canView($member = null) {
771 771
 		// Invoke default version-gnostic canView
@@ -839,7 +839,7 @@  discard block
 block discarded – undo
839 839
 	 *
840 840
 	 * @param string $stage
841 841
 	 * @param Member $member
842
-	 * @return bool
842
+	 * @return boolean|string
843 843
 	 */
844 844
 	public function canViewStage($stage = 'Live', $member = null) {
845 845
 		$oldMode = Versioned::get_reading_mode();
@@ -905,7 +905,7 @@  discard block
 block discarded – undo
905 905
 	/**
906 906
 	 * Is the latest version of the object published?
907 907
 	 *
908
-	 * @return bool
908
+	 * @return string
909 909
 	 */
910 910
 	public function latestPublished() {
911 911
 		// Get the root data object class - this will have the version field
@@ -1029,7 +1029,7 @@  discard block
 block discarded – undo
1029 1029
 	 * @param string $limit
1030 1030
 	 * @param string $join Deprecated, use leftJoin($table, $joinClause) instead
1031 1031
 	 * @param string $having
1032
-	 * @return DataList
1032
+	 * @return ArrayList
1033 1033
 	 */
1034 1034
 	public function Versions($filter = "", $sort = "", $limit = "", $join = "", $having = "") {
1035 1035
 		return $this->allVersions($filter, $sort, $limit, $join, $having);
@@ -1043,7 +1043,7 @@  discard block
 block discarded – undo
1043 1043
 	 * @param  string $limit
1044 1044
 	 * @param  string $join Deprecated, use leftJoin($table, $joinClause) instead
1045 1045
 	 * @param  string $having
1046
-	 * @return DataList
1046
+	 * @return ArrayList
1047 1047
 	 */
1048 1048
 	public function allVersions($filter = "", $sort = "", $limit = "", $join = "", $having = "") {
1049 1049
 		// Make sure the table names are not postfixed (e.g. _Live)
@@ -1361,7 +1361,7 @@  discard block
 block discarded – undo
1361 1361
 	 * @param string     $filter         A filter to be inserted into the WHERE clause.
1362 1362
 	 * @param string     $sort           A sort expression to be inserted into the ORDER BY clause.
1363 1363
 	 * @param string     $join           Deprecated, use leftJoin($table, $joinClause) instead
1364
-	 * @param string|int $limit          A limit on the number of records returned from the database.
1364
+	 * @param integer $limit          A limit on the number of records returned from the database.
1365 1365
 	 * @param string     $containerClass The container class for the result set (default is DataList)
1366 1366
 	 *
1367 1367
 	 * @return DataList A modified DataList designated to the specified stage
Please login to merge, or discard this patch.
tests/forms/RequirementsTest.php 1 patch
Doc Comments   +14 added lines patch added patch discarded remove patch
@@ -51,6 +51,9 @@  discard block
 block discarded – undo
51 51
 		);
52 52
 	}
53 53
 
54
+	/**
55
+	 * @param Requirements_Backend $backend
56
+	 */
54 57
 	protected function setupCombinedRequirements($backend) {
55 58
 		$basePath = $this->getCurrentRelativePath();
56 59
 
@@ -76,6 +79,9 @@  discard block
 block discarded – undo
76 79
 		);
77 80
 	}
78 81
 
82
+	/**
83
+	 * @param Requirements_Backend $backend
84
+	 */
79 85
 	protected function setupCombinedNonrequiredRequirements($backend) {
80 86
 			$basePath = $this->getCurrentRelativePath();
81 87
 
@@ -482,6 +488,10 @@  discard block
 block discarded – undo
482 488
 		$this->assertContains('var myvar="<head></head>";', $backend->includeInHTML(false, $template));
483 489
 	}
484 490
 
491
+	/**
492
+	 * @param Requirements_Backend $backend
493
+	 * @param string $type
494
+	 */
485 495
 	public function assertFileIncluded($backend, $type, $files) {
486 496
 		$type = strtolower($type);
487 497
 		switch (strtolower($type)) {
@@ -526,6 +536,10 @@  discard block
 block discarded – undo
526 536
 		}
527 537
 	}
528 538
 
539
+	/**
540
+	 * @param Requirements_Backend $backend
541
+	 * @param string $type
542
+	 */
529 543
 	public function assertFileNotIncluded($backend, $type, $files) {
530 544
 		$type = strtolower($type);
531 545
 		switch ($type) {
Please login to merge, or discard this patch.
forms/gridfield/GridFieldFilterHeader.php 1 patch
Doc Comments   +2 added lines patch added patch discarded remove patch
@@ -23,6 +23,7 @@  discard block
 block discarded – undo
23 23
 	 *
24 24
 	 * By default, this is set to true so that it's clearer what's happening, but the predefined
25 25
 	 * {@link GridFieldConfig} subclasses set this to false for flexibility.
26
+	 * @param boolean $throwExceptionOnBadDataType
26 27
 	 */
27 28
 	public function setThrowExceptionOnBadDataType($throwExceptionOnBadDataType) {
28 29
 		$this->throwExceptionOnBadDataType = $throwExceptionOnBadDataType;
@@ -38,6 +39,7 @@  discard block
 block discarded – undo
38 39
 	/**
39 40
 	 * Check that this dataList is of the right data type.
40 41
 	 * Returns false if it's a bad data type, and if appropriate, throws an exception.
42
+	 * @param SS_List $dataList
41 43
 	 */
42 44
 	protected function checkDataType($dataList) {
43 45
 		if($dataList instanceof SS_Filterable) {
Please login to merge, or discard this patch.
model/DataQuery.php 1 patch
Doc Comments   +9 added lines, -2 removed lines patch added patch discarded remove patch
@@ -44,6 +44,7 @@  discard block
 block discarded – undo
44 44
 	 * Create a new DataQuery.
45 45
 	 *
46 46
 	 * @param string The name of the DataObject class that you wish to query
47
+	 * @param string $dataClass
47 48
 	 */
48 49
 	public function __construct($dataClass) {
49 50
 		$this->dataClass = $dataClass;
@@ -175,7 +176,7 @@  discard block
 block discarded – undo
175 176
 	/**
176 177
 	 * Ensure that the query is ready to execute.
177 178
 	 *
178
-	 * @param array|null $queriedColumns Any columns to filter the query by
179
+	 * @param string[] $queriedColumns Any columns to filter the query by
179 180
 	 * @return SQLQuery The finalised sql query
180 181
 	 */
181 182
 	public function getFinalisedQuery($queriedColumns = null) {
@@ -693,7 +694,7 @@  discard block
 block discarded – undo
693 694
 	 * mappings to the query object state. This has to be called
694 695
 	 * in any overloaded {@link SearchFilter->apply()} methods manually.
695 696
 	 *
696
-	 * @param string|array $relation The array/dot-syntax relation to follow
697
+	 * @param string $relation The array/dot-syntax relation to follow
697 698
 	 * @return string The model class of the related item
698 699
 	 */
699 700
 	public function applyRelation($relation) {
@@ -935,6 +936,9 @@  discard block
 block discarded – undo
935 936
 	 */
936 937
 	protected $whereQuery;
937 938
 
939
+	/**
940
+	 * @param string $connective
941
+	 */
938 942
 	public function __construct(DataQuery $base, $connective) {
939 943
 		$this->dataClass = $base->dataClass;
940 944
 		$this->query = $base->query;
@@ -944,6 +948,9 @@  discard block
 block discarded – undo
944 948
 		$base->where($this);
945 949
 	}
946 950
 
951
+	/**
952
+	 * @param string $filter
953
+	 */
947 954
 	public function where($filter) {
948 955
 		if($filter) {
949 956
 			$this->whereQuery->addWhere($filter);
Please login to merge, or discard this patch.
security/MemberAuthenticator.php 1 patch
Doc Comments   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -145,7 +145,7 @@  discard block
 block discarded – undo
145 145
 	 * @param Form $form Optional: If passed, better error messages can be
146 146
 	 *                             produced by using
147 147
 	 *                             {@link Form::sessionMessage()}
148
-	 * @return bool|Member Returns FALSE if authentication fails, otherwise
148
+	 * @return Member|null Returns FALSE if authentication fails, otherwise
149 149
 	 *                     the member object
150 150
 	 * @see Security::setDefaultAdmin()
151 151
 	 */
@@ -186,7 +186,7 @@  discard block
 block discarded – undo
186 186
 	/**
187 187
 	 * Method that creates the login form for this authentication method
188 188
 	 *
189
-	 * @param Controller The parent controller, necessary to create the
189
+	 * @param Controller Controller parent controller, necessary to create the
190 190
 	 *                   appropriate form action tag
191 191
 	 * @return MemberLoginForm Returns the login form to use with this authentication
192 192
 	 *              method
Please login to merge, or discard this patch.
dev/Backtrace.php 1 patch
Doc Comments   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -115,7 +115,7 @@  discard block
 block discarded – undo
115 115
 	 *
116 116
 	 * @param unknown_type $returnVal
117 117
 	 * @param unknown_type $ignoreAjax
118
-	 * @return unknown
118
+	 * @return string|null
119 119
 	 */
120 120
 	public static function backtrace($returnVal = false, $ignoreAjax = false, $ignoredFunctions = null) {
121 121
 		$plainText = Director::is_cli() || (Director::is_ajax() && !$ignoreAjax);
@@ -132,7 +132,7 @@  discard block
 block discarded – undo
132 132
 	 * shown
133 133
 	 *
134 134
 	 * @param SS_Object $item
135
-	 * @param boolean $showArg
135
+	 * @param boolean $showArgs
136 136
 	 * @param Int $argCharLimit
137 137
 	 * @return String
138 138
 	 */
Please login to merge, or discard this patch.