Completed
Push — pulls/3/auto-index-sort ( 612f1d...cde0ad )
by Daniel
08:43
created
admin/code/ModelAdmin.php 1 patch
Doc Comments   +8 added lines, -1 removed lines patch added patch discarded remove patch
@@ -120,6 +120,9 @@  discard block
 block discarded – undo
120 120
 		Requirements::javascript(FRAMEWORK_ADMIN_DIR . '/javascript/ModelAdmin.js');
121 121
 	}
122 122
 
123
+	/**
124
+	 * @param string $action
125
+	 */
123 126
 	public function Link($action = null) {
124 127
 		if(!$action) $action = $this->sanitiseClassName($this->modelClass);
125 128
 		return parent::Link($action);
@@ -219,6 +222,9 @@  discard block
 block discarded – undo
219 222
 		return $form;
220 223
 	}
221 224
 
225
+	/**
226
+	 * @return GridFieldComponent
227
+	 */
222 228
 	public function getList() {
223 229
 		$context = $this->getSearchContext();
224 230
 		$params = $this->getRequest()->requestVar('q');
@@ -274,6 +280,7 @@  discard block
 block discarded – undo
274 280
 
275 281
 	/**
276 282
 	 * Unsanitise a model class' name from a URL param
283
+	 * @param string $class
277 284
 	 * @return string
278 285
 	 */
279 286
 	protected function unsanitiseClassName($class) {
@@ -414,7 +421,7 @@  discard block
 block discarded – undo
414 421
 	 * @param array $data
415 422
 	 * @param Form $form
416 423
 	 * @param SS_HTTPRequest $request
417
-	 * @return bool|null
424
+	 * @return false|null
418 425
 	 */
419 426
 	public function import($data, $form, $request) {
420 427
 		if(!$this->showImportForm || (is_array($this->showImportForm)
Please login to merge, or discard this patch.
thirdparty/Zend/Cache/Backend/Xcache.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -140,7 +140,7 @@
 block discarded – undo
140 140
      * @param  string $mode clean mode
141 141
      * @param  array  $tags array of tags
142 142
      * @throws Zend_Cache_Exception
143
-     * @return boolean true if no problem
143
+     * @return boolean|null true if no problem
144 144
      */
145 145
     public function clean($mode = Zend_Cache::CLEANING_MODE_ALL, $tags = array())
146 146
     {
Please login to merge, or discard this patch.
control/ContentNegotiator.php 1 patch
Doc Comments   +1 added lines patch added patch discarded remove patch
@@ -97,6 +97,7 @@
 block discarded – undo
97 97
 	/**
98 98
 	 * Returns true if negotation is enabled for the given response.
99 99
 	 * By default, negotiation is only enabled for pages that have the xml header.
100
+	 * @param SS_HTTPResponse $response
100 101
 	 */
101 102
 	public static function enabled_for($response) {
102 103
 		$contentType = $response->getHeader("Content-Type");
Please login to merge, or discard this patch.
control/HTTP.php 1 patch
Doc Comments   +11 added lines, -1 removed lines patch added patch discarded remove patch
@@ -99,7 +99,7 @@  discard block
 block discarded – undo
99 99
 	 * @param string|callable $code Either a string that can evaluate to an expression
100 100
 	 * to rewrite links (depreciated), or a callable that takes a single
101 101
 	 * parameter and returns the rewritten URL
102
-	 * @return The content with all links rewritten as per the logic specified in $code
102
+	 * @return string content with all links rewritten as per the logic specified in $code
103 103
 	 */
104 104
 	public static function urlRewriter($content, $code) {
105 105
 		if(!is_callable($code)) {
@@ -243,6 +243,9 @@  discard block
 block discarded – undo
243 243
 		return count($result) ? $result : null;
244 244
 	}
245 245
 
246
+	/**
247
+	 * @param string $content
248
+	 */
246 249
 	public static function getLinksIn($content) {
247 250
 		return self::findByTagAndAttribute($content, array("a" => "href"));
248 251
 	}
@@ -285,6 +288,7 @@  discard block
 block discarded – undo
285 288
 
286 289
 	/**
287 290
 	 * Set the maximum age of this page in web caches, in seconds
291
+	 * @param integer $age
288 292
 	 */
289 293
 	public static function set_cache_age($age) {
290 294
 		self::$cache_age = $age;
@@ -296,11 +300,17 @@  discard block
 block discarded – undo
296 300
 			self::$modification_date = $timestamp;
297 301
 	}
298 302
 
303
+	/**
304
+	 * @param integer $timestamp
305
+	 */
299 306
 	public static function register_modification_timestamp($timestamp) {
300 307
 		if($timestamp > self::$modification_date)
301 308
 			self::$modification_date = $timestamp;
302 309
 	}
303 310
 
311
+	/**
312
+	 * @param string $etag
313
+	 */
304 314
 	public static function register_etag($etag) {
305 315
 		if (0 !== strpos($etag, '"')) {
306 316
 			$etag = sprintf('"%s"', $etag);
Please login to merge, or discard this patch.
control/Session.php 1 patch
Doc Comments   +6 added lines, -1 removed lines patch added patch discarded remove patch
@@ -273,7 +273,6 @@  discard block
 block discarded – undo
273 273
 	 *
274 274
 	 * @deprecated 4.0 Use the "Session.timeout_ips" config setting instead
275 275
 	 *
276
-	 * @param array $session_ips Array of IPv4 rules.
277 276
 	 */
278 277
 	public static function set_timeout_ips($ips) {
279 278
 		Deprecation::notice('4.0', 'Use the "Session.timeout_ips" config setting instead');
@@ -419,6 +418,9 @@  discard block
 block discarded – undo
419 418
 		}
420 419
 	}
421 420
 
421
+	/**
422
+	 * @param string $name
423
+	 */
422 424
 	public function inst_set($name, $val) {
423 425
 		// Quicker execution path for "."-free names
424 426
 		if(strpos($name,'.') === false) {
@@ -467,6 +469,9 @@  discard block
 block discarded – undo
467 469
 		$diffVar[sizeof($var)-1] = $val;
468 470
 	}
469 471
 
472
+	/**
473
+	 * @param string $name
474
+	 */
470 475
 	public function inst_get($name) {
471 476
 		// Quicker execution path for "."-free names
472 477
 		if(strpos($name,'.') === false) {
Please login to merge, or discard this patch.
dev/Debug.php 1 patch
Doc Comments   +14 added lines, -7 removed lines patch added patch discarded remove patch
@@ -226,6 +226,12 @@  discard block
 block discarded – undo
226 226
 		set_exception_handler('exceptionHandler');
227 227
 	}
228 228
 
229
+	/**
230
+	 * @param integer $errno
231
+	 * @param string $errstr
232
+	 * @param string $errfile
233
+	 * @param integer $errline
234
+	 */
229 235
 	public static function noticeHandler($errno, $errstr, $errfile, $errline, $errcontext) {
230 236
 		if(error_reporting() == 0) return;
231 237
 		ini_set('display_errors', 0);
@@ -252,10 +258,10 @@  discard block
 block discarded – undo
252 258
 	/**
253 259
 	 * Handle a non-fatal warning error thrown by PHP interpreter.
254 260
 	 *
255
-	 * @param unknown_type $errno
256
-	 * @param unknown_type $errstr
257
-	 * @param unknown_type $errfile
258
-	 * @param unknown_type $errline
261
+	 * @param integer $errno
262
+	 * @param string $errstr
263
+	 * @param string $errfile
264
+	 * @param integer $errline
259 265
 	 * @param unknown_type $errcontext
260 266
 	 */
261 267
 	public static function warningHandler($errno, $errstr, $errfile, $errline, $errcontext) {
@@ -286,8 +292,8 @@  discard block
 block discarded – undo
286 292
 	 *
287 293
 	 * Runtime execution dies immediately once the error is generated.
288 294
 	 *
289
-	 * @param unknown_type $errno
290
-	 * @param unknown_type $errstr
295
+	 * @param integer $errno
296
+	 * @param string $errstr
291 297
 	 * @param unknown_type $errfile
292 298
 	 * @param unknown_type $errline
293 299
 	 * @param unknown_type $errcontext
@@ -327,7 +333,7 @@  discard block
 block discarded – undo
327 333
 	 *                                     or "tech-speak". Used in the HTTP Header and ajax responses.
328 334
 	 * @param string $friendlyErrorDetail Detailed user-focused message. Is just used if no {@link ErrorPage} is found
329 335
 	 *                                    for this specific status code.
330
-	 * @return string HTML error message for non-ajax requests, plaintext for ajax-request.
336
+	 * @return boolean HTML error message for non-ajax requests, plaintext for ajax-request.
331 337
 	 */
332 338
 	public static function friendlyError($statusCode=500, $friendlyErrorMessage=null, $friendlyErrorDetail=null) {
333 339
 		// Ensure the error message complies with the HTTP 1.1 spec
@@ -399,6 +405,7 @@  discard block
 block discarded – undo
399 405
 	 * @param unknown_type $errfile
400 406
 	 * @param unknown_type $errline
401 407
 	 * @param unknown_type $errcontext
408
+	 * @param string $errtype
402 409
 	 */
403 410
 	public static function showError($errno, $errstr, $errfile, $errline, $errcontext, $errtype) {
404 411
 		if(!headers_sent()) {
Please login to merge, or discard this patch.
dev/FixtureFactory.php 1 patch
Doc Comments   +5 added lines, -4 removed lines patch added patch discarded remove patch
@@ -117,6 +117,7 @@  discard block
 block discarded – undo
117 117
 	/**
118 118
 	 * Return all of the IDs in the fixture of a particular class name.
119 119
 	 *
120
+	 * @param string $class
120 121
 	 * @return A map of fixture-identifier => object-id
121 122
 	 */
122 123
 	public function getIds($class) {
@@ -131,6 +132,7 @@  discard block
 block discarded – undo
131 132
 	 * @param String
132 133
 	 * @param String $identifier
133 134
 	 * @param Int $databaseId
135
+	 * @param string $class
134 136
 	 */
135 137
 	public function setId($class, $identifier, $databaseId) {
136 138
 		$this->fixtures[$class][$identifier] = $databaseId;
@@ -140,8 +142,8 @@  discard block
 block discarded – undo
140 142
 	/**
141 143
 	 * Get an object from the fixture.
142 144
 	 *
143
-	 * @param $class The data class, as specified in your fixture file.  Parent classes won't work
144
-	 * @param $identifier The identifier string, as provided in your fixture file
145
+	 * @param string $class The data class, as specified in your fixture file.  Parent classes won't work
146
+	 * @param string $identifier The identifier string, as provided in your fixture file
145 147
 	 */
146 148
 	public function get($class, $identifier) {
147 149
 		$id = $this->getId($class, $identifier);
@@ -161,7 +163,7 @@  discard block
 block discarded – undo
161 163
 	 * or {@link createRaw()}, both from the internal fixture mapping and the database.
162 164
 	 * If the $class argument is set, limit clearing to items of this class.
163 165
 	 *
164
-	 * @param String $class
166
+	 * @param string $limitToClass
165 167
 	 */
166 168
 	public function clear($limitToClass = null) {
167 169
 		$classes = ($limitToClass) ? array($limitToClass) : array_keys($this->fixtures);
@@ -202,7 +204,6 @@  discard block
 block discarded – undo
202 204
 	 * Parse a value from a fixture file.  If it starts with =>
203 205
 	 * it will get an ID from the fixture dictionary
204 206
 	 *
205
-	 * @param String $fieldVal
206 207
 	 * @return String Fixture database ID, or the original value
207 208
 	 */
208 209
 	protected function parseValue($value) {
Please login to merge, or discard this patch.
filesystem/Folder.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -42,7 +42,7 @@
 block discarded – undo
42 42
 	 *
43 43
 	 * @param $folderPath string Absolute or relative path to the file.
44 44
 	 *  If path is relative, its interpreted relative to the "assets/" directory.
45
-	 * @return Folder|null
45
+	 * @return null|DataObject
46 46
 	 */
47 47
 	public static function find_or_make($folderPath) {
48 48
 		// Create assets directory, if it is missing
Please login to merge, or discard this patch.
forms/gridfield/GridFieldExportButton.php 1 patch
Doc Comments   +3 added lines, -1 removed lines patch added patch discarded remove patch
@@ -82,6 +82,7 @@  discard block
 block discarded – undo
82 82
 
83 83
 	/**
84 84
 	 * Handle the export, for both the action button and the URL
85
+ 	 * @param GridField $gridField
85 86
  	 */
86 87
 	public function handleExport($gridField, $request = null) {
87 88
 		$now = Date("d-m-Y-H-i");
@@ -96,7 +97,7 @@  discard block
 block discarded – undo
96 97
 	 * Generate export fields for CSV.
97 98
 	 *
98 99
 	 * @param GridField $gridField
99
-	 * @return array
100
+	 * @return string
100 101
 	 */
101 102
 	public function generateExportFileData($gridField) {
102 103
 		$separator = $this->csvSeparator;
@@ -206,6 +207,7 @@  discard block
 block discarded – undo
206 207
 
207 208
 	/**
208 209
 	 * @param boolean
210
+	 * @param boolean $bool
209 211
 	 */
210 212
 	public function setCsvHasHeader($bool) {
211 213
 		$this->csvHasHeader = $bool;
Please login to merge, or discard this patch.