Complex classes like CImage often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use CImage, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
9 | class CImage |
||
|
|||
10 | { |
||
11 | |||
12 | /** |
||
13 | * Constants type of PNG image |
||
14 | */ |
||
15 | const PNG_GREYSCALE = 0; |
||
16 | const PNG_RGB = 2; |
||
17 | const PNG_RGB_PALETTE = 3; |
||
18 | const PNG_GREYSCALE_ALPHA = 4; |
||
19 | const PNG_RGB_ALPHA = 6; |
||
20 | |||
21 | |||
22 | |||
23 | /** |
||
24 | * Constant for default image quality when not set |
||
25 | */ |
||
26 | const JPEG_QUALITY_DEFAULT = 60; |
||
27 | |||
28 | |||
29 | |||
30 | /** |
||
31 | * Quality level for JPEG images. |
||
32 | */ |
||
33 | private $quality; |
||
34 | |||
35 | |||
36 | |||
37 | /** |
||
38 | * Is the quality level set from external use (true) or is it default (false)? |
||
39 | */ |
||
40 | private $useQuality = false; |
||
41 | |||
42 | |||
43 | |||
44 | /** |
||
45 | * Constant for default image quality when not set |
||
46 | */ |
||
47 | const PNG_COMPRESSION_DEFAULT = -1; |
||
48 | |||
49 | |||
50 | |||
51 | /** |
||
52 | * Compression level for PNG images. |
||
53 | */ |
||
54 | private $compress; |
||
55 | |||
56 | |||
57 | |||
58 | /** |
||
59 | * Is the compress level set from external use (true) or is it default (false)? |
||
60 | */ |
||
61 | private $useCompress = false; |
||
62 | |||
63 | |||
64 | |||
65 | |||
66 | /** |
||
67 | * Add HTTP headers for outputing image. |
||
68 | */ |
||
69 | private $HTTPHeader = array(); |
||
70 | |||
71 | |||
72 | |||
73 | /** |
||
74 | * Default background color, red, green, blue, alpha. |
||
75 | * |
||
76 | * @todo remake when upgrading to PHP 5.5 |
||
77 | */ |
||
78 | /* |
||
79 | const BACKGROUND_COLOR = array( |
||
80 | 'red' => 0, |
||
81 | 'green' => 0, |
||
82 | 'blue' => 0, |
||
83 | 'alpha' => null, |
||
84 | );*/ |
||
85 | |||
86 | |||
87 | |||
88 | /** |
||
89 | * Default background color to use. |
||
90 | * |
||
91 | * @todo remake when upgrading to PHP 5.5 |
||
92 | */ |
||
93 | //private $bgColorDefault = self::BACKGROUND_COLOR; |
||
94 | private $bgColorDefault = array( |
||
95 | 'red' => 0, |
||
96 | 'green' => 0, |
||
97 | 'blue' => 0, |
||
98 | 'alpha' => null, |
||
99 | ); |
||
100 | |||
101 | |||
102 | /** |
||
103 | * Background color to use, specified as part of options. |
||
104 | */ |
||
105 | private $bgColor; |
||
106 | |||
107 | |||
108 | |||
109 | /** |
||
110 | * Where to save the target file. |
||
111 | */ |
||
112 | private $saveFolder; |
||
113 | |||
114 | |||
115 | |||
116 | /** |
||
117 | * The working image object. |
||
118 | */ |
||
119 | private $image; |
||
120 | |||
121 | |||
122 | |||
123 | /** |
||
124 | * Image filename, may include subdirectory, relative from $imageFolder |
||
125 | */ |
||
126 | private $imageSrc; |
||
127 | |||
128 | |||
129 | |||
130 | /** |
||
131 | * Actual path to the image, $imageFolder . '/' . $imageSrc |
||
132 | */ |
||
133 | private $pathToImage; |
||
134 | |||
135 | |||
136 | |||
137 | /** |
||
138 | * File type for source image, as provided by getimagesize() |
||
139 | */ |
||
140 | private $fileType; |
||
141 | |||
142 | |||
143 | |||
144 | /** |
||
145 | * File extension to use when saving image. |
||
146 | */ |
||
147 | private $extension; |
||
148 | |||
149 | |||
150 | |||
151 | /** |
||
152 | * Output format, supports null (image) or json. |
||
153 | */ |
||
154 | private $outputFormat = null; |
||
155 | |||
156 | |||
157 | |||
158 | /** |
||
159 | * Verbose mode to print out a trace and display the created image |
||
160 | */ |
||
161 | private $verbose = false; |
||
162 | |||
163 | |||
164 | |||
165 | /** |
||
166 | * Keep a log/trace on what happens |
||
167 | */ |
||
168 | private $log = array(); |
||
169 | |||
170 | |||
171 | |||
172 | /** |
||
173 | * Handle image as palette image |
||
174 | */ |
||
175 | private $palette; |
||
176 | |||
177 | |||
178 | |||
179 | /** |
||
180 | * Target filename, with path, to save resulting image in. |
||
181 | */ |
||
182 | private $cacheFileName; |
||
183 | |||
184 | |||
185 | |||
186 | /** |
||
187 | * Set a format to save image as, or null to use original format. |
||
188 | */ |
||
189 | private $saveAs; |
||
190 | |||
191 | |||
192 | /** |
||
193 | * Path to command for filter optimize, for example optipng or null. |
||
194 | */ |
||
195 | private $pngFilter; |
||
196 | private $pngFilterCmd; |
||
197 | |||
198 | |||
199 | |||
200 | /** |
||
201 | * Path to command for deflate optimize, for example pngout or null. |
||
202 | */ |
||
203 | private $pngDeflate; |
||
204 | private $pngDeflateCmd; |
||
205 | |||
206 | |||
207 | |||
208 | /** |
||
209 | * Path to command to optimize jpeg images, for example jpegtran or null. |
||
210 | */ |
||
211 | private $jpegOptimize; |
||
212 | private $jpegOptimizeCmd; |
||
213 | |||
214 | |||
215 | |||
216 | /** |
||
217 | * Image dimensions, calculated from loaded image. |
||
218 | */ |
||
219 | private $width; // Calculated from source image |
||
220 | private $height; // Calculated from source image |
||
221 | |||
222 | |||
223 | /** |
||
224 | * New image dimensions, incoming as argument or calculated. |
||
225 | */ |
||
226 | private $newWidth; |
||
227 | private $newWidthOrig; // Save original value |
||
228 | private $newHeight; |
||
229 | private $newHeightOrig; // Save original value |
||
230 | |||
231 | |||
232 | /** |
||
233 | * Change target height & width when different dpr, dpr 2 means double image dimensions. |
||
234 | */ |
||
235 | private $dpr = 1; |
||
236 | |||
237 | |||
238 | /** |
||
239 | * Always upscale images, even if they are smaller than target image. |
||
240 | */ |
||
241 | const UPSCALE_DEFAULT = true; |
||
242 | private $upscale = self::UPSCALE_DEFAULT; |
||
243 | |||
244 | |||
245 | |||
246 | /** |
||
247 | * Array with details on how to crop, incoming as argument and calculated. |
||
248 | */ |
||
249 | public $crop; |
||
250 | public $cropOrig; // Save original value |
||
251 | |||
252 | |||
253 | /** |
||
254 | * String with details on how to do image convolution. String |
||
255 | * should map a key in the $convolvs array or be a string of |
||
256 | * 11 float values separated by comma. The first nine builds |
||
257 | * up the matrix, then divisor and last offset. |
||
258 | */ |
||
259 | private $convolve; |
||
260 | |||
261 | |||
262 | /** |
||
263 | * Custom convolution expressions, matrix 3x3, divisor and offset. |
||
264 | */ |
||
265 | private $convolves = array( |
||
266 | 'lighten' => '0,0,0, 0,12,0, 0,0,0, 9, 0', |
||
267 | 'darken' => '0,0,0, 0,6,0, 0,0,0, 9, 0', |
||
268 | 'sharpen' => '-1,-1,-1, -1,16,-1, -1,-1,-1, 8, 0', |
||
269 | 'sharpen-alt' => '0,-1,0, -1,5,-1, 0,-1,0, 1, 0', |
||
270 | 'emboss' => '1,1,-1, 1,3,-1, 1,-1,-1, 3, 0', |
||
271 | 'emboss-alt' => '-2,-1,0, -1,1,1, 0,1,2, 1, 0', |
||
272 | 'blur' => '1,1,1, 1,15,1, 1,1,1, 23, 0', |
||
273 | 'gblur' => '1,2,1, 2,4,2, 1,2,1, 16, 0', |
||
274 | 'edge' => '-1,-1,-1, -1,8,-1, -1,-1,-1, 9, 0', |
||
275 | 'edge-alt' => '0,1,0, 1,-4,1, 0,1,0, 1, 0', |
||
276 | 'draw' => '0,-1,0, -1,5,-1, 0,-1,0, 0, 0', |
||
277 | 'mean' => '1,1,1, 1,1,1, 1,1,1, 9, 0', |
||
278 | 'motion' => '1,0,0, 0,1,0, 0,0,1, 3, 0', |
||
279 | ); |
||
280 | |||
281 | |||
282 | /** |
||
283 | * Resize strategy to fill extra area with background color. |
||
284 | * True or false. |
||
285 | */ |
||
286 | private $fillToFit; |
||
287 | |||
288 | |||
289 | |||
290 | /** |
||
291 | * To store value for option scale. |
||
292 | */ |
||
293 | private $scale; |
||
294 | |||
295 | |||
296 | |||
297 | /** |
||
298 | * To store value for option. |
||
299 | */ |
||
300 | private $rotateBefore; |
||
301 | |||
302 | |||
303 | |||
304 | /** |
||
305 | * To store value for option. |
||
306 | */ |
||
307 | private $rotateAfter; |
||
308 | |||
309 | |||
310 | |||
311 | /** |
||
312 | * To store value for option. |
||
313 | */ |
||
314 | private $autoRotate; |
||
315 | |||
316 | |||
317 | |||
318 | /** |
||
319 | * To store value for option. |
||
320 | */ |
||
321 | private $sharpen; |
||
322 | |||
323 | |||
324 | |||
325 | /** |
||
326 | * To store value for option. |
||
327 | */ |
||
328 | private $emboss; |
||
329 | |||
330 | |||
331 | |||
332 | /** |
||
333 | * To store value for option. |
||
334 | */ |
||
335 | private $blur; |
||
336 | |||
337 | |||
338 | |||
339 | /** |
||
340 | * Used with option area to set which parts of the image to use. |
||
341 | */ |
||
342 | private $offset; |
||
343 | |||
344 | |||
345 | |||
346 | /** |
||
347 | * Calculate target dimension for image when using fill-to-fit resize strategy. |
||
348 | */ |
||
349 | private $fillWidth; |
||
350 | private $fillHeight; |
||
351 | |||
352 | |||
353 | |||
354 | /** |
||
355 | * Allow remote file download, default is to disallow remote file download. |
||
356 | */ |
||
357 | private $allowRemote = false; |
||
358 | |||
359 | |||
360 | |||
361 | /** |
||
362 | * Path to cache for remote download. |
||
363 | */ |
||
364 | private $remoteCache; |
||
365 | |||
366 | |||
367 | |||
368 | /** |
||
369 | * Pattern to recognize a remote file. |
||
370 | */ |
||
371 | //private $remotePattern = '#^[http|https]://#'; |
||
372 | private $remotePattern = '#^https?://#'; |
||
373 | |||
374 | |||
375 | |||
376 | /** |
||
377 | * Use the cache if true, set to false to ignore the cached file. |
||
378 | */ |
||
379 | private $useCache = true; |
||
380 | |||
381 | |||
382 | /** |
||
383 | * Disable the fasttrackCacke to start with, inject an object to enable it. |
||
384 | */ |
||
385 | private $fastTrackCache = null; |
||
386 | |||
387 | |||
388 | |||
389 | /* |
||
390 | * Set whitelist for valid hostnames from where remote source can be |
||
391 | * downloaded. |
||
392 | */ |
||
393 | private $remoteHostWhitelist = null; |
||
394 | |||
395 | |||
396 | |||
397 | /* |
||
398 | * Do verbose logging to file by setting this to a filename. |
||
399 | */ |
||
400 | private $verboseFileName = null; |
||
401 | |||
402 | |||
403 | |||
404 | /* |
||
405 | * Output to ascii can take som options as an array. |
||
406 | */ |
||
407 | private $asciiOptions = array(); |
||
408 | |||
409 | |||
410 | |||
411 | /* |
||
412 | * Image copy strategy, defaults to RESAMPLE. |
||
413 | */ |
||
414 | const RESIZE = 1; |
||
415 | const RESAMPLE = 2; |
||
416 | private $copyStrategy = NULL; |
||
417 | |||
418 | |||
419 | |||
420 | /** |
||
421 | * Properties, the class is mutable and the method setOptions() |
||
422 | * decides (partly) what properties are created. |
||
423 | * |
||
424 | * @todo Clean up these and check if and how they are used |
||
425 | */ |
||
426 | |||
427 | public $keepRatio; |
||
428 | public $cropToFit; |
||
429 | private $cropWidth; |
||
430 | private $cropHeight; |
||
431 | public $crop_x; |
||
432 | public $crop_y; |
||
433 | public $filters; |
||
434 | 7 | private $attr; // Calculated from source image |
|
435 | |||
436 | 7 | ||
437 | 7 | ||
438 | 7 | ||
439 | /** |
||
440 | * Constructor, can take arguments to init the object. |
||
441 | * |
||
442 | * @param string $imageSrc filename which may contain subdirectory. |
||
443 | * @param string $imageFolder path to root folder for images. |
||
444 | * @param string $saveFolder path to folder where to save the new file or null to skip saving. |
||
445 | * @param string $saveName name of target file when saveing. |
||
446 | */ |
||
447 | public function __construct($imageSrc = null, $imageFolder = null, $saveFolder = null, $saveName = null) |
||
448 | { |
||
449 | $this->setSource($imageSrc, $imageFolder); |
||
450 | $this->setTarget($saveFolder, $saveName); |
||
451 | } |
||
452 | |||
453 | |||
454 | |||
455 | /** |
||
456 | * Inject object and use it, must be available as member. |
||
457 | * |
||
458 | * @param string $property to set as object. |
||
459 | * @param object $object to set to property. |
||
460 | * |
||
461 | * @return $this |
||
462 | */ |
||
463 | public function injectDependency($property, $object) |
||
471 | |||
472 | |||
473 | |||
474 | /** |
||
475 | * Set verbose mode. |
||
476 | * |
||
477 | * @param boolean $mode true or false to enable and disable verbose mode, |
||
478 | * default is true. |
||
479 | * |
||
480 | * @return $this |
||
481 | */ |
||
482 | public function setVerbose($mode = true) |
||
483 | { |
||
484 | $this->verbose = $mode; |
||
485 | return $this; |
||
486 | } |
||
487 | |||
488 | |||
489 | |||
490 | /** |
||
491 | * Set save folder, base folder for saving cache files. |
||
492 | * |
||
493 | * @todo clean up how $this->saveFolder is used in other methods. |
||
494 | * |
||
495 | * @param string $path where to store cached files. |
||
496 | * |
||
497 | * @return $this |
||
498 | */ |
||
499 | 2 | public function setSaveFolder($path) |
|
500 | { |
||
501 | 2 | $this->saveFolder = $path; |
|
502 | 2 | return $this; |
|
503 | } |
||
504 | 2 | ||
505 | |||
506 | 2 | ||
507 | /** |
||
508 | * Use cache or not. |
||
509 | * |
||
510 | * @param boolean $use true or false to use cache. |
||
511 | * |
||
512 | * @return $this |
||
513 | */ |
||
514 | public function useCache($use = true) |
||
515 | { |
||
516 | $this->useCache = $use; |
||
517 | return $this; |
||
518 | } |
||
519 | 2 | ||
520 | |||
521 | 2 | ||
522 | 2 | /** |
|
523 | * Create and save a dummy image. Use dimensions as stated in |
||
524 | 2 | * $this->newWidth, or $width or default to 100 (same for height. |
|
525 | * |
||
526 | 2 | * @param integer $width use specified width for image dimension. |
|
527 | 2 | * @param integer $height use specified width for image dimension. |
|
528 | 2 | * |
|
529 | 2 | * @return $this |
|
530 | */ |
||
531 | 2 | public function createDummyImage($width = null, $height = null) |
|
540 | |||
541 | |||
542 | |||
543 | 2 | /** |
|
544 | * Allow or disallow remote image download. |
||
545 | 2 | * |
|
546 | 2 | * @param boolean $allow true or false to enable and disable. |
|
547 | 2 | * @param string $cache path to cache dir. |
|
548 | * @param string $pattern to use to detect if its a remote file. |
||
549 | * |
||
550 | * @return $this |
||
551 | */ |
||
552 | public function setRemoteDownload($allow, $cache, $pattern = null) |
||
553 | { |
||
554 | $this->allowRemote = $allow; |
||
555 | $this->remoteCache = $cache; |
||
556 | $this->remotePattern = is_null($pattern) ? $this->remotePattern : $pattern; |
||
557 | |||
558 | $this->log( |
||
559 | "Set remote download to: " |
||
560 | 2 | . ($this->allowRemote ? "true" : "false") |
|
561 | . " using pattern " |
||
562 | 2 | . $this->remotePattern |
|
563 | 2 | ); |
|
564 | |||
565 | 2 | return $this; |
|
566 | 2 | } |
|
567 | 2 | ||
568 | |||
569 | |||
570 | /** |
||
571 | * Check if the image resource is a remote file or not. |
||
572 | * |
||
573 | * @param string $src check if src is remote. |
||
574 | * |
||
575 | * @return boolean true if $src is a remote file, else false. |
||
576 | */ |
||
577 | public function isRemoteSource($src) |
||
578 | { |
||
579 | $remote = preg_match($this->remotePattern, $src); |
||
580 | 3 | $this->log("Detected remote image: " . ($remote ? "true" : "false")); |
|
581 | return !!$remote; |
||
582 | 3 | } |
|
583 | 1 | ||
584 | 1 | ||
585 | |||
586 | /** |
||
587 | 2 | * Set whitelist for valid hostnames from where remote source can be |
|
588 | 2 | * downloaded. |
|
589 | 2 | * |
|
590 | * @param array $whitelist with regexp hostnames to allow download from. |
||
591 | 2 | * |
|
592 | * @return $this |
||
593 | 2 | */ |
|
594 | 2 | public function setRemoteHostWhitelist($whitelist = null) |
|
603 | |||
604 | |||
605 | |||
606 | /** |
||
607 | * Check if the hostname for the remote image, is on a whitelist, |
||
608 | * if the whitelist is defined. |
||
609 | * |
||
610 | * @param string $src the remote source. |
||
611 | * |
||
612 | * @return boolean true if hostname on $src is in the whitelist, else false. |
||
613 | */ |
||
614 | public function isRemoteSourceOnWhitelist($src) |
||
631 | |||
632 | |||
633 | |||
634 | 2 | /** |
|
635 | * Check if file extension is valid as a file extension. |
||
636 | * |
||
637 | * @param string $extension of image file. |
||
638 | * |
||
639 | * @return $this |
||
640 | */ |
||
641 | private function checkFileExtension($extension) |
||
650 | |||
651 | |||
652 | |||
653 | /** |
||
654 | * Normalize the file extension. |
||
655 | * |
||
656 | * @param string $extension of image file or skip to use internal. |
||
657 | * |
||
658 | * @return string $extension as a normalized file extension. |
||
659 | */ |
||
660 | private function normalizeFileExtension($extension = null) |
||
670 | |||
671 | |||
672 | |||
673 | /** |
||
674 | * Download a remote image and return path to its local copy. |
||
675 | * |
||
676 | * @param string $src remote path to image. |
||
677 | * |
||
678 | * @return string as path to downloaded remote source. |
||
679 | */ |
||
680 | public function downloadRemoteSource($src) |
||
681 | { |
||
682 | if (!$this->isRemoteSourceOnWhitelist($src)) { |
||
683 | throw new Exception("Hostname is not on whitelist for remote sources."); |
||
684 | } |
||
685 | |||
686 | $remote = new CRemoteImage(); |
||
687 | |||
688 | 7 | if (!is_writable($this->remoteCache)) { |
|
689 | $this->log("The remote cache is not writable."); |
||
690 | 7 | } |
|
691 | 7 | ||
692 | 7 | $remote->setCache($this->remoteCache); |
|
693 | 7 | $remote->useCache($this->useCache); |
|
694 | $src = $remote->download($src); |
||
695 | |||
696 | 2 | $this->log("Remote HTTP status: " . $remote->getStatus()); |
|
697 | $this->log("Remote item is in local cache: $src"); |
||
698 | $this->log("Remote details on cache:" . print_r($remote->getDetails(), true)); |
||
699 | |||
700 | return $src; |
||
701 | 2 | } |
|
702 | |||
703 | |||
704 | |||
705 | /** |
||
706 | 2 | * Set source file to use as image source. |
|
707 | 2 | * |
|
708 | 2 | * @param string $src of image. |
|
709 | * @param string $dir as optional base directory where images are. |
||
710 | 2 | * |
|
711 | * @return $this |
||
712 | */ |
||
713 | public function setSource($src, $dir = null) |
||
714 | { |
||
715 | if (!isset($src)) { |
||
716 | $this->imageSrc = null; |
||
717 | $this->pathToImage = null; |
||
718 | return $this; |
||
719 | } |
||
720 | |||
721 | if ($this->allowRemote && $this->isRemoteSource($src)) { |
||
722 | $src = $this->downloadRemoteSource($src); |
||
723 | $dir = null; |
||
724 | 7 | } |
|
725 | |||
726 | 7 | if (!isset($dir)) { |
|
727 | 7 | $dir = dirname($src); |
|
728 | 7 | $src = basename($src); |
|
729 | } |
||
730 | |||
731 | 2 | $this->imageSrc = ltrim($src, '/'); |
|
732 | $imageFolder = rtrim($dir, '/'); |
||
733 | $this->pathToImage = $imageFolder . '/' . $this->imageSrc; |
||
734 | |||
735 | 2 | return $this; |
|
736 | } |
||
737 | |||
738 | 2 | ||
739 | 2 | ||
740 | /** |
||
741 | 2 | * Set target file. |
|
742 | * |
||
743 | * @param string $src of target image. |
||
744 | * @param string $dir as optional base directory where images are stored. |
||
745 | * Uses $this->saveFolder if null. |
||
746 | * |
||
747 | * @return $this |
||
748 | */ |
||
749 | public function setTarget($src = null, $dir = null) |
||
750 | { |
||
751 | 2 | if (!isset($src)) { |
|
752 | $this->cacheFileName = null; |
||
753 | 2 | return $this; |
|
754 | } |
||
755 | |||
756 | if (isset($dir)) { |
||
757 | $this->saveFolder = rtrim($dir, '/'); |
||
758 | } |
||
759 | |||
760 | $this->cacheFileName = $this->saveFolder . '/' . $src; |
||
761 | |||
762 | // Sanitize filename |
||
763 | $this->cacheFileName = preg_replace('/^a-zA-Z0-9\.-_/', '', $this->cacheFileName); |
||
764 | $this->log("The cache file name is: " . $this->cacheFileName); |
||
765 | |||
766 | return $this; |
||
767 | } |
||
768 | |||
769 | |||
770 | |||
771 | /** |
||
772 | * Get filename of target file. |
||
773 | * |
||
774 | * @return Boolean|String as filename of target or false if not set. |
||
775 | */ |
||
776 | public function getTarget() |
||
780 | |||
781 | |||
782 | |||
783 | /** |
||
784 | * Set options to use when processing image. |
||
785 | * |
||
786 | * @param array $args used when processing image. |
||
787 | * |
||
788 | * @return $this |
||
789 | */ |
||
790 | public function setOptions($args) |
||
791 | { |
||
792 | $this->log("Set new options for processing image."); |
||
793 | |||
794 | $defaults = array( |
||
795 | // Options for calculate dimensions |
||
796 | 'newWidth' => null, |
||
797 | 'newHeight' => null, |
||
798 | 'aspectRatio' => null, |
||
799 | 'keepRatio' => true, |
||
800 | 'cropToFit' => false, |
||
801 | 'fillToFit' => null, |
||
802 | 'crop' => null, //array('width'=>null, 'height'=>null, 'start_x'=>0, 'start_y'=>0), |
||
803 | 'area' => null, //'0,0,0,0', |
||
804 | 'upscale' => self::UPSCALE_DEFAULT, |
||
805 | |||
806 | // Options for caching or using original |
||
807 | 'useCache' => true, |
||
808 | 'useOriginal' => true, |
||
809 | |||
810 | // Pre-processing, before resizing is done |
||
811 | 'scale' => null, |
||
812 | 'rotateBefore' => null, |
||
813 | 'autoRotate' => false, |
||
814 | |||
815 | // General options |
||
816 | 'bgColor' => null, |
||
817 | |||
818 | // Post-processing, after resizing is done |
||
819 | 'palette' => null, |
||
820 | 'filters' => null, |
||
821 | 'sharpen' => null, |
||
822 | 'emboss' => null, |
||
823 | 'blur' => null, |
||
824 | 'convolve' => null, |
||
825 | 'rotateAfter' => null, |
||
826 | |||
827 | // Output format |
||
828 | 'outputFormat' => null, |
||
829 | 'dpr' => 1, |
||
830 | ); |
||
831 | |||
832 | // Convert crop settings from string to array |
||
833 | if (isset($args['crop']) && !is_array($args['crop'])) { |
||
834 | $pices = explode(',', $args['crop']); |
||
835 | $args['crop'] = array( |
||
836 | 'width' => $pices[0], |
||
837 | 'height' => $pices[1], |
||
838 | 'start_x' => $pices[2], |
||
839 | 'start_y' => $pices[3], |
||
840 | ); |
||
841 | } |
||
842 | |||
843 | // Convert area settings from string to array |
||
844 | if (isset($args['area']) && !is_array($args['area'])) { |
||
845 | $pices = explode(',', $args['area']); |
||
846 | $args['area'] = array( |
||
847 | 'top' => $pices[0], |
||
848 | 'right' => $pices[1], |
||
849 | 'bottom' => $pices[2], |
||
850 | 'left' => $pices[3], |
||
851 | ); |
||
852 | } |
||
853 | |||
854 | // Convert filter settings from array of string to array of array |
||
855 | if (isset($args['filters']) && is_array($args['filters'])) { |
||
856 | foreach ($args['filters'] as $key => $filterStr) { |
||
857 | $parts = explode(',', $filterStr); |
||
858 | $filter = $this->mapFilter($parts[0]); |
||
859 | $filter['str'] = $filterStr; |
||
860 | for ($i=1; $i<=$filter['argc']; $i++) { |
||
861 | if (isset($parts[$i])) { |
||
862 | $filter["arg{$i}"] = $parts[$i]; |
||
863 | } else { |
||
864 | throw new Exception( |
||
865 | 'Missing arg to filter, review how many arguments are needed at |
||
866 | http://php.net/manual/en/function.imagefilter.php' |
||
867 | ); |
||
868 | } |
||
869 | } |
||
870 | $args['filters'][$key] = $filter; |
||
871 | } |
||
872 | } |
||
873 | |||
874 | // Merge default arguments with incoming and set properties. |
||
875 | //$args = array_merge_recursive($defaults, $args); |
||
876 | $args = array_merge($defaults, $args); |
||
877 | foreach ($defaults as $key => $val) { |
||
878 | $this->{$key} = $args[$key]; |
||
879 | } |
||
880 | |||
881 | if ($this->bgColor) { |
||
882 | $this->setDefaultBackgroundColor($this->bgColor); |
||
883 | } |
||
884 | |||
885 | // Save original values to enable re-calculating |
||
886 | $this->newWidthOrig = $this->newWidth; |
||
887 | $this->newHeightOrig = $this->newHeight; |
||
888 | $this->cropOrig = $this->crop; |
||
889 | |||
890 | return $this; |
||
891 | } |
||
892 | |||
893 | |||
894 | |||
895 | /** |
||
896 | * Map filter name to PHP filter and id. |
||
897 | * |
||
898 | * @param string $name the name of the filter. |
||
899 | * |
||
900 | * @return array with filter settings |
||
901 | * @throws Exception |
||
902 | */ |
||
903 | private function mapFilter($name) |
||
926 | |||
927 | |||
928 | |||
929 | /** |
||
930 | * Load image details from original image file. |
||
931 | * |
||
932 | * @param string $file the file to load or null to use $this->pathToImage. |
||
933 | * |
||
934 | * @return $this |
||
935 | * @throws Exception |
||
936 | */ |
||
937 | public function loadImageDetails($file = null) |
||
976 | |||
977 | |||
978 | |||
979 | /** |
||
980 | * Get mime type for image type. |
||
981 | * |
||
982 | * @return $this |
||
983 | * @throws Exception |
||
984 | */ |
||
985 | protected function getMimeType() |
||
993 | |||
994 | |||
995 | |||
996 | /** |
||
997 | * Init new width and height and do some sanity checks on constraints, before any |
||
998 | * processing can be done. |
||
999 | * |
||
1000 | * @return $this |
||
1001 | * @throws Exception |
||
1002 | */ |
||
1003 | public function initDimensions() |
||
1068 | |||
1069 | |||
1070 | |||
1071 | /** |
||
1072 | * Calculate new width and height of image, based on settings. |
||
1073 | * |
||
1074 | * @return $this |
||
1075 | */ |
||
1076 | public function calculateNewWidthAndHeight() |
||
1219 | |||
1220 | |||
1221 | |||
1222 | /** |
||
1223 | * Re-calculate image dimensions when original image dimension has changed. |
||
1224 | * |
||
1225 | * @return $this |
||
1226 | */ |
||
1227 | public function reCalculateDimensions() |
||
1240 | |||
1241 | |||
1242 | |||
1243 | /** |
||
1244 | * Set extension for filename to save as. |
||
1245 | * |
||
1246 | * @param string $saveas extension to save image as |
||
1247 | * |
||
1248 | * @return $this |
||
1249 | */ |
||
1250 | public function setSaveAsExtension($saveAs = null) |
||
1263 | |||
1264 | |||
1265 | |||
1266 | /** |
||
1267 | * Set JPEG quality to use when saving image |
||
1268 | * |
||
1269 | * @param int $quality as the quality to set. |
||
1270 | * |
||
1271 | * @return $this |
||
1272 | */ |
||
1273 | public function setJpegQuality($quality = null) |
||
1290 | |||
1291 | |||
1292 | |||
1293 | /** |
||
1294 | * Set PNG compressen algorithm to use when saving image |
||
1295 | * |
||
1296 | * @param int $compress as the algorithm to use. |
||
1297 | * |
||
1298 | * @return $this |
||
1299 | */ |
||
1300 | public function setPngCompression($compress = null) |
||
1317 | |||
1318 | 2 | ||
1319 | 2 | ||
1320 | /** |
||
1321 | 2 | * Use original image if possible, check options which affects image processing. |
|
1322 | 2 | * |
|
1323 | * @param boolean $useOrig default is to use original if possible, else set to false. |
||
1324 | * |
||
1325 | * @return $this |
||
1326 | 2 | */ |
|
1327 | 2 | public function useOriginalIfPossible($useOrig = true) |
|
1357 | 2 | ||
1358 | 2 | ||
1359 | |||
1360 | 2 | /** |
|
1361 | 2 | * Generate filename to save file in cache. |
|
1362 | * |
||
1363 | * @param string $base as optional basepath for storing file. |
||
1364 | * @param boolean $useSubdir use or skip the subdir part when creating the |
||
1365 | 2 | * filename. |
|
1366 | 2 | * @param string $prefix to add as part of filename |
|
1367 | * |
||
1368 | * @return $this |
||
1369 | */ |
||
1370 | 2 | public function generateFilename($base = null, $useSubdir = true, $prefix = null) |
|
1453 | |||
1454 | |||
1455 | |||
1456 | /** |
||
1457 | * Use cached version of image, if possible. |
||
1458 | * |
||
1459 | * @param boolean $useCache is default true, set to false to avoid using cached object. |
||
1460 | * |
||
1461 | * @return $this |
||
1462 | */ |
||
1463 | public function useCacheIfPossible($useCache = true) |
||
1488 | |||
1489 | |||
1490 | |||
1491 | /** |
||
1492 | * Load image from disk. Try to load image without verbose error message, |
||
1493 | * if fail, load again and display error messages. |
||
1494 | * |
||
1495 | * @param string $src of image. |
||
1496 | * @param string $dir as base directory where images are. |
||
1497 | * |
||
1498 | * @return $this |
||
1499 | * |
||
1500 | */ |
||
1501 | public function load($src = null, $dir = null) |
||
1544 | |||
1545 | |||
1546 | |||
1547 | /** |
||
1548 | * Get the type of PNG image. |
||
1549 | * |
||
1550 | * @param string $filename to use instead of default. |
||
1551 | * |
||
1552 | * @return int as the type of the png-image |
||
1553 | * |
||
1554 | */ |
||
1555 | public function getPngType($filename = null) |
||
1568 | |||
1569 | |||
1570 | |||
1571 | /** |
||
1572 | * Get the type of PNG image as a verbose string. |
||
1573 | * |
||
1574 | * @param integer $type to use, default is to check the type. |
||
1575 | * @param string $filename to use instead of default. |
||
1576 | * |
||
1577 | * @return int as the type of the png-image |
||
1578 | * |
||
1579 | */ |
||
1580 | private function getPngTypeAsString($pngType = null, $filename = null) |
||
1620 | |||
1621 | |||
1622 | |||
1623 | |||
1624 | /** |
||
1625 | * Calculate number of colors in an image. |
||
1626 | * |
||
1627 | * @param resource $im the image. |
||
1628 | * |
||
1629 | * @return int |
||
1630 | */ |
||
1631 | private function colorsTotal($im) |
||
1649 | |||
1650 | |||
1651 | |||
1652 | /** |
||
1653 | * Preprocess image before rezising it. |
||
1654 | * |
||
1655 | * @return $this |
||
1656 | */ |
||
1657 | public function preResize() |
||
1689 | |||
1690 | |||
1691 | |||
1692 | /** |
||
1693 | * Resize or resample the image while resizing. |
||
1694 | * |
||
1695 | * @param int $strategy as CImage::RESIZE or CImage::RESAMPLE |
||
1696 | * |
||
1697 | * @return $this |
||
1698 | */ |
||
1699 | public function setCopyResizeStrategy($strategy) |
||
1704 | |||
1705 | |||
1706 | |||
1707 | /** |
||
1708 | * Resize and or crop the image. |
||
1709 | * |
||
1710 | * @return void |
||
1711 | */ |
||
1712 | public function imageCopyResampled($dst_image, $src_image, $dst_x, $dst_y, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h) |
||
1722 | |||
1723 | |||
1724 | |||
1725 | /** |
||
1726 | * Resize and or crop the image. |
||
1727 | * |
||
1728 | * @return $this |
||
1729 | */ |
||
1730 | public function resize() |
||
1902 | |||
1903 | |||
1904 | |||
1905 | /** |
||
1906 | * Postprocess image after rezising image. |
||
1907 | * |
||
1908 | * @return $this |
||
1909 | */ |
||
1910 | public function postResize() |
||
1983 | |||
1984 | |||
1985 | |||
1986 | /** |
||
1987 | * Rotate image using angle. |
||
1988 | * |
||
1989 | * @param float $angle to rotate image. |
||
1990 | * @param int $anglebgColor to fill image with if needed. |
||
1991 | * |
||
1992 | * @return $this |
||
1993 | */ |
||
1994 | public function rotate($angle, $bgColor) |
||
2008 | |||
2009 | |||
2010 | |||
2011 | /** |
||
2012 | * Rotate image using information in EXIF. |
||
2013 | * |
||
2014 | * @return $this |
||
2015 | */ |
||
2016 | public function rotateExif() |
||
2051 | |||
2052 | |||
2053 | |||
2054 | /** |
||
2055 | * Convert true color image to palette image, keeping alpha. |
||
2056 | * http://stackoverflow.com/questions/5752514/how-to-convert-png-to-8-bit-png-using-php-gd-library |
||
2057 | * |
||
2058 | * @return void |
||
2059 | */ |
||
2060 | public function trueColorToPalette() |
||
2077 | |||
2078 | |||
2079 | |||
2080 | /** |
||
2081 | * Sharpen image using image convolution. |
||
2082 | * |
||
2083 | * @return $this |
||
2084 | */ |
||
2085 | public function sharpenImage() |
||
2090 | |||
2091 | |||
2092 | |||
2093 | /** |
||
2094 | * Emboss image using image convolution. |
||
2095 | * |
||
2096 | * @return $this |
||
2097 | */ |
||
2098 | public function embossImage() |
||
2103 | |||
2104 | |||
2105 | |||
2106 | /** |
||
2107 | * Blur image using image convolution. |
||
2108 | * |
||
2109 | * @return $this |
||
2110 | */ |
||
2111 | public function blurImage() |
||
2116 | |||
2117 | |||
2118 | |||
2119 | /** |
||
2120 | * Create convolve expression and return arguments for image convolution. |
||
2121 | * |
||
2122 | * @param string $expression constant string which evaluates to a list of |
||
2123 | * 11 numbers separated by komma or such a list. |
||
2124 | * |
||
2125 | * @return array as $matrix (3x3), $divisor and $offset |
||
2126 | */ |
||
2127 | public function createConvolveArguments($expression) |
||
2161 | |||
2162 | |||
2163 | |||
2164 | /** |
||
2165 | * Add custom expressions (or overwrite existing) for image convolution. |
||
2166 | * |
||
2167 | * @param array $options Key value array with strings to be converted |
||
2168 | * to convolution expressions. |
||
2169 | * |
||
2170 | * @return $this |
||
2171 | */ |
||
2172 | public function addConvolveExpressions($options) |
||
2177 | |||
2178 | |||
2179 | |||
2180 | /** |
||
2181 | 2 | * Image convolution. |
|
2182 | * |
||
2183 | 2 | * @param string $options A string with 11 float separated by comma. |
|
2184 | * |
||
2185 | 2 | * @return $this |
|
2186 | */ |
||
2187 | 2 | public function imageConvolution($options = null) |
|
2204 | |||
2205 | |||
2206 | |||
2207 | /** |
||
2208 | * Set default background color between 000000-FFFFFF or if using |
||
2209 | * alpha 00000000-FFFFFF7F. |
||
2210 | * |
||
2211 | * @param string $color as hex value. |
||
2212 | * |
||
2213 | * @return $this |
||
2214 | */ |
||
2215 | 2 | public function setDefaultBackgroundColor($color) |
|
2257 | |||
2258 | |||
2259 | |||
2260 | /** |
||
2261 | * Get the background color. |
||
2262 | * |
||
2263 | * @param resource $img the image to work with or null if using $this->image. |
||
2264 | * |
||
2265 | * @return color value or null if no background color is set. |
||
2266 | */ |
||
2267 | private function getBackgroundColor($img = null) |
||
2290 | 2 | ||
2291 | |||
2292 | |||
2293 | /** |
||
2294 | * Create a image and keep transparency for png and gifs. |
||
2295 | * |
||
2296 | * @param int $width of the new image. |
||
2297 | * @param int $height of the new image. |
||
2298 | * |
||
2299 | * @return image resource. |
||
2300 | */ |
||
2301 | private function createImageKeepTransparency($width, $height) |
||
2330 | |||
2331 | |||
2332 | |||
2333 | /** |
||
2334 | * Set optimizing and post-processing options. |
||
2335 | * |
||
2336 | * @param array $options with config for postprocessing with external tools. |
||
2337 | * |
||
2338 | * @return $this |
||
2339 | */ |
||
2340 | public function setPostProcessingOptions($options) |
||
2362 | |||
2363 | |||
2364 | |||
2365 | /** |
||
2366 | * Find out the type (file extension) for the image to be saved. |
||
2367 | * |
||
2368 | * @return string as image extension. |
||
2369 | */ |
||
2370 | 2 | protected function getTargetImageExtension() |
|
2381 | 2 | ||
2382 | 2 | ||
2383 | |||
2384 | 2 | /** |
|
2385 | * Save image. |
||
2386 | * |
||
2387 | * @param string $src as target filename. |
||
2388 | * @param string $base as base directory where to store images. |
||
2389 | * @param boolean $overwrite or not, default to always overwrite file. |
||
2390 | * |
||
2391 | * @return $this or false if no folder is set. |
||
2392 | */ |
||
2393 | public function save($src = null, $base = null, $overwrite = true) |
||
2490 | |||
2491 | |||
2492 | |||
2493 | /** |
||
2494 | * Convert image from one colorpsace/color profile to sRGB without |
||
2495 | * color profile. |
||
2496 | * |
||
2497 | * @param string $src of image. |
||
2498 | * @param string $dir as base directory where images are. |
||
2499 | * @param string $cache as base directory where to store images. |
||
2500 | * @param string $iccFile filename of colorprofile. |
||
2501 | * @param boolean $useCache or not, default to always use cache. |
||
2502 | * |
||
2503 | * @return string | boolean false if no conversion else the converted |
||
2504 | * filename. |
||
2505 | */ |
||
2506 | public function convert2sRGBColorSpace($src, $dir, $cache, $iccFile, $useCache = true) |
||
2558 | |||
2559 | |||
2560 | |||
2561 | /** |
||
2562 | * Create a hard link, as an alias, to the cached file. |
||
2563 | * |
||
2564 | * @param string $alias where to store the link, |
||
2565 | * filename without extension. |
||
2566 | * |
||
2567 | * @return $this |
||
2568 | */ |
||
2569 | public function linkToCacheFile($alias) |
||
2590 | |||
2591 | |||
2592 | |||
2593 | /** |
||
2594 | * Add HTTP header for output together with image. |
||
2595 | * |
||
2596 | * @param string $type the header type such as "Cache-Control" |
||
2597 | * @param string $value the value to use |
||
2598 | * |
||
2599 | * @return void |
||
2600 | */ |
||
2601 | public function addHTTPHeader($type, $value) |
||
2605 | |||
2606 | |||
2607 | |||
2608 | /** |
||
2609 | * Output image to browser using caching. |
||
2610 | * |
||
2611 | * @param string $file to read and output, default is to |
||
2612 | * use $this->cacheFileName |
||
2613 | * @param string $format set to json to output file as json |
||
2614 | * object with details |
||
2615 | * |
||
2616 | * @return void |
||
2617 | */ |
||
2618 | public function output($file = null, $format = null) |
||
2711 | |||
2712 | |||
2713 | |||
2714 | /** |
||
2715 | * Create a JSON object from the image details. |
||
2716 | * |
||
2717 | * @param string $file the file to output. |
||
2718 | * |
||
2719 | * @return string json-encoded representation of the image. |
||
2720 | */ |
||
2721 | public function json($file = null) |
||
2766 | |||
2767 | |||
2768 | |||
2769 | /** |
||
2770 | * Set options for creating ascii version of image. |
||
2771 | * |
||
2772 | * @param array $options empty to use default or set options to change. |
||
2773 | * |
||
2774 | * @return void. |
||
2775 | */ |
||
2776 | public function setAsciiOptions($options = array()) |
||
2780 | |||
2781 | |||
2782 | |||
2783 | /** |
||
2784 | * Create an ASCII version from the image details. |
||
2785 | * |
||
2786 | * @param string $file the file to output. |
||
2787 | * |
||
2788 | * @return string ASCII representation of the image. |
||
2789 | */ |
||
2790 | public function ascii($file = null) |
||
2798 | |||
2799 | |||
2800 | |||
2801 | /** |
||
2802 | * Log an event if verbose mode. |
||
2803 | * |
||
2804 | * @param string $message to log. |
||
2805 | * |
||
2806 | * @return this |
||
2807 | */ |
||
2808 | public function log($message) |
||
2816 | |||
2817 | |||
2818 | |||
2819 | /** |
||
2820 | * Do verbose output to a file. |
||
2821 | * |
||
2822 | * @param string $fileName where to write the verbose output. |
||
2823 | * |
||
2824 | * @return void |
||
2825 | */ |
||
2826 | public function setVerboseToFile($fileName) |
||
2831 | |||
2832 | |||
2833 | |||
2834 | /** |
||
2835 | * Do verbose output and print out the log and the actual images. |
||
2836 | * |
||
2837 | * @return void |
||
2838 | */ |
||
2839 | private function verboseOutput() |
||
2872 | |||
2873 | |||
2874 | |||
2875 | /** |
||
2876 | * Raise error, enables to implement a selection of error methods. |
||
2877 | * |
||
2878 | * @param string $message the error message to display. |
||
2879 | * |
||
2880 | * @return void |
||
2881 | * @throws Exception |
||
2882 | */ |
||
2883 | private function raiseError($message) |
||
2887 | } |
||
2888 |
You can fix this by adding a namespace to your class:
When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries.