@@ -103,7 +103,7 @@ discard block |
||
| 103 | 103 | * before drawing the text |
| 104 | 104 | * ) |
| 105 | 105 | * |
| 106 | - * @return none |
|
| 106 | + * @return boolean |
|
| 107 | 107 | * @see PEAR::isError() |
| 108 | 108 | */ |
| 109 | 109 | function addText($params) |
@@ -151,7 +151,7 @@ discard block |
||
| 151 | 151 | * 'color_mask'=>array(r,g,b), named color or #rrggbb |
| 152 | 152 | * ) |
| 153 | 153 | * @author Pierre-Alain Joye |
| 154 | - * @return mixed none or a PEAR error object on error |
|
| 154 | + * @return boolean none or a PEAR error object on error |
|
| 155 | 155 | * @see PEAR::isError() |
| 156 | 156 | */ |
| 157 | 157 | function rotate($angle, $options=null) |
@@ -340,7 +340,7 @@ discard block |
||
| 340 | 340 | * @param $new_x int new width |
| 341 | 341 | * @param $new_y int new height |
| 342 | 342 | * |
| 343 | - * @return true on success or pear error |
|
| 343 | + * @return boolean on success or pear error |
|
| 344 | 344 | * @see PEAR::isError() |
| 345 | 345 | */ |
| 346 | 346 | function _resize($new_x, $new_y) { |
@@ -369,10 +369,6 @@ discard block |
||
| 369 | 369 | /** |
| 370 | 370 | * Crop the image |
| 371 | 371 | * |
| 372 | - * @param int $crop_x left column of the image |
|
| 373 | - * @param int $crop_y top row of the image |
|
| 374 | - * @param int $crop_width new cropped image width |
|
| 375 | - * @param int $crop_height new cropped image height |
|
| 376 | 372 | */ |
| 377 | 373 | function crop($new_x, $new_y, $new_width, $new_height) |
| 378 | 374 | { |
@@ -242,7 +242,7 @@ |
||
| 242 | 242 | /** |
| 243 | 243 | * Destroy image handle |
| 244 | 244 | * |
| 245 | - * @return none |
|
| 245 | + * @return boolean |
|
| 246 | 246 | */ |
| 247 | 247 | function free() |
| 248 | 248 | { |
@@ -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> |
@@ -188,6 +188,7 @@ discard block |
||
| 188 | 188 | /** |
| 189 | 189 | * Count the number of files and directories in a given folder |
| 190 | 190 | * minus the thumbnail folders and thumbnails. |
| 191 | + * @param string $path |
|
| 191 | 192 | */ |
| 192 | 193 | function countFiles($path) |
| 193 | 194 | { |
@@ -227,7 +228,7 @@ discard block |
||
| 227 | 228 | /** |
| 228 | 229 | * Check if the file contains the thumbnail prefix. |
| 229 | 230 | * @param string $file filename to be checked |
| 230 | - * @return true if the file contains the thumbnail prefix, false otherwise. |
|
| 231 | + * @return boolean if the file contains the thumbnail prefix, false otherwise. |
|
| 231 | 232 | */ |
| 232 | 233 | function isThumb($file) |
| 233 | 234 | { |
@@ -241,7 +242,7 @@ discard block |
||
| 241 | 242 | /** |
| 242 | 243 | * Check if the given directory is a thumbnail directory. |
| 243 | 244 | * @param string $entry directory name |
| 244 | - * @return true if it is a thumbnail directory, false otherwise |
|
| 245 | + * @return boolean if it is a thumbnail directory, false otherwise |
|
| 245 | 246 | */ |
| 246 | 247 | function isThumbDir($entry) |
| 247 | 248 | { |
@@ -366,7 +367,7 @@ discard block |
||
| 366 | 367 | * The dir must be relative to the base_dir and exists. |
| 367 | 368 | * If 'validate_images' is set to true, only file with |
| 368 | 369 | * image dimensions will be accepted. |
| 369 | - * @return null |
|
| 370 | + * @return null|boolean |
|
| 370 | 371 | */ |
| 371 | 372 | function processUploads() |
| 372 | 373 | { |
@@ -550,7 +551,7 @@ discard block |
||
| 550 | 551 | |
| 551 | 552 | /** |
| 552 | 553 | * Delete and specified files. |
| 553 | - * @return boolean true if delete, false otherwise |
|
| 554 | + * @return boolean|null true if delete, false otherwise |
|
| 554 | 555 | */ |
| 555 | 556 | function deleteFiles() |
| 556 | 557 | { |
@@ -611,7 +612,7 @@ discard block |
||
| 611 | 612 | /** |
| 612 | 613 | * Create new directories. |
| 613 | 614 | * If in safe_mode, nothing happens. |
| 614 | - * @return boolean true if created, false otherwise. |
|
| 615 | + * @return boolean|null true if created, false otherwise. |
|
| 615 | 616 | */ |
| 616 | 617 | function processNewDir() |
| 617 | 618 | { |
@@ -653,6 +654,9 @@ discard block |
||
| 653 | 654 | return false; |
| 654 | 655 | } |
| 655 | 656 | |
| 657 | + /** |
|
| 658 | + * @param string $method |
|
| 659 | + */ |
|
| 656 | 660 | function _checkIMLibrary($method) |
| 657 | 661 | { |
| 658 | 662 | //ImageMagick goes throught 1 single executable |
@@ -664,7 +668,7 @@ discard block |
||
| 664 | 668 | |
| 665 | 669 | /** |
| 666 | 670 | * Check the GD library functionality. |
| 667 | - * @param string $library the graphics library, GD, NetPBM, or IM. |
|
| 671 | + * @param string $method |
|
| 668 | 672 | * @return boolean true if able, false otherwise. |
| 669 | 673 | */ |
| 670 | 674 | function _checkGDLibrary($method) |
@@ -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 | */ |
@@ -128,7 +128,7 @@ |
||
| 128 | 128 | /** |
| 129 | 129 | * prepare HTML for output |
| 130 | 130 | * |
| 131 | - * @return sting HTML |
|
| 131 | + * @return string HTML |
|
| 132 | 132 | */ |
| 133 | 133 | function render() |
| 134 | 134 | { |
@@ -265,7 +265,7 @@ |
||
| 265 | 265 | /** |
| 266 | 266 | * @param string $css_file |
| 267 | 267 | * |
| 268 | - * @return array |
|
| 268 | + * @return string[] |
|
| 269 | 269 | */ |
| 270 | 270 | function loadCss($css_file = 'style.css') |
| 271 | 271 | { |
@@ -32,16 +32,6 @@ discard block |
||
| 32 | 32 | /** |
| 33 | 33 | * Constructor |
| 34 | 34 | * |
| 35 | - * @param string $caption Caption |
|
| 36 | - * @param string $name "name" attribute |
|
| 37 | - * @param string $value Initial text |
|
| 38 | - * @param string $rows Number of rows (facultative) |
|
| 39 | - * @param string $cols Number of cols (facultative) |
|
| 40 | - * @param string $width iframe width (facultative) |
|
| 41 | - * @param string $height iframe height (facultative) |
|
| 42 | - * @param array $options Toolbar Options (facultative) |
|
| 43 | - * OR |
|
| 44 | - * @param array $options Editor Options |
|
| 45 | 35 | */ |
| 46 | 36 | |
| 47 | 37 | function __construct() |
@@ -144,7 +134,7 @@ discard block |
||
| 144 | 134 | /** |
| 145 | 135 | * prepare HTML for output |
| 146 | 136 | * |
| 147 | - * @return sting HTML |
|
| 137 | + * @return string HTML |
|
| 148 | 138 | */ |
| 149 | 139 | function render() |
| 150 | 140 | { |