@@ -88,7 +88,6 @@ discard block |
||
88 | 88 | /** |
89 | 89 | * Get initial content |
90 | 90 | * |
91 | - * @param bool $encode To sanitizer the text? Default value should be "true"; however we have to set "false" for backward compat |
|
92 | 91 | * @return string |
93 | 92 | */ |
94 | 93 | function getValue() { |
@@ -115,7 +114,7 @@ discard block |
||
115 | 114 | /** |
116 | 115 | * prepare HTML for output |
117 | 116 | * |
118 | - * @return sting HTML |
|
117 | + * @return string HTML |
|
119 | 118 | */ |
120 | 119 | function render() |
121 | 120 | { |
@@ -45,7 +45,7 @@ |
||
45 | 45 | * prepare HTML for output |
46 | 46 | * |
47 | 47 | * @param bool decode content? |
48 | - * @return sting HTML |
|
48 | + * @return string HTML |
|
49 | 49 | */ |
50 | 50 | function render($decode = true) |
51 | 51 | { |
@@ -117,6 +117,7 @@ |
||
117 | 117 | * @param string $action, should be 'crop', 'scale', 'rotate','flip', or 'save' |
118 | 118 | * @param string $relative the relative image filename |
119 | 119 | * @param string $fullpath the fullpath to the image file |
120 | + * @param string $action |
|
120 | 121 | * @return array with image information |
121 | 122 | * <code>array('src'=>'url of the image', 'dimensions'=>'width="xx" height="yy"', |
122 | 123 | * 'file'=>'image file, relative', 'fullpath'=>'full path to the image');</code> |
@@ -177,6 +177,11 @@ discard block |
||
177 | 177 | ."$size -x $x -y ".$y+$size." -text \"$text\""; |
178 | 178 | } // End addText |
179 | 179 | |
180 | + /** |
|
181 | + * @param string|null $type |
|
182 | + * @param integer $quality |
|
183 | + * @param string|null $save_type |
|
184 | + */ |
|
180 | 185 | function _postProcess($type, $quality, $save_type) |
181 | 186 | { |
182 | 187 | $type = is_null($type) || $type==''? $this->type : $type; |
@@ -244,7 +249,7 @@ discard block |
||
244 | 249 | /** |
245 | 250 | * Destroy image handle |
246 | 251 | * |
247 | - * @return none |
|
252 | + * @return boolean |
|
248 | 253 | */ |
249 | 254 | function free() |
250 | 255 | { |
@@ -113,7 +113,7 @@ discard block |
||
113 | 113 | * |
114 | 114 | * @param string $driver name of driver class to initialize |
115 | 115 | * |
116 | - * @return mixed a newly created Image_Transform object, or a PEAR |
|
116 | + * @return string a newly created Image_Transform object, or a PEAR |
|
117 | 117 | * error object on error |
118 | 118 | * |
119 | 119 | * @see PEAR::isError() |
@@ -141,10 +141,10 @@ discard block |
||
141 | 141 | * |
142 | 142 | * @access public |
143 | 143 | * |
144 | - * @param mixed $new_x (0, number, percentage 10% or 0.1) |
|
145 | - * @param mixed $new_y (0, number, percentage 10% or 0.1) |
|
144 | + * @param integer $new_x (0, number, percentage 10% or 0.1) |
|
145 | + * @param integer $new_y (0, number, percentage 10% or 0.1) |
|
146 | 146 | * |
147 | - * @return mixed none or PEAR_error |
|
147 | + * @return PEAR_error|null none or PEAR_error |
|
148 | 148 | */ |
149 | 149 | function resize($new_x = 0, $new_y = 0) |
150 | 150 | { |
@@ -160,7 +160,7 @@ discard block |
||
160 | 160 | * Scale the image to have the max x dimension specified. |
161 | 161 | * |
162 | 162 | * @param int $new_x Size to scale X-dimension to |
163 | - * @return none |
|
163 | + * @return PEAR_error|null |
|
164 | 164 | */ |
165 | 165 | function scaleMaxX($new_x) |
166 | 166 | { |
@@ -173,7 +173,7 @@ discard block |
||
173 | 173 | * |
174 | 174 | * @access public |
175 | 175 | * @param int $new_y Size to scale Y-dimension to |
176 | - * @return none |
|
176 | + * @return PEAR_error|null |
|
177 | 177 | */ |
178 | 178 | function scaleMaxY($new_y) |
179 | 179 | { |
@@ -186,7 +186,7 @@ discard block |
||
186 | 186 | * |
187 | 187 | * @access public |
188 | 188 | * @param mixed (number, percentage 10% or 0.1) |
189 | - * @return mixed none or PEAR_error |
|
189 | + * @return PEAR_error|null none or PEAR_error |
|
190 | 190 | */ |
191 | 191 | function scale($size) |
192 | 192 | { |
@@ -206,7 +206,7 @@ discard block |
||
206 | 206 | * |
207 | 207 | * @access public |
208 | 208 | * @param int $size Percentage of original size to scale to |
209 | - * @return none |
|
209 | + * @return PEAR_error|null |
|
210 | 210 | */ |
211 | 211 | function scaleByPercentage($size) |
212 | 212 | { |
@@ -220,7 +220,7 @@ discard block |
||
220 | 220 | * |
221 | 221 | * @access public |
222 | 222 | * @param float $size Factor of original size to scale to |
223 | - * @return none |
|
223 | + * @return PEAR_error|null |
|
224 | 224 | */ |
225 | 225 | function scaleByFactor($size) |
226 | 226 | { |
@@ -234,7 +234,7 @@ discard block |
||
234 | 234 | * |
235 | 235 | * @access public |
236 | 236 | * @param int $size Max dimension in pixels |
237 | - * @return none |
|
237 | + * @return PEAR_error|null |
|
238 | 238 | */ |
239 | 239 | function scaleByLength($size) |
240 | 240 | { |
@@ -252,7 +252,7 @@ discard block |
||
252 | 252 | /** |
253 | 253 | * |
254 | 254 | * @access public |
255 | - * @return void |
|
255 | + * @return boolean|null |
|
256 | 256 | */ |
257 | 257 | function _get_image_details($image) |
258 | 258 | { |
@@ -310,10 +310,10 @@ discard block |
||
310 | 310 | * |
311 | 311 | * @access private |
312 | 312 | * |
313 | - * @param mixed $new_size (0, number, percentage 10% or 0.1) |
|
313 | + * @param integer $new_size (0, number, percentage 10% or 0.1) |
|
314 | 314 | * @param int $old_size |
315 | 315 | * |
316 | - * @return mixed none or PEAR_error |
|
316 | + * @return integer none or PEAR_error |
|
317 | 317 | */ |
318 | 318 | function _parse_size($new_size, $old_size) |
319 | 319 | { |
@@ -337,6 +337,10 @@ discard block |
||
337 | 337 | } |
338 | 338 | |
339 | 339 | //delete old tmp files, and allow only 1 file per remote host. |
340 | + |
|
341 | + /** |
|
342 | + * @param string $id |
|
343 | + */ |
|
340 | 344 | function cleanUp($id, $dir) |
341 | 345 | { |
342 | 346 | $d = dir($dir); |
@@ -525,7 +529,7 @@ discard block |
||
525 | 529 | * Reverse of rgb2colorname. |
526 | 530 | * |
527 | 531 | * @access public |
528 | - * @return PEAR_error |
|
532 | + * @return string |
|
529 | 533 | * |
530 | 534 | * @see rgb2colorname |
531 | 535 | */ |
@@ -872,6 +872,9 @@ discard block |
||
872 | 872 | return ""; |
873 | 873 | } |
874 | 874 | |
875 | + /** |
|
876 | + * @param string $message |
|
877 | + */ |
|
875 | 878 | protected function errorMsg($message, array $data=null) { |
876 | 879 | if (in_array($this->action, array("thumb", "upload", "download", "downloadDir"))) |
877 | 880 | die($this->label($message, $data)); |
@@ -887,6 +890,9 @@ discard block |
||
887 | 890 | return htmlentities($str, null, strtoupper($this->charset)); |
888 | 891 | } |
889 | 892 | |
893 | + /** |
|
894 | + * @param string $dir |
|
895 | + */ |
|
890 | 896 | protected function downloadURL($url, $dir) { |
891 | 897 | |
892 | 898 | if (!preg_match(phpGet::$urlExpr, $url, $match)) |
@@ -328,6 +328,9 @@ discard block |
||
328 | 328 | $this->callBack($url, $message); |
329 | 329 | } |
330 | 330 | |
331 | + /** |
|
332 | + * @return string |
|
333 | + */ |
|
331 | 334 | protected function normalizeFilename($filename) { |
332 | 335 | |
333 | 336 | if (isset($this->config['filenameChangeChars']) && |
@@ -341,6 +344,9 @@ discard block |
||
341 | 344 | return $filename; |
342 | 345 | } |
343 | 346 | |
347 | + /** |
|
348 | + * @param string $dirname |
|
349 | + */ |
|
344 | 350 | protected function normalizeDirname($dirname) { |
345 | 351 | |
346 | 352 | if (isset($this->config['dirnameChangeChars']) && |
@@ -480,6 +486,9 @@ discard block |
||
480 | 486 | return (is_dir($path) && is_readable($path)) ? $return : false; |
481 | 487 | } |
482 | 488 | |
489 | + /** |
|
490 | + * @param string $ext |
|
491 | + */ |
|
483 | 492 | protected function validateExtension($ext, $type) { |
484 | 493 | $ext = trim(strtolower($ext)); |
485 | 494 | if (!isset($this->types[$type])) |
@@ -505,11 +514,17 @@ discard block |
||
505 | 514 | return in_array($ext, $exts); |
506 | 515 | } |
507 | 516 | |
517 | + /** |
|
518 | + * @return string |
|
519 | + */ |
|
508 | 520 | protected function getTypeFromPath($path) { |
509 | 521 | return preg_match('/^([^\/]*)\/.*$/', $path, $patt) |
510 | 522 | ? $patt[1] : $path; |
511 | 523 | } |
512 | 524 | |
525 | + /** |
|
526 | + * @param string $path |
|
527 | + */ |
|
513 | 528 | protected function removeTypeFromPath($path) { |
514 | 529 | return preg_match('/^[^\/]*\/(.*)$/', $path, $patt) |
515 | 530 | ? $patt[1] : ""; |
@@ -693,6 +708,9 @@ discard block |
||
693 | 708 | die; |
694 | 709 | } |
695 | 710 | |
711 | + /** |
|
712 | + * @param string $url |
|
713 | + */ |
|
696 | 714 | protected function callBack($url, $message="") { |
697 | 715 | $message = text::jsValue($message); |
698 | 716 |
@@ -199,6 +199,9 @@ discard block |
||
199 | 199 | } |
200 | 200 | |
201 | 201 | |
202 | + /** |
|
203 | + * @param integer $n |
|
204 | + */ |
|
202 | 205 | private function getChars($n) |
203 | 206 | { |
204 | 207 | $response = null; |
@@ -240,6 +243,9 @@ discard block |
||
240 | 243 | } |
241 | 244 | |
242 | 245 | |
246 | + /** |
|
247 | + * @param false|string $str |
|
248 | + */ |
|
243 | 249 | private function readInt($str) |
244 | 250 | { |
245 | 251 | $size = unpack("C*", $str); |
@@ -181,7 +181,6 @@ |
||
181 | 181 | |
182 | 182 | /** Resize and crop the image to fit in given resolution. Returns TRUE on |
183 | 183 | * success or FALSE on failure |
184 | - * @param mixed $src |
|
185 | 184 | * @param integer $offset |
186 | 185 | * @return bool */ |
187 | 186 | abstract public function resizeCrop($width, $height, $offset=false); |