1: 2: 3: 4: 5: 6: 7: 8: 9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 73: 74: 75: 76: 77: 78: 79: 80: 81: 82: 83: 84: 85: 86: 87: 88: 89: 90: 91: 92: 93: 94: 95: 96: 97: 98: 99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 385: 386: 387: 388: 389: 390: 391: 392: 393: 394: 395: 396: 397: 398: 399: 400: 401: 402: 403: 404: 405: 406: 407: 408: 409: 410: 411: 412: 413: 414: 415: 416: 417: 418: 419: 420: 421: 422: 423: 424: 425: 426: 427: 428: 429: 430: 431: 432: 433: 434: 435: 436: 437: 438: 439: 440: 441: 442: 443: 444: 445: 446: 447: 448: 449: 450: 451: 452: 453: 454: 455: 456: 457: 458: 459: 460: 461: 462: 463: 464: 465: 466: 467: 468: 469: 470: 471: 472: 473: 474: 475: 476: 477: 478: 479: 480: 481: 482: 483: 484: 485: 486: 487: 488: 489: 490: 491: 492: 493: 494: 495: 496: 497: 498: 499: 500: 501: 502: 503: 504: 505: 506: 507: 508: 509: 510: 511: 512: 513: 514: 515: 516: 517: 518: 519: 520: 521: 522: 523: 524: 525: 526: 527: 528: 529: 530: 531: 532: 533: 534: 535: 536: <?php
/**
* MvcCore
*
* This source file is subject to the BSD 3 License
* For the full copyright and license information, please view
* the LICENSE.md file that are distributed with this source code.
*
* @copyright Copyright (c) 2016 Tom Flidr (https://github.com/mvccore)
* @license https://mvccore.github.io/docs/mvccore/5.0.0/LICENCE.md
*/
namespace MvcCore\Ext\Tools;
abstract class Image implements \MvcCore\Ext\Tools\Images\IImage {
/**
* MvcCore Extension - Router Media - version:
* Comparison by PHP function version_compare();
* @see http://php.net/manual/en/function.version-compare.php
*/
const VERSION = '5.0.0';
/**
* @var int
*/
protected $width;
/**
* @var int
*/
protected $height;
/**
* @var \Imagick|resource
*/
protected $resource;
/**
* @var array
*/
protected $tmpFiles = [];
/**
* Full directory path for computation temporary images.
* @var string
*/
protected static $tmpDir = NULL;
/**
* Returns every time new (no singleton) `\MvcCore\Ext\Tools\Image` instance implementation.
* If there is `Imagick` extension loaded and no `$preferredAdapter` presented,
* `Imagick` instance is always created more preferably than `GD` instance.
* If there is no `Imagick` and no `GD` extension loaded, new `\RuntimeException` exception is thrown.
* @param int|\MvcCore\Ext\Tools\Images\IAdapter $preferredAdapter optional
* @throws \RuntimeException
* @return \MvcCore\Ext\Tools\Images\Imagick|\MvcCore\Ext\Tools\Images\Gd
*/
public static function CreateInstance ($preferredAdapter = \MvcCore\Ext\Tools\Images\IAdapter::NONE) {
$imagick = extension_loaded("imagick");
$gd = extension_loaded("gd");
if ($preferredAdapter == \MvcCore\Ext\Tools\Images\IAdapter::IMAGICK) {
$result = new \MvcCore\Ext\Tools\Images\Imagick;
} else if ($preferredAdapter == \MvcCore\Ext\Tools\Images\IAdapter::GD) {
$result = new \MvcCore\Ext\Tools\Images\Gd;
} else {
if ($imagick) {
$supportedFormats = \Imagick::queryformats();
if (count($supportedFormats) === 0) {
$imagick = FALSE;
trigger_error(
"Installed `Imagemagick` has zero supported graphic formats.",
E_USER_NOTICE
);
}
}
if ($imagick) {
$result = new \MvcCore\Ext\Tools\Images\Imagick;
} else if ($gd) {
$result = new \MvcCore\Ext\Tools\Images\Gd;
} else {
throw new \RuntimeException(
"No PHP extension for image processing installed ('gd' or 'imagick')."
);
}
}
return $result;
}
/**
* Get full directory path for temporary images computation.
* If no temporary path configured, there is used default
* system temporary directory from `\MvcCore\Tool::GetSystemTmpDir();`.
* @return string
*/
public static function GetTmpDirPath () {
if (static::$tmpDir === NULL)
static::SetTmpDirPath(
\MvcCore\Tool::GetSystemTmpDir()
);
return static::$tmpDir;
}
/**
* Set custom full directory path for computation temporary images.
* @param string $fullPath
*/
public static function SetTmpDirPath ($fullPath) {
return static::$tmpDir = static::checkTmpDirPath($fullPath);
}
/**
* Check given full path for existence and images reading/writing.
* @param string $fullPath
* @throws \RuntimeException
* @return string
*/
protected static function checkTmpDirPath ($fullPath) {
if (!is_dir($fullPath)) {
if (!mkdir($fullPath))
throw new \RuntimeException(
'['.get_class()."] It was not possible to create temporary"
." directory for computed images: `{$fullPath}`."
);
if (!is_writable($fullPath))
if (!chmod($fullPath, 0666))
throw new \RuntimeException(
'['.get_class()."] It was not possible to set temporary"
." directory for computed images: `{$fullPath}`"
." to writeable mode 0666."
);
}
return $fullPath;
}
/**
* @param string $hexColor Color in hexadecimal format with or without leading hash.
* @return array [$r, $g, $b, 'type' => 'RGB'];
*/
public static function HexColor2RgbArrayColor ($hexColor) {
$hexColor = trim($hexColor, '#');
$r = hexdec(substr($hexColor, 1, 2));
$g = hexdec(substr($hexColor, 3, 2));
$b = hexdec(substr($hexColor, 5, 2));
return [$r, $g, $b, 'type' => 'RGB'];
}
/**
* Remove all temporary images from `$this->tmpFiles`.
* @return void
*/
public function __destruct() {
$this->removeTmpFiles();
}
/**
* Get image pixel width.
* @return int
*/
public function GetWidth () {
return $this->width;
}
/**
* Get image pixel height.
* @return int
*/
public function GetHeight () {
return $this->height;
}
/**
* Scale source image by width with maintaining the aspect ratio.
* @param int $width Pixel width.
* @return \MvcCore\Ext\Tools\Image
*/
public function ResizeByWidth ($width) {
$height = round(($width / $this->GetWidth()) * $this->GetHeight(), 0);
$this->Resize(max(1, $width), max(1, $height));
return $this;
}
/**
* Scale source image by height with maintaining the aspect ratio.
* @param int $height Pixel height.
* @return \MvcCore\Ext\Tools\Image
*/
public function ResizeByHeight ($height) {
$width = round(($height / $this->GetHeight()) * $this->GetWidth(), 0);
$this->Resize(max(1, $width), max(1, $height));
return $this;
}
/**
* Scale source image by total final count of pixels in the resized image.
* Useful for list of logotypes, where is necessary to scale all logotypes into
* the same visual space - with approximately the same importance by filled space,
* so not resized by height or not by width, logotypes have always different proportions.
* @param int $resizedImgTotalPixelsCount Pixels count, computed by target width × height,
* so if you want all images with approximately the same
* size around 100 × 100 pixels, value will be 100 × 100 = 10000.
* @return \MvcCore\Ext\Tools\Image
*/
public function ResizeByPixelsCount ($resizedImgTotalPixelsCount) {
$targetSqrt = sqrt($resizedImgTotalPixelsCount);
$sourceSqrt = sqrt($this->GetWidth() * $this->GetHeight());
$sqrtRatio = $targetSqrt / $sourceSqrt;
$newWidth = intval(round($this->GetWidth() * $sqrtRatio));
$newHeight = intval(round($this->GetHeight() * $sqrtRatio));
$this->Resize(max(1, $newWidth), max(1, $newHeight));
return $this;
}
/**
* Image will be resized into sizes not larger than `$width`
* or `$height` params with maintaining the aspect ratio.
* @param int $width Pixel width.
* @param int $height Pixel height.
* @return \MvcCore\Ext\Tools\Image
*/
public function Contain ($width, $height) {
$x = $this->GetWidth() / $width;
$y = $this->GetHeight() / $height;
if ($x <= 1 && $y <= 1 && !$this->IsVectorGraphic()) {
return $this;
} else if ($x > $y) {
$this->ResizeByWidth($width);
} else {
$this->ResizeByHeight($height);
}
return $this;
}
/**
* Image will be resized into given `$width` and `$height` to cover whole place,
* with optional orientation of source image to cover final place.
* Possible orientation values are integers with this meaning:
* - `1` - top left
* - `2` - top center
* - `3` - top right
* - `4` - middle left
* - `5` - middle center
* - `6` - middle right
* - `7` - bottom left
* - `8` - bottom center
* - `9` - bottom right
* @param int $width Pixel width.
* @param int $height Pixel height.
* @param int|\MvcCore\Ext\Tools\Images\IOrientation $orientation Possible orientation values are integers by `\MvcCore\Ext\Tools\Images\IOrientation` interface constants.
* @throws \InvalidArgumentException
* @return \MvcCore\Ext\Tools\Image
*/
public function Cover ($width, $height, $orientation = \MvcCore\Ext\Tools\Images\IOrientation::MIDDLE_CENTER) {
$ratio = $this->GetWidth() / $this->GetHeight();
if (($width / $height) > $ratio) {
$this->ResizeByWidth($width);
} else {
$this->ResizeByHeight($height);
}
if ($orientation == \MvcCore\Ext\Tools\Images\IOrientation::MIDDLE_CENTER) {
$cropX = ($this->GetWidth() - $width)/2;
$cropY = ($this->GetHeight() - $height)/2;
} else if ($orientation == \MvcCore\Ext\Tools\Images\IOrientation::MIDDLE_LEFT) {
$cropX = 0;
$cropY = ($this->GetHeight() - $height)/2;
} else if ($orientation == \MvcCore\Ext\Tools\Images\IOrientation::MIDDLE_RIGHT) {
$cropX = $this->GetWidth() - $width;
$cropY = ($this->GetHeight() - $height)/2;
} else if ($orientation == \MvcCore\Ext\Tools\Images\IOrientation::TOP_LEFT) {
$cropX = 0;
$cropY = 0;
} else if ($orientation == \MvcCore\Ext\Tools\Images\IOrientation::TOP_CENTER) {
$cropX = ($this->GetWidth() - $width)/2;
$cropY = 0;
} else if ($orientation == \MvcCore\Ext\Tools\Images\IOrientation::TOP_RIGHT) {
$cropX = $this->GetWidth() - $width;
$cropY = 0;
} else if ($orientation == \MvcCore\Ext\Tools\Images\IOrientation::BOTTOM_LEFT) {
$cropX = 0;
$cropY = $this->GetHeight() - $height;
} else if ($orientation == \MvcCore\Ext\Tools\Images\IOrientation::BOTTOM_CENTER) {
$cropX = ($this->GetWidth() - $width)/2;
$cropY = $this->GetHeight() - $height;
} else if ($orientation == \MvcCore\Ext\Tools\Images\IOrientation::BOTTOM_RIGHT) {
$cropX = $this->GetWidth() - $width;
$cropY = $this->GetHeight() - $height;
} else {
$cropX = null;
$cropY = null;
}
if ($cropX !== null && $cropY !== null) {
$this->Crop($cropX, $cropY, $width, $height);
} else {
throw new \InvalidArgumentException(
"Cropping not processed, because X or Y is not defined or `NULL`."
);
}
return $this;
}
/**
* Crop image by percentage value from left, top, right and bottom.
* @param int $xPercentage Percentage value to crop from left.
* @param int $yPercentage Percentage value to crop from top.
* @param int $widthPercentage Percentage value to crop from right.
* @param int $heightPercentage Percentage value to crop from bottom.
* @return \MvcCore\Ext\Tools\Image
*/
public function CropPercent ($xPercentage, $yPercentage, $widthPercentage, $heightPercentage) {
$originalWidth = $this->GetWidth();
$originalHeight = $this->GetHeight();
$widthPixel = $originalWidth * ($widthPercentage / 100);
$heightPixel = $originalHeight * ($heightPercentage / 100);
$xPixel = $originalWidth * ($xPercentage / 100);
$yPixel = $originalHeight * ($yPercentage / 100);
return $this->Crop($xPixel, $yPixel, $widthPixel, $heightPixel);
}
/**
* Load image into resource by given file full path.
* @abstract
* @param string $imgFullPath
* @throws \RuntimeException
* @return bool|\MvcCore\Ext\Tools\Image
*/
public abstract function Load ($imgFullPath);
/**
* Save image in desired full path by format and optional quality settings.
* @abstract
* @param string $fullPath
* @param string|\MvcCore\Ext\Tools\Images\IFormat $format `png` by default.
* @param int $quality `NULL` by default - no quality settings will be used.
* @return \MvcCore\Ext\Tools\Image
*/
public abstract function Save ($fullPath, $format = \MvcCore\Ext\Tools\Images\IFormat::PNG, $quality = NULL);
/**
* Resize image to desired with and height without maintaining the aspect ratio.
* @abstract
* @param int $width Pixel width.
* @param int $height Pixel height.
* @return \MvcCore\Ext\Tools\Image
*/
public abstract function Resize ($width, $height);
/**
* Crop image from left, top right or bottom side.
* @abstract
* @param int $x Pixel size to crop from left.
* @param int $y Pixel size to crop from top.
* @param int $width Pixel size to crop from right.
* @param int $height Pixel size to crop from bottom.
* @return \MvcCore\Ext\Tools\Image
*/
public abstract function Crop ($x, $y, $width, $height);
/**
* Image will be resized into sizes not larger than `$width`
* or `$height` params with maintaining the aspect ratio and
* places without image content will be filled with transparent
* background color.
* @abstract
* @param int $width Pixel width.
* @param int $height Pixel height.
* @return \MvcCore\Ext\Tools\Image
*/
public abstract function Frame ($width, $height);
/**
* Set background color for prepared image.
* @abstract
* @param string $hexColor Color in hexadecimal format with or without leading hash.
* @return \MvcCore\Ext\Tools\Image
*/
public abstract function SetBackgroundColor ($hexColor);
/**
* Apply to whole image Photoshop like Unsharp Mask filter to sharp image.
* This method is very time consuming for `GD` image implementation!
* @abstract
* @param int $amount Typically: 50 - 200, min. 0, max. 500.
* @param float $radius Typically: 0.5 - 1, min. 0, max. 50.
* @param int $threshold Typically: 0 - 5, min. 0, max. 255.
* @return \MvcCore\Ext\Tools\Image
*/
public abstract function UnsharpMask ($amount, $radius, $threshold);
/**
* Apply to whole image Photoshop like Channel Mask.
* Image given as first argument will be used as grayscale
* channel mask applied to this image instance.
* This method is very time consuming for `GD` image implementation!
* @abstract
* @param string $maskImgFullPath
* @throws \InvalidArgumentException
* @return \MvcCore\Ext\Tools\Image
*/
public abstract function ApplyMask ($maskImgFullPath);
/**
* Convert whole image to grayscale.
* @abstract
* @return \MvcCore\Ext\Tools\Image
*/
public abstract function Grayscale ();
/**
* Applies a special effect to the image, similar to the effect achieved
* in a photo darkroom by sepia toning. Threshold ranges from 0 to QuantumRange
* and is a measure of the extent of the sepia toning. A threshold of 80 is
* a good starting point for a reasonable tone.
* @abstract
* @param float $threshold
* @return \MvcCore\Ext\Tools\Image
*/
public abstract function Sepia ($threshold = 80);
/**
* Round image corners with the same x-round and y-round sizes.
* This method is very time consuming for `GD` image implementation!
* @abstract
* @param float $x X-rounding.
* @param float $y Y-rounding.
* @return \MvcCore\Ext\Tools\Image
*/
public abstract function RoundCorners ($x, $y);
/**
* Rotate image with optional background color, transparent by default.
* @abstract
* @param float $angle
* @param string $hexBgColor Color in hexadecimal format with or without leading hash. Transparent by default.
* @return \MvcCore\Ext\Tools\Image
*/
public abstract function Rotate ($angle, $hexBgColor = 'transparent');
/**
* Set background image. If background image has different sizes,
* it's resized without maintaining the aspect ratio to the same
* sizes as current image instance.
* @abstract
* @param string $bgImgFullPath
* @throws \InvalidArgumentException
* @return \MvcCore\Ext\Tools\Image
*/
public abstract function SetBackgroundImage ($image);
/**
* Return `TRUE` if image is vector graphic. `FALSE` otherwise.
* Return always `FALSE` for `GD` images, `GD` library cannot work with vector graphics.
* @abstract
* @return bool
*/
public abstract function IsVectorGraphic ();
/**
* Composite one image onto another at the specified offset.
* @see http://php.net/manual/en/imagick.compositeimage.php
* @see http://php.net/manual/en/imagick.constants.php#imagick.constants.composite-default
* @abstract
* @param string $overlayImgFullPath
* @param int $x
* @param int $y
* @param int $alpha
* @param int|\MvcCore\Ext\Tools\Images\IComposite $composite
* @throws \InvalidArgumentException
* @return \MvcCore\Ext\Tools\Image
*/
public abstract function AddOverlay (
$overlayImgFullPath, $x = 0, $y = 0, $alpha = NULL,
$composite = \MvcCore\Ext\Tools\Images\IComposite::NORMAL
);
/**
* Create new empty image instance.
* @param int $width Pixel width.
* @param int $height Pixel height.
* @param string $hexBgColor Color in hexadecimal format with or without leading hash.
* @return resource
*/
public abstract function CreateEmptyImageResource ($width, $height, $hexBgColor = 'transparent');
/**
* Destroy current image instance resource in RAM.
* @abstract
* @return \MvcCore\Ext\Tools\Image
*/
protected abstract function destroy ();
/**
* Set current pixel width value.
* @param int $width Pixel width.
* @return \MvcCore\Ext\Tools\Image
*/
protected function setWidth ($width) {
$this->width = $width;
return $this;
}
/**
* Set current pixel height value.
* @param int $height Pixel height.
* @return \MvcCore\Ext\Tools\Image
*/
protected function setHeight ($height) {
$this->height = $height;
return $this;
}
/**
* Remove all temporary images from `$this->tmpFiles`.
* @return \MvcCore\Ext\Tools\Image
*/
protected function removeTmpFiles () {
if (!empty($this->tmpFiles)) {
foreach ($this->tmpFiles as $tmpFile) {
if (file_exists($tmpFile)) @unlink($tmpFile);
}
}
return $this;
}
/**
* Reload image data from temporary image on HDD.
* @return \MvcCore\Ext\Tools\Image
*/
protected function reinitializeImage() {
$tmpFile = static::GetTmpDirPath() . '/' . static::TMP_IMAGE_BASE_NAME . '_' . uniqid();
$this->tmpFiles[] = $tmpFile;
$this->Save($tmpFile);
$this->destroy();
return $this->Load($tmpFile);
}
}