Completed
Pull Request — master (#4748)
by Michael
10:35
created
core/startup/ParameterConfirmationToken.php 1 patch
Doc Comments   +4 added lines, -1 removed lines patch added patch discarded remove patch
@@ -36,6 +36,9 @@  discard block
 block discarded – undo
36 36
 	 */
37 37
 	protected $token = null;
38 38
 
39
+	/**
40
+	 * @param string $token
41
+	 */
39 42
 	protected function pathForToken($token) {
40 43
 		return TEMP_FOLDER.'/token_'.preg_replace('/[^a-z0-9]+/', '', $token);
41 44
 	}
@@ -235,7 +238,7 @@  discard block
 block discarded – undo
235 238
 	 * Given a list of token names, suppress all tokens that have not been validated, and
236 239
 	 * return the non-validated token with the highest priority
237 240
 	 *
238
-	 * @param array $keys List of token keys in ascending priority (low to high)
241
+	 * @param string[] $keys List of token keys in ascending priority (low to high)
239 242
 	 * @return ParameterConfirmationToken The token container for the unvalidated $key given with the highest priority
240 243
 	 */
241 244
 	public static function prepare_tokens($keys) {
Please login to merge, or discard this patch.
core/TempPath.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -5,7 +5,7 @@
 block discarded – undo
5 5
  * @package framework
6 6
  * @subpackage core
7 7
  *
8
- * @param $base The base path to use for determining the temporary path
8
+ * @param string $base The base path to use for determining the temporary path
9 9
  * @return string Path to temp
10 10
  */
11 11
 function getTempFolder($base = null) {
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
@@ -114,7 +114,7 @@  discard block
 block discarded – undo
114 114
 	 *
115 115
 	 * @param unknown_type $returnVal
116 116
 	 * @param unknown_type $ignoreAjax
117
-	 * @return unknown
117
+	 * @return string|null
118 118
 	 */
119 119
 	public static function backtrace($returnVal = false, $ignoreAjax = false, $ignoredFunctions = null) {
120 120
 		$plainText = Director::is_cli() || (Director::is_ajax() && !$ignoreAjax);
@@ -131,7 +131,7 @@  discard block
 block discarded – undo
131 131
 	 * shown
132 132
 	 *
133 133
 	 * @param Object $item
134
-	 * @param boolean $showArg
134
+	 * @param boolean $showArgs
135 135
 	 * @param Int $argCharLimit
136 136
 	 * @return String
137 137
 	 */
Please login to merge, or discard this patch.
dev/BulkLoader.php 1 patch
Doc Comments   +4 added lines, -4 removed lines patch added patch discarded remove patch
@@ -211,7 +211,7 @@  discard block
 block discarded – undo
211 211
 	 *
212 212
 	 * @todo Mix in custom column mappings
213 213
 	 *
214
-	 * @return array
214
+	 * @return string
215 215
 	 **/
216 216
 	public function getImportSpec() {
217 217
 		$spec = array();
@@ -237,7 +237,7 @@  discard block
 block discarded – undo
237 237
 	 * so this is mainly a customization method.
238 238
 	 *
239 239
 	 * @param mixed $val
240
-	 * @param string $field Name of the field as specified in the array-values for {@link self::$columnMap}.
240
+	 * @param string $fieldName Name of the field as specified in the array-values for {@link self::$columnMap}.
241 241
 	 * @return boolean
242 242
 	 */
243 243
 	protected function isNullValue($val, $fieldName = null) {
@@ -357,7 +357,7 @@  discard block
 block discarded – undo
357 357
 
358 358
 	/**
359 359
 	 * @param $obj DataObject
360
-	 * @param $message string
360
+	 * @param string $message string
361 361
 	 */
362 362
 	public function addCreated($obj, $message = null) {
363 363
 		$this->created[] = $this->lastChange = array(
@@ -370,7 +370,7 @@  discard block
 block discarded – undo
370 370
 
371 371
 	/**
372 372
 	 * @param $obj DataObject
373
-	 * @param $message string
373
+	 * @param string $message string
374 374
 	 */
375 375
 	public function addUpdated($obj, $message = null) {
376 376
 		$this->updated[] = $this->lastChange = array(
Please login to merge, or discard this patch.
dev/CsvBulkLoader.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -93,7 +93,7 @@
 block discarded – undo
93 93
 	 * @param string $path Path to large file to split
94 94
 	 * @param int $lines Number of lines per file
95 95
 	 *
96
-	 * @return array List of file paths
96
+	 * @return string[] List of file paths
97 97
 	 */
98 98
 	protected function splitFile($path, $lines = null) {
99 99
 		$previous = ini_get('auto_detect_line_endings');
Please login to merge, or discard this patch.
dev/CSVParser.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -101,7 +101,7 @@
 block discarded – undo
101 101
 	 *
102 102
 	 * You can use the object returned in a foreach loop to extract the data.
103 103
 	 *
104
-	 * @param $filename The name of the file.  If relative, it will be relative to the site's base dir
104
+	 * @param string $filename The name of the file.  If relative, it will be relative to the site's base dir
105 105
 	 * @param $delimiter The character for seperating columns
106 106
 	 * @param $enclosure The character for quoting or enclosing columns
107 107
 	 */
Please login to merge, or discard this patch.
dev/DebugView.php 1 patch
Doc Comments   +2 added lines patch added patch discarded remove patch
@@ -142,6 +142,8 @@
 block discarded – undo
142 142
 
143 143
 	/**
144 144
 	 * @deprecated 4.0.0:5.0.0 Use renderInfo() instead
145
+	 * @param string $title
146
+	 * @param string|false $subtitle
145 147
 	 */
146 148
 	public function writeInfo($title, $subtitle, $description=false) {
147 149
 		Deprecation::notice('4.0', 'Use renderInfo() instead');
Please login to merge, or discard this patch.
dev/Deprecation.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -72,7 +72,7 @@
 block discarded – undo
72 72
 	 * greater than or equal to this version, a message will be raised
73 73
 	 *
74 74
 	 * @static
75
-	 * @param $ver string -
75
+	 * @param string $ver string -
76 76
 	 *     A php standard version string, see http://php.net/manual/en/function.version-compare.php for details.
77 77
 	 * @param null $forModule string -
78 78
 	 *    The name of a module. The passed version will be used as the check value for
Please login to merge, or discard this patch.
dev/FixtureBlueprint.php 1 patch
Doc Comments   +6 added lines, -1 removed lines patch added patch discarded remove patch
@@ -253,6 +253,9 @@  discard block
 block discarded – undo
253 253
 		return $this;
254 254
 	}
255 255
 
256
+	/**
257
+	 * @param string $type
258
+	 */
256 259
 	protected function invokeCallbacks($type, $args = array()) {
257 260
 		foreach($this->callbacks[$type] as $callback) {
258 261
 			call_user_func_array($callback, $args);
@@ -263,7 +266,6 @@  discard block
 block discarded – undo
263 266
 	 * Parse a value from a fixture file.  If it starts with =>
264 267
 	 * it will get an ID from the fixture dictionary
265 268
 	 *
266
-	 * @param string $fieldVal
267 269
 	 * @param array $fixtures See {@link createObject()}
268 270
 	 * @param string $class If the value parsed is a class relation, this parameter
269 271
 	 * will be given the value of that class's name
@@ -292,6 +294,9 @@  discard block
 block discarded – undo
292 294
 		$obj->$name = $this->parseValue($value, $fixtures);
293 295
 	}
294 296
 
297
+	/**
298
+	 * @param string $fieldName
299
+	 */
295 300
 	protected function overrideField($obj, $fieldName, $value, $fixtures = null) {
296 301
 		$table = ClassInfo::table_for_object_field(get_class($obj), $fieldName);
297 302
 		$value = $this->parseValue($value, $fixtures);
Please login to merge, or discard this patch.