Source for file Image.php

Documentation is available at Image.php

1: <?php
2:
3: /**
4: * Nette Framework
5: *
6: * Copyright (c) 2004, 2009 David Grudl (http://davidgrudl.com)
7: *
8: * This source file is subject to the "Nette license" that is bundled
9: * with this package in the file license.txt.
10: *
11: * For more information please see https://nette.org
12: *
13: * @copyright Copyright (c) 2004, 2009 David Grudl
14: * @license https://nette.org/license Nette license
15: * @link https://nette.org
16: * @category Nette
17: * @package Nette
18: * @version $Id$
19: */
20:
21:
22:
23: require_once dirname(__FILE__) . '/Object.php';
24:
25:
26:
27: /**
28: * Basic manipulation with images.
29: *
30: * <code>
31: * $image = Image::fromFile('nette.jpg');
32: * $image->resize(150, 100);
33: * $image->sharpen();
34: * $image->send();
35: * </code>
36: *
37: * @author David Grudl
38: * @copyright Copyright (c) 2004, 2009 David Grudl
39: * @package Nette
40: */
41: class Image extends Object
42: {
43: /**#@+ resizing flags {@link resize()} */
44: const ENLARGE = 1;
45: const STRETCH = 2;
46: /**#@-*/
47:
48: /**#@+ @int image types {@link send()} */
49: const JPEG = IMAGETYPE_JPEG;
50: const PNG = IMAGETYPE_PNG;
51: const GIF = IMAGETYPE_GIF;
52: /**#@-*/
53:
54: const EMPTY_GIF = "GIF89a\x01\x00\x01\x00\x80\x00\x00\x00\x00\x00\x00\x00\x00!\xf9\x04\x01\x00\x00\x00\x00,\x00\x00\x00\x00\x01\x00\x01\x00\x00\x02\x02D\x01\x00;";
55:
56: /** @var bool */
57: public static $useImageMagick = FALSE;
58:
59: /** @var resource */
60: private $image;
61:
62:
63:
64: /**
65: * Returns RGB color.
66: * @param int red 0..255
67: * @param int green 0..255
68: * @param int blue 0..255
69: * @param int transparency 0..127
70: * @return array
71: */
72: public static function rgb($red, $green, $blue, $transparency = 0)
73: {
74: return array(
75: 'red' => max(0, min(255, (int) $red)),
76: 'green' => max(0, min(255, (int) $green)),
77: 'blue' => max(0, min(255, (int) $blue)),
78: 'alpha' => max(0, min(127, (int) $transparency)),
79: );
80: }
81:
82:
83:
84: /**
85: * Opens image from file.
86: * @param string
87: * @param mixed detected image format
88: * @return Image
89: */
90: public static function fromFile($file, & $format = NULL)
91: {
92: if (!extension_loaded('gd')) {
93: throw new Exception("PHP extension GD is not loaded.");
94: }
95:
96: $info = getimagesize($file);
97: if (self::$useImageMagick && (empty($info) || $info[0] * $info[1] > 2e6)) {
98: return new ImageMagick($file, $format);
99: }
100:
101: switch ($format = $info[2]) {
102: case self::JPEG:
103: return new self(imagecreatefromjpeg($file));
104:
105: case self::PNG:
106: return new self(imagecreatefrompng($file));
107:
108: case self::GIF:
109: return new self(imagecreatefromgif($file));
110:
111: default:
112: if (self::$useImageMagick) {
113: return new ImageMagick($file, $format);
114: }
115: throw new Exception("Unknown image type in file '$file'.");
116: }
117: }
118:
119:
120:
121: /**
122: * Create a new image from the image stream in the string.
123: * @param string
124: * @return Image
125: */
126: public static function fromString($s)
127: {
128: return new self(imagecreatefromstring($s));
129: }
130:
131:
132:
133: /**
134: * Creates blank image.
135: * @param int
136: * @param int
137: * @param array
138: * @return Image
139: */
140: public static function fromBlank($width, $height, $color = NULL)
141: {
142: if (!extension_loaded('gd')) {
143: throw new Exception("PHP extension GD is not loaded.");
144: }
145:
146: $width = (int) $width;
147: $height = (int) $height;
148: if ($width < 1 || $height < 1) {
149: throw new InvalidArgumentException('Image width and height must be greater than zero.');
150: }
151:
152: $image = imagecreatetruecolor($width, $height);
153: if (is_array($color)) {
154: $color = imagecolorallocate($image, $color['red'], $color['green'], $color['blue']);
155: imagefilledrectangle($image, 0, 0, $width, $height, $color);
156: }
157: return new self($image);
158: }
159:
160:
161:
162: /**
163: * Wraps GD image.
164: * @param resource
165: */
166: public function __construct($image)
167: {
168: $this->setImageResource($image);
169: }
170:
171:
172:
173: /**
174: * Returns image width.
175: * @return int
176: */
177: public function getWidth()
178: {
179: return imagesx($this->image);
180: }
181:
182:
183:
184: /**
185: * Returns image height.
186: * @return int
187: */
188: public function getHeight()
189: {
190: return imagesy($this->image);
191: }
192:
193:
194:
195: /**
196: * Sets image resource.
197: * @param resource
198: * @return void
199: */
200: protected function setImageResource($image)
201: {
202: if (!is_resource($image) || get_resource_type($image) !== 'gd') {
203: throw new InvalidArgumentException('Image is not valid.');
204: }
205: $this->image = $image;
206: }
207:
208:
209:
210: /**
211: * Returns image GD resource.
212: * @return resource
213: */
214: public function getImageResource()
215: {
216: return $this->image;
217: }
218:
219:
220:
221: /**
222: * Resizes image.
223: * @param mixed width in pixels or percent
224: * @param mixed height in pixels or percent
225: * @param int flags
226: * @return Image provides a fluent interface
227: */
228: public function resize($newWidth, $newHeight, $flags = 0)
229: {
230: list($newWidth, $newHeight) = $this->calculateSize($newWidth, $newHeight, $flags);
231: $newImage = imagecreatetruecolor($newWidth, $newHeight);
232: imagecopyresampled($newImage, $this->getImageResource(), 0, 0, 0, 0, $newWidth, $newHeight, $this->getWidth(), $this->getHeight());
233: $this->image = $newImage;
234: return $this;
235: }
236:
237:
238:
239: /**
240: * Calculates dimensions of resized image.
241: * @param mixed width in pixels or percent
242: * @param mixed height in pixels or percent
243: * @param int flags
244: * @return array
245: */
246: public function calculateSize($newWidth, $newHeight, $flags = 0)
247: {
248: $width = $this->getWidth();
249: $height = $this->getHeight();
250:
251: if (substr($newWidth, -1) === '%') {
252: $newWidth = round($width / 100 * $newWidth);
253: $flags |= self::ENLARGE;
254: $percents = TRUE;
255: } else {
256: $newWidth = (int) $newWidth;
257: }
258:
259: if (substr($newHeight, -1) === '%') {
260: $newHeight = round($height / 100 * $newHeight);
261: $flags |= empty($percents) ? self::ENLARGE : self::STRETCH;
262: } else {
263: $newHeight = (int) $newHeight;
264: }
265:
266: if ($flags & self::STRETCH) { // non-proportional
267: if ($newWidth < 1 || $newHeight < 1) {
268: throw new InvalidArgumentException('For stretching must be both width and height specified.');
269: }
270:
271: if (($flags & self::ENLARGE) === 0) {
272: $newWidth = round($width * min(1, $newWidth / $width));
273: $newHeight = round($height * min(1, $newHeight / $height));
274: }
275:
276: } else { // proportional
277: if ($newWidth < 1 && $newHeight < 1) {
278: throw new InvalidArgumentException('At least width or height must be specified.');
279: }
280:
281: $scale = array();
282: if ($newWidth > 0) { // fit width
283: $scale[] = $newWidth / $width;
284: }
285:
286: if ($newHeight > 0) { // fit height
287: $scale[] = $newHeight / $height;
288: }
289:
290: if (($flags & self::ENLARGE) === 0) {
291: $scale[] = 1;
292: }
293:
294: $scale = min($scale);
295: $newWidth = round($width * $scale);
296: $newHeight = round($height * $scale);
297: }
298:
299: return array($newWidth, $newHeight);
300: }
301:
302:
303:
304: /**
305: * Crops image.
306: * @param int x-coordinate
307: * @param int y-coordinate
308: * @param int width
309: * @param int height
310: * @return Image provides a fluent interface
311: */
312: public function crop($left, $top, $width, $height)
313: {
314: $left = max(0, (int) $left);
315: $top = max(0, (int) $top);
316: $width = min((int) $width, $this->getWidth() - $left);
317: $height = min((int) $height, $this->getHeight() - $top);
318:
319: $newImage = imagecreatetruecolor($width, $height);
320: imagecopy($newImage, $this->getImageResource(), 0, 0, $left, $top, $width, $height);
321: $this->image = $newImage;
322: return $this;
323: }
324:
325:
326:
327: /**
328: * Sharpen image.
329: * @return Image provides a fluent interface
330: */
331: public function sharpen()
332: {
333: imageconvolution($this->getImageResource(), array( // my magic numbers ;)
334: array( -1, -1, -1 ),
335: array( -1, 24, -1 ),
336: array( -1, -1, -1 ),
337: ), 16, 0);
338: return $this;
339: }
340:
341:
342:
343: /**
344: * Puts another image into this image.
345: * @param Image
346: * @param mixed x-coordinate in pixels or percent
347: * @param mixed y-coordinate in pixels or percent
348: * @param int opacity 0..100
349: * @return Image provides a fluent interface
350: */
351: public function place(Image $image, $left = 0, $top = 0, $opacity = 100)
352: {
353: $opacity = max(0, min(100, (int) $opacity));
354:
355: if (substr($left, -1) === '%') {
356: $left = round(($this->getWidth() - $image->getWidth()) / 100 * $left);
357: }
358:
359: if (substr($top, -1) === '%') {
360: $top = round(($this->getHeight() - $image->getHeight()) / 100 * $top);
361: }
362:
363: if ($opacity === 100) {
364: imagecopy($this->getImageResource(), $image->getImageResource(), $left, $top, 0, 0, $image->getWidth(), $image->getHeight());
365:
366: } elseif ($opacity <> 0) {
367: imagecopymerge($this->getImageResource(), $image->getImageResource(), $left, $top, 0, 0, $image->getWidth(), $image->getHeight(), $opacity);
368: }
369: return $this;
370: }
371:
372:
373:
374: /**
375: * Saves image to the file.
376: * @param string filename
377: * @param int quality 0..100 (for JPEG and PNG)
378: * @param int optional image type
379: * @return bool TRUE on success or FALSE on failure.
380: */
381: public function save($file = NULL, $quality = NULL, $type = NULL)
382: {
383: if ($type === NULL) {
384: switch (strtolower(pathinfo($file, PATHINFO_EXTENSION))) {
385: case 'jpg':
386: case 'jpeg':
387: $type = self::JPEG;
388: break;
389: case 'png':
390: $type = self::PNG;
391: break;
392: case 'gif':
393: $type = self::GIF;
394: }
395: }
396:
397: switch ($type) {
398: case self::JPEG:
399: $quality = $quality === NULL ? 85 : max(0, min(100, (int) $quality));
400: return imagejpeg($this->getImageResource(), $file, $quality);
401:
402: case self::PNG:
403: $quality = $quality === NULL ? 9 : max(0, min(9, (int) $quality));
404: return imagepng($this->getImageResource(), $file, $quality);
405:
406: case self::GIF:
407: return imagegif($this->getImageResource(), $file);
408:
409: default:
410: throw new Exception("Unsupported image type.");
411: }
412: }
413:
414:
415:
416: /**
417: * Outputs image to string.
418: * @param int image type
419: * @param int quality 0..100 (for JPEG and PNG)
420: * @return string
421: */
422: public function toString($type = self::JPEG, $quality = NULL)
423: {
424: ob_start();
425: $this->save(NULL, $quality, $type);
426: return ob_get_clean();
427: }
428:
429:
430:
431: /**
432: * Outputs image to string.
433: * @return string
434: */
435: public function __toString()
436: {
437: try {
438: return $this->toString();
439:
440: } catch (Exception $e) {
441: trigger_error($e->getMessage(), E_USER_WARNING);
442: return '';
443: }
444: }
445:
446:
447:
448: /**
449: * Outputs image to browser.
450: * @param int image type
451: * @param int quality 0..100 (for JPEG and PNG)
452: * @return bool TRUE on success or FALSE on failure.
453: */
454: public function send($type = self::JPEG, $quality = NULL)
455: {
456: if ($type !== self::GIF && $type !== self::PNG && $type !== self::JPEG) {
457: throw new Exception("Unsupported image type.");
458: }
459: header('Content-Type: ' . image_type_to_mime_type($type));
460: return $this->save(NULL, $quality, $type);
461: }
462:
463:
464:
465: /**
466: * Call to undefined method.
467: *
468: * @param string method name
469: * @param array arguments
470: * @return mixed
471: * @throws MemberAccessException
472: */
473: public function __call($name, $args)
474: {
475: $function = 'image' . $name;
476: if (function_exists($function)) {
477: foreach ($args as $key => $value) {
478: if ($value instanceof self) {
479: $args[$key] = $value->getImageResource();
480:
481: } elseif (is_array($value) && isset($value['red'])) { // rgb
482: $args[$key] = imagecolorallocatealpha($this->getImageResource(), $value['red'], $value['green'], $value['blue'], $value['alpha']);
483: }
484: }
485: array_unshift($args, $this->getImageResource());
486:
487: return call_user_func_array($function, $args);
488: }
489:
490: return parent::__call($name, $args);
491: }
492:
493: }

Source for file Image.php

Namespaces