@@ -118,6 +118,10 @@ |
||
118 | 118 | |
119 | 119 | // Patch in multibyte support |
120 | 120 | if (!function_exists('mb_substr')) { |
121 | + |
|
122 | + /** |
|
123 | + * @param string $str |
|
124 | + */ |
|
121 | 125 | function mb_substr($str, $start, $len = '', $encoding="UTF-8"){ |
122 | 126 | $limit = strlen($str); |
123 | 127 |
@@ -52,7 +52,7 @@ |
||
52 | 52 | /** |
53 | 53 | * Throws an error message back to the user. This will stop all execution. |
54 | 54 | * |
55 | - * @param {String} $str Message to send back to user. |
|
55 | + * @param string $str Message to send back to user. |
|
56 | 56 | */ |
57 | 57 | function throwError($str) { |
58 | 58 | die('{"result":null,"id":null,"error":{"errstr":"' . addslashes($str) . '","errfile":"","errline":null,"errcontext":"","level":"FATAL"}}'); |
@@ -342,6 +342,9 @@ discard block |
||
342 | 342 | return null; |
343 | 343 | } |
344 | 344 | |
345 | + /** |
|
346 | + * @param integer $len |
|
347 | + */ |
|
345 | 348 | function skip($len) { |
346 | 349 | $this->_pos += $len; |
347 | 350 | } |
@@ -369,6 +372,9 @@ discard block |
||
369 | 372 | return $this->readValue($reader); |
370 | 373 | } |
371 | 374 | |
375 | + /** |
|
376 | + * @param Moxiecode_JSONReader $reader |
|
377 | + */ |
|
372 | 378 | function readValue(&$reader) { |
373 | 379 | $this->data = array(); |
374 | 380 | $this->parents = array(); |
@@ -554,6 +560,11 @@ discard block |
||
554 | 560 | return '"' . $input . '"'; |
555 | 561 | } |
556 | 562 | |
563 | + /** |
|
564 | + * @param string $utf8 |
|
565 | + * |
|
566 | + * @return string |
|
567 | + */ |
|
557 | 568 | function _utf82utf16($utf8) { |
558 | 569 | if (function_exists('mb_convert_encoding')) |
559 | 570 | return mb_convert_encoding($utf8, 'UTF-16', 'UTF-8'); |
@@ -86,6 +86,9 @@ discard block |
||
86 | 86 | return $this->_level; |
87 | 87 | } |
88 | 88 | |
89 | + /** |
|
90 | + * @param string $path |
|
91 | + */ |
|
89 | 92 | function setPath($path) { |
90 | 93 | $this->_path = $path; |
91 | 94 | } |
@@ -102,6 +105,9 @@ discard block |
||
102 | 105 | return $this->_filename; |
103 | 106 | } |
104 | 107 | |
108 | + /** |
|
109 | + * @param string $format |
|
110 | + */ |
|
105 | 111 | function setFormat($format) { |
106 | 112 | $this->_format = $format; |
107 | 113 | } |
@@ -110,6 +116,9 @@ discard block |
||
110 | 116 | return $this->_format; |
111 | 117 | } |
112 | 118 | |
119 | + /** |
|
120 | + * @param string $size |
|
121 | + */ |
|
113 | 122 | function setMaxSize($size) { |
114 | 123 | // Fix log max size |
115 | 124 | $logMaxSizeBytes = intval(preg_replace("/[^0-9]/", "", $size)); |
@@ -130,6 +139,9 @@ discard block |
||
130 | 139 | return $this->_maxSize; |
131 | 140 | } |
132 | 141 | |
142 | + /** |
|
143 | + * @param string $max_files |
|
144 | + */ |
|
133 | 145 | function setMaxFiles($max_files) { |
134 | 146 | $this->_maxFiles = $max_files; |
135 | 147 | } |
@@ -183,6 +195,10 @@ discard block |
||
183 | 195 | return $this->_level >= MC_LOGGER_FATAL; |
184 | 196 | } |
185 | 197 | |
198 | + /** |
|
199 | + * @param integer $level |
|
200 | + * @param string $message |
|
201 | + */ |
|
186 | 202 | function _logMsg($level, $message) { |
187 | 203 | $roll = false; |
188 | 204 |
@@ -83,7 +83,6 @@ discard block |
||
83 | 83 | /** |
84 | 84 | * Adds a file to the concatenation/compression process. |
85 | 85 | * |
86 | - * @param String $path Path to the file to include in the compressed package/output. |
|
87 | 86 | */ |
88 | 87 | public function &addFile($file) { |
89 | 88 | $this->files .= ($this->files ? "," : "") . $file; |
@@ -256,7 +255,7 @@ discard block |
||
256 | 255 | /** |
257 | 256 | * Renders a script tag that loads the TinyMCE script. |
258 | 257 | * |
259 | - * @param Array $settings Name/value array with settings for the script tag. |
|
258 | + * @param Array $tagSettings Name/value array with settings for the script tag. |
|
260 | 259 | * @param Bool $return The script tag is return instead of being output if true |
261 | 260 | * @return String the tag is returned if $return is true |
262 | 261 | */ |
@@ -412,7 +412,7 @@ discard block |
||
412 | 412 | * Check if this file can be modified |
413 | 413 | * |
414 | 414 | * @param Member $member |
415 | - * @return boolean |
|
415 | + * @return boolean|string |
|
416 | 416 | */ |
417 | 417 | public function canEdit($member = null) { |
418 | 418 | if(!$member) { |
@@ -432,7 +432,7 @@ discard block |
||
432 | 432 | * |
433 | 433 | * @param Member $member |
434 | 434 | * @param array $context |
435 | - * @return boolean |
|
435 | + * @return boolean|string |
|
436 | 436 | */ |
437 | 437 | public function canCreate($member = null, $context = array()) { |
438 | 438 | if(!$member) { |
@@ -451,7 +451,7 @@ discard block |
||
451 | 451 | * Check if this file can be deleted |
452 | 452 | * |
453 | 453 | * @param Member $member |
454 | - * @return boolean |
|
454 | + * @return boolean|string |
|
455 | 455 | */ |
456 | 456 | public function canDelete($member = null) { |
457 | 457 | if(!$member) { |
@@ -647,7 +647,7 @@ discard block |
||
647 | 647 | * |
648 | 648 | * @param string $condition The PHP condition to be evaluated. The page will be called $item |
649 | 649 | * @param array $collator An array, passed by reference, to collect all of the matching descendants. |
650 | - * @return true|null |
|
650 | + * @return boolean|null |
|
651 | 651 | */ |
652 | 652 | public function collateDescendants($condition, &$collator) { |
653 | 653 | if($children = $this->Children()) { |
@@ -1020,6 +1020,7 @@ discard block |
||
1020 | 1020 | * |
1021 | 1021 | * @param String File extension, without dot prefix. Use an asterisk ('*') |
1022 | 1022 | * to specify a generic fallback if no mapping is found for an extension. |
1023 | + * @param string $ext |
|
1023 | 1024 | * @return String Classname for a subclass of {@link File} |
1024 | 1025 | */ |
1025 | 1026 | public static function get_class_for_file_extension($ext) { |
@@ -1163,7 +1164,6 @@ discard block |
||
1163 | 1164 | * Note that the result will not have a leading slash, and should not be used |
1164 | 1165 | * with local file paths. |
1165 | 1166 | * |
1166 | - * @param string $part,... Parts |
|
1167 | 1167 | * @return string |
1168 | 1168 | */ |
1169 | 1169 | public static function join_paths($part = null) { |
@@ -40,6 +40,9 @@ |
||
40 | 40 | ] |
41 | 41 | ); |
42 | 42 | |
43 | + /** |
|
44 | + * @param string $root |
|
45 | + */ |
|
43 | 46 | public function __construct($root = null, $writeFlags = LOCK_EX, $linkHandling = self::DISALLOW_LINKS) { |
44 | 47 | // Get root path |
45 | 48 | $root = $this->findRoot($root); |
@@ -56,7 +56,7 @@ |
||
56 | 56 | * Find the given folder or create it as a database record |
57 | 57 | * |
58 | 58 | * @param string $folderPath Directory path relative to assets root |
59 | - * @return Folder|null |
|
59 | + * @return null|\SilverStripe\ORM\DataObject |
|
60 | 60 | */ |
61 | 61 | public static function find_or_make($folderPath) { |
62 | 62 | // replace leading and trailing slashes |
@@ -191,7 +191,7 @@ discard block |
||
191 | 191 | * Check if this image has previously crashed GD when attempting to open it - if it's opened |
192 | 192 | * successfully, the manipulation's cache key is removed. |
193 | 193 | * |
194 | - * @param string $arg,... Any number of args that identify this image |
|
194 | + * @param string $arg |
|
195 | 195 | * @return bool True if failed |
196 | 196 | */ |
197 | 197 | public function failedResample($arg = null) { |
@@ -202,7 +202,7 @@ discard block |
||
202 | 202 | /** |
203 | 203 | * Mark a file as failed |
204 | 204 | * |
205 | - * @param string $arg,... Any number of args that identify this image |
|
205 | + * @param string $arg |
|
206 | 206 | */ |
207 | 207 | protected function markFailed($arg = null) { |
208 | 208 | $key = sha1(implode('|', func_get_args())); |
@@ -212,7 +212,6 @@ discard block |
||
212 | 212 | /** |
213 | 213 | * Mark a file as succeeded |
214 | 214 | * |
215 | - * @param string $arg,... Any number of args that identify this image |
|
216 | 215 | */ |
217 | 216 | protected function markSucceeded($arg = null) { |
218 | 217 | $key = sha1(implode('|', func_get_args())); |
@@ -363,7 +362,7 @@ discard block |
||
363 | 362 | * using built-in function. Used when imagerotate function is not available(i.e. Ubuntu) |
364 | 363 | * |
365 | 364 | * @param float $angle Angle in degrees |
366 | - * @return static |
|
365 | + * @return null|resource |
|
367 | 366 | */ |
368 | 367 | public function rotatePixelByPixel($angle) { |
369 | 368 | if(!$this->gd) { |