@@ -186,7 +186,7 @@ discard block |
||
186 | 186 | } |
187 | 187 | |
188 | 188 | /** |
189 | - * @return null|string |
|
189 | + * @return string |
|
190 | 190 | */ |
191 | 191 | public function getBody() { |
192 | 192 | return $this->body; |
@@ -385,9 +385,9 @@ discard block |
||
385 | 385 | * it's only advisable to send small files through this method. |
386 | 386 | * |
387 | 387 | * @static |
388 | - * @param $fileData |
|
388 | + * @param string $fileData |
|
389 | 389 | * @param $fileName |
390 | - * @param null $mimeType |
|
390 | + * @param string $mimeType |
|
391 | 391 | * @return SS_HTTPResponse |
392 | 392 | */ |
393 | 393 | public static function send_file($fileData, $fileName, $mimeType = null) { |
@@ -605,7 +605,7 @@ discard block |
||
605 | 605 | * This is used by the request handler to prevent infinite parsing loops. |
606 | 606 | * |
607 | 607 | * @param $pattern |
608 | - * @return bool |
|
608 | + * @return boolean|null |
|
609 | 609 | */ |
610 | 610 | public function isEmptyPattern($pattern) { |
611 | 611 | if(preg_match('/^([A-Za-z]+) +(.*)$/', $pattern, $matches)) { |
@@ -109,7 +109,7 @@ discard block |
||
109 | 109 | * No newlines are allowed in the description. |
110 | 110 | * If omitted, will default to the standard HTTP description |
111 | 111 | * for the given $code value (see {@link $status_codes}). |
112 | - * @return SS_HTTPRequest $this |
|
112 | + * @return SS_HTTPResponse $this |
|
113 | 113 | */ |
114 | 114 | public function setStatusCode($code, $description = null) { |
115 | 115 | if(isset(self::$status_codes[$code])) $this->statusCode = $code; |
@@ -125,7 +125,7 @@ discard block |
||
125 | 125 | * Caution: Will be overwritten by {@link setStatusCode()}. |
126 | 126 | * |
127 | 127 | * @param string $description |
128 | - * @return SS_HTTPRequest $this |
|
128 | + * @return SS_HTTPResponse $this |
|
129 | 129 | */ |
130 | 130 | public function setStatusDescription($description) { |
131 | 131 | $this->statusDescription = $description; |
@@ -157,7 +157,7 @@ discard block |
||
157 | 157 | |
158 | 158 | /** |
159 | 159 | * @param string $body |
160 | - * @return SS_HTTPRequest $this |
|
160 | + * @return SS_HTTPResponse $this |
|
161 | 161 | */ |
162 | 162 | public function setBody($body) { |
163 | 163 | $this->body = $body ? (string) $body : $body; // Don't type-cast false-ish values, eg null is null not '' |
@@ -165,7 +165,7 @@ discard block |
||
165 | 165 | } |
166 | 166 | |
167 | 167 | /** |
168 | - * @return null|string |
|
168 | + * @return string |
|
169 | 169 | */ |
170 | 170 | public function getBody() { |
171 | 171 | return $this->body; |
@@ -176,7 +176,7 @@ discard block |
||
176 | 176 | * |
177 | 177 | * @param string $header Example: "Content-Type" |
178 | 178 | * @param string $value Example: "text/xml" |
179 | - * @return SS_HTTPRequest $this |
|
179 | + * @return SS_HTTPResponse $this |
|
180 | 180 | */ |
181 | 181 | public function addHeader($header, $value) { |
182 | 182 | $this->headers[$header] = $value; |
@@ -206,7 +206,7 @@ discard block |
||
206 | 206 | * e.g. "Content-Type". |
207 | 207 | * |
208 | 208 | * @param string $header |
209 | - * @return SS_HTTPRequest $this |
|
209 | + * @return SS_HTTPResponse $this |
|
210 | 210 | */ |
211 | 211 | public function removeHeader($header) { |
212 | 212 | if(isset($this->headers[$header])) unset($this->headers[$header]); |
@@ -216,7 +216,7 @@ discard block |
||
216 | 216 | /** |
217 | 217 | * @param string $dest |
218 | 218 | * @param int $code |
219 | - * @return SS_HTTPRequest $this |
|
219 | + * @return SS_HTTPResponse $this |
|
220 | 220 | */ |
221 | 221 | public function redirect($dest, $code=302) { |
222 | 222 | if(!in_array($code, self::$redirect_codes)) $code = 302; |
@@ -316,6 +316,7 @@ discard block |
||
316 | 316 | * @param string|SS_HTTPResponse body Either the plaintext content of the error message, or an SS_HTTPResponse |
317 | 317 | * object representing it. In either case, the $statusCode and |
318 | 318 | * $statusDescription will be the HTTP status of the resulting response. |
319 | + * @param string $statusDescription |
|
319 | 320 | * @see SS_HTTPResponse::__construct(); |
320 | 321 | */ |
321 | 322 | public function __construct($body = null, $statusCode = null, $statusDescription = null) { |
@@ -35,9 +35,9 @@ discard block |
||
35 | 35 | protected $fragmentOverride = null; |
36 | 36 | |
37 | 37 | /** |
38 | - * @param RequestHandler $controller |
|
39 | 38 | * @param SS_HTTPResponse An existing response to reuse (optional) |
40 | 39 | * @param Array $callbacks |
40 | + * @param SS_HTTPResponse $response |
|
41 | 41 | */ |
42 | 42 | public function __construct($callbacks = array(), $response = null) { |
43 | 43 | $this->callbacks = $callbacks; |
@@ -61,7 +61,6 @@ discard block |
||
61 | 61 | * @param array $extraCallbacks List of anonymous functions or callables returning either a string |
62 | 62 | * or SS_HTTPResponse, keyed by their fragment identifier. The 'default' key can |
63 | 63 | * be used as a fallback for non-ajax responses. |
64 | - * @param array $fragmentOverride Change the response fragments. |
|
65 | 64 | * @return SS_HTTPResponse |
66 | 65 | */ |
67 | 66 | public function respond(SS_HTTPRequest $request, $extraCallbacks = array()) { |
@@ -109,7 +108,7 @@ discard block |
||
109 | 108 | /** |
110 | 109 | * Set up fragment overriding - will completely replace the incoming fragments. |
111 | 110 | * |
112 | - * @param array $fragments Fragments to insert. |
|
111 | + * @param string[] $fragments Fragments to insert. |
|
113 | 112 | */ |
114 | 113 | public function setFragmentOverride($fragments) { |
115 | 114 | if (!is_array($fragments)) throw new InvalidArgumentException(); |
@@ -273,7 +273,6 @@ discard block |
||
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'); |
@@ -410,6 +409,9 @@ discard block |
||
410 | 409 | } |
411 | 410 | } |
412 | 411 | |
412 | + /** |
|
413 | + * @param string $name |
|
414 | + */ |
|
413 | 415 | public function inst_set($name, $val) { |
414 | 416 | // Quicker execution path for "."-free names |
415 | 417 | if(strpos($name, '.') === false) { |
@@ -458,6 +460,9 @@ discard block |
||
458 | 460 | $diffVar[sizeof($var)-1] = $val; |
459 | 461 | } |
460 | 462 | |
463 | + /** |
|
464 | + * @param string $name |
|
465 | + */ |
|
461 | 466 | public function inst_get($name) { |
462 | 467 | // Quicker execution path for "."-free names |
463 | 468 | if(strpos($name, '.') === false) { |
@@ -219,6 +219,7 @@ discard block |
||
219 | 219 | |
220 | 220 | /** |
221 | 221 | * Returns true if the given class implements the given interface |
222 | + * @param string $interfaceName |
|
222 | 223 | */ |
223 | 224 | public static function classImplements($className, $interfaceName) { |
224 | 225 | return in_array($className, self::implementorsOf($interfaceName)); |
@@ -269,6 +270,9 @@ discard block |
||
269 | 270 | |
270 | 271 | private static $method_from_cache = array(); |
271 | 272 | |
273 | + /** |
|
274 | + * @param string $method |
|
275 | + */ |
|
272 | 276 | public static function has_method_from($class, $method, $compclass) { |
273 | 277 | $lClass = strtolower($class); |
274 | 278 | $lMethod = strtolower($method); |
@@ -247,6 +247,10 @@ discard block |
||
247 | 247 | * match. The caller must trim matching lines from the beginning and end |
248 | 248 | * of the portions it is going to specify. |
249 | 249 | */ |
250 | + |
|
251 | + /** |
|
252 | + * @param double $nchunks |
|
253 | + */ |
|
250 | 254 | public function _diag ($xoff, $xlim, $yoff, $ylim, $nchunks) { |
251 | 255 | $flip = false; |
252 | 256 | |
@@ -357,6 +361,11 @@ discard block |
||
357 | 361 | * Note that XLIM, YLIM are exclusive bounds. |
358 | 362 | * All line numbers are origin-0 and discarded lines are not counted. |
359 | 363 | */ |
364 | + |
|
365 | + /** |
|
366 | + * @param integer $xoff |
|
367 | + * @param integer $yoff |
|
368 | + */ |
|
360 | 369 | public function _compareseq ($xoff, $xlim, $yoff, $ylim) { |
361 | 370 | // Slide down the bottom initial diagonal. |
362 | 371 | while ($xoff < $xlim && $yoff < $ylim |
@@ -554,7 +563,7 @@ discard block |
||
554 | 563 | * |
555 | 564 | * $diff = new Diff($lines1, $lines2); |
556 | 565 | * $rev = $diff->reverse(); |
557 | - * @return object A Diff object representing the inverse of the |
|
566 | + * @return Diff A Diff object representing the inverse of the |
|
558 | 567 | * original diff. |
559 | 568 | */ |
560 | 569 | public function reverse () { |
@@ -55,7 +55,7 @@ |
||
55 | 55 | |
56 | 56 | /** |
57 | 57 | * Set the owner of this extension. |
58 | - * @param Object $owner The owner object, |
|
58 | + * @param Group $owner The owner object, |
|
59 | 59 | * @param string $ownerBaseClass The base class that the extension is applied to; this may be |
60 | 60 | * the class of owner, or it may be a parent. For example, if Versioned was applied to SiteTree, |
61 | 61 | * and then a Page object was instantiated, $owner would be a Page object, but $ownerBaseClass |
@@ -244,6 +244,9 @@ discard block |
||
244 | 244 | * splt/complete before and after matchers) |
245 | 245 | * |
246 | 246 | * Public so that ManifestFileFinder can call it. Not for general use. |
247 | + * @param string $basename |
|
248 | + * @param string $pathname |
|
249 | + * @param boolean $depth |
|
247 | 250 | */ |
248 | 251 | public function addYAMLConfigFile($basename, $pathname, $depth) { |
249 | 252 | if (!preg_match('{/([^/]+)/_config/}', $pathname, $match)) return; |
@@ -467,7 +470,7 @@ discard block |
||
467 | 470 | * Returns false if the prefilterable parts of the rule aren't met, and true if they are |
468 | 471 | * |
469 | 472 | * @param $rules array - A hash of rules as allowed in the only or except portion of a config fragment header |
470 | - * @return bool - True if the rules are met, false if not. (Note that depending on whether we were passed an |
|
473 | + * @return boolean|string - True if the rules are met, false if not. (Note that depending on whether we were passed an |
|
471 | 474 | * only or an except rule, |
472 | 475 | * which values means accept or reject a fragment |
473 | 476 | */ |
@@ -7,9 +7,21 @@ |
||
7 | 7 | * @subpackage manifest |
8 | 8 | */ |
9 | 9 | interface ManifestCache { |
10 | + |
|
11 | + /** |
|
12 | + * @return void |
|
13 | + */ |
|
10 | 14 | public function __construct($name); |
11 | 15 | public function load($key); |
16 | + |
|
17 | + /** |
|
18 | + * @return void |
|
19 | + */ |
|
12 | 20 | public function save($data, $key); |
21 | + |
|
22 | + /** |
|
23 | + * @return void |
|
24 | + */ |
|
13 | 25 | public function clear(); |
14 | 26 | } |
15 | 27 |