@@ -22,9 +22,9 @@ |
||
| 22 | 22 | { |
| 23 | 23 | use Traits_Optionable; |
| 24 | 24 | |
| 25 | - /** |
|
| 26 | - * @var Request_Param |
|
| 27 | - */ |
|
| 25 | + /** |
|
| 26 | + * @var Request_Param |
|
| 27 | + */ |
|
| 28 | 28 | protected $param; |
| 29 | 29 | |
| 30 | 30 | protected $value; |
@@ -6,9 +6,9 @@ |
||
| 6 | 6 | |
| 7 | 7 | abstract class VariableInfo_Renderer_String extends VariableInfo_Renderer |
| 8 | 8 | { |
| 9 | - /** |
|
| 10 | - * @var mixed |
|
| 11 | - */ |
|
| 9 | + /** |
|
| 10 | + * @var mixed |
|
| 11 | + */ |
|
| 12 | 12 | protected $value; |
| 13 | 13 | |
| 14 | 14 | protected function init() |
@@ -6,19 +6,19 @@ discard block |
||
| 6 | 6 | |
| 7 | 7 | abstract class VariableInfo_Renderer |
| 8 | 8 | { |
| 9 | - /** |
|
| 10 | - * @var mixed |
|
| 11 | - */ |
|
| 9 | + /** |
|
| 10 | + * @var mixed |
|
| 11 | + */ |
|
| 12 | 12 | protected $value; |
| 13 | 13 | |
| 14 | - /** |
|
| 15 | - * @var VariableInfo |
|
| 16 | - */ |
|
| 14 | + /** |
|
| 15 | + * @var VariableInfo |
|
| 16 | + */ |
|
| 17 | 17 | protected $info; |
| 18 | 18 | |
| 19 | - /** |
|
| 20 | - * @var string |
|
| 21 | - */ |
|
| 19 | + /** |
|
| 20 | + * @var string |
|
| 21 | + */ |
|
| 22 | 22 | protected $type; |
| 23 | 23 | |
| 24 | 24 | public function __construct(VariableInfo $info) |
@@ -31,11 +31,11 @@ discard block |
||
| 31 | 31 | |
| 32 | 32 | abstract protected function init(); |
| 33 | 33 | |
| 34 | - /** |
|
| 35 | - * Renders the value to the target format. |
|
| 36 | - * |
|
| 37 | - * @return mixed |
|
| 38 | - */ |
|
| 34 | + /** |
|
| 35 | + * Renders the value to the target format. |
|
| 36 | + * |
|
| 37 | + * @return mixed |
|
| 38 | + */ |
|
| 39 | 39 | public function render() |
| 40 | 40 | { |
| 41 | 41 | return $this->_render(); |
@@ -21,25 +21,25 @@ discard block |
||
| 21 | 21 | */ |
| 22 | 22 | class XMLHelper_Converter_Decorator implements \JsonSerializable |
| 23 | 23 | { |
| 24 | - /** |
|
| 25 | - * @var \SimpleXMLElement |
|
| 26 | - */ |
|
| 24 | + /** |
|
| 25 | + * @var \SimpleXMLElement |
|
| 26 | + */ |
|
| 27 | 27 | private $subject; |
| 28 | 28 | |
| 29 | 29 | const DEF_DEPTH = 512; |
| 30 | 30 | |
| 31 | - /** |
|
| 32 | - * @var array |
|
| 33 | - */ |
|
| 31 | + /** |
|
| 32 | + * @var array |
|
| 33 | + */ |
|
| 34 | 34 | private $options = array( |
| 35 | 35 | '@attributes' => true, |
| 36 | 36 | '@text' => true, |
| 37 | 37 | 'depth' => self::DEF_DEPTH |
| 38 | 38 | ); |
| 39 | 39 | |
| 40 | - /** |
|
| 41 | - * @var array|string|null |
|
| 42 | - */ |
|
| 40 | + /** |
|
| 41 | + * @var array|string|null |
|
| 42 | + */ |
|
| 43 | 43 | protected $result = array(); |
| 44 | 44 | |
| 45 | 45 | public function __construct(\SimpleXMLElement $element) |
@@ -47,36 +47,36 @@ discard block |
||
| 47 | 47 | $this->subject = $element; |
| 48 | 48 | } |
| 49 | 49 | |
| 50 | - /** |
|
| 51 | - * Whether to use the `@attributes` key to store element attributes. |
|
| 52 | - * |
|
| 53 | - * @param bool $bool |
|
| 54 | - * @return XMLHelper_Converter_Decorator |
|
| 55 | - */ |
|
| 50 | + /** |
|
| 51 | + * Whether to use the `@attributes` key to store element attributes. |
|
| 52 | + * |
|
| 53 | + * @param bool $bool |
|
| 54 | + * @return XMLHelper_Converter_Decorator |
|
| 55 | + */ |
|
| 56 | 56 | public function useAttributes(bool $bool) : XMLHelper_Converter_Decorator |
| 57 | 57 | { |
| 58 | 58 | $this->options['@attributes'] = (bool)$bool; |
| 59 | 59 | return $this; |
| 60 | 60 | } |
| 61 | 61 | |
| 62 | - /** |
|
| 63 | - * Whether to use the `@text` key to store the node text. |
|
| 64 | - * |
|
| 65 | - * @param bool $bool |
|
| 66 | - * @return XMLHelper_Converter_Decorator |
|
| 67 | - */ |
|
| 62 | + /** |
|
| 63 | + * Whether to use the `@text` key to store the node text. |
|
| 64 | + * |
|
| 65 | + * @param bool $bool |
|
| 66 | + * @return XMLHelper_Converter_Decorator |
|
| 67 | + */ |
|
| 68 | 68 | public function useText(bool $bool) : XMLHelper_Converter_Decorator |
| 69 | 69 | { |
| 70 | 70 | $this->options['@text'] = (bool)$bool; |
| 71 | 71 | return $this; |
| 72 | 72 | } |
| 73 | 73 | |
| 74 | - /** |
|
| 75 | - * Set the maximum depth to parse in the document. |
|
| 76 | - * |
|
| 77 | - * @param int $depth |
|
| 78 | - * @return XMLHelper_Converter_Decorator |
|
| 79 | - */ |
|
| 74 | + /** |
|
| 75 | + * Set the maximum depth to parse in the document. |
|
| 76 | + * |
|
| 77 | + * @param int $depth |
|
| 78 | + * @return XMLHelper_Converter_Decorator |
|
| 79 | + */ |
|
| 80 | 80 | public function setDepth(int $depth) : XMLHelper_Converter_Decorator |
| 81 | 81 | { |
| 82 | 82 | $this->options['depth'] = (int)max(0, $depth); |
@@ -23,44 +23,44 @@ |
||
| 23 | 23 | */ |
| 24 | 24 | class Request_URLComparer |
| 25 | 25 | { |
| 26 | - /** |
|
| 27 | - * @var Request |
|
| 28 | - */ |
|
| 26 | + /** |
|
| 27 | + * @var Request |
|
| 28 | + */ |
|
| 29 | 29 | protected $request; |
| 30 | 30 | |
| 31 | - /** |
|
| 32 | - * @var string |
|
| 33 | - */ |
|
| 31 | + /** |
|
| 32 | + * @var string |
|
| 33 | + */ |
|
| 34 | 34 | protected $sourceURL; |
| 35 | 35 | |
| 36 | - /** |
|
| 37 | - * @var string |
|
| 38 | - */ |
|
| 36 | + /** |
|
| 37 | + * @var string |
|
| 38 | + */ |
|
| 39 | 39 | protected $targetURL; |
| 40 | 40 | |
| 41 | - /** |
|
| 42 | - * @var array |
|
| 43 | - */ |
|
| 41 | + /** |
|
| 42 | + * @var array |
|
| 43 | + */ |
|
| 44 | 44 | protected $limitParams = array(); |
| 45 | 45 | |
| 46 | - /** |
|
| 47 | - * @var bool |
|
| 48 | - */ |
|
| 46 | + /** |
|
| 47 | + * @var bool |
|
| 48 | + */ |
|
| 49 | 49 | protected $isMatch = false; |
| 50 | 50 | |
| 51 | - /** |
|
| 52 | - * @var bool |
|
| 53 | - */ |
|
| 51 | + /** |
|
| 52 | + * @var bool |
|
| 53 | + */ |
|
| 54 | 54 | protected $ignoreFragment = true; |
| 55 | 55 | |
| 56 | - /** |
|
| 57 | - * @var URLInfo |
|
| 58 | - */ |
|
| 56 | + /** |
|
| 57 | + * @var URLInfo |
|
| 58 | + */ |
|
| 59 | 59 | protected $sourceInfo; |
| 60 | 60 | |
| 61 | - /** |
|
| 62 | - * @var URLInfo |
|
| 63 | - */ |
|
| 61 | + /** |
|
| 62 | + * @var URLInfo |
|
| 63 | + */ |
|
| 64 | 64 | protected $targetInfo; |
| 65 | 65 | |
| 66 | 66 | public function __construct(Request $request, string $sourceURL, string $targetURL) |
@@ -68,54 +68,54 @@ discard block |
||
| 68 | 68 | |
| 69 | 69 | const ERROR_UNEXPECTED_COLOR_VALUE = 513025; |
| 70 | 70 | |
| 71 | - /** |
|
| 72 | - * @var string |
|
| 73 | - */ |
|
| 71 | + /** |
|
| 72 | + * @var string |
|
| 73 | + */ |
|
| 74 | 74 | protected $file; |
| 75 | 75 | |
| 76 | - /** |
|
| 77 | - * @var ImageHelper_Size |
|
| 78 | - */ |
|
| 76 | + /** |
|
| 77 | + * @var ImageHelper_Size |
|
| 78 | + */ |
|
| 79 | 79 | protected $info; |
| 80 | 80 | |
| 81 | - /** |
|
| 82 | - * @var string |
|
| 83 | - */ |
|
| 81 | + /** |
|
| 82 | + * @var string |
|
| 83 | + */ |
|
| 84 | 84 | protected $type; |
| 85 | 85 | |
| 86 | - /** |
|
| 87 | - * @var resource|NULL |
|
| 88 | - */ |
|
| 86 | + /** |
|
| 87 | + * @var resource|NULL |
|
| 88 | + */ |
|
| 89 | 89 | protected $newImage; |
| 90 | 90 | |
| 91 | - /** |
|
| 92 | - * @var resource |
|
| 93 | - */ |
|
| 91 | + /** |
|
| 92 | + * @var resource |
|
| 93 | + */ |
|
| 94 | 94 | protected $sourceImage; |
| 95 | 95 | |
| 96 | - /** |
|
| 97 | - * @var int |
|
| 98 | - */ |
|
| 96 | + /** |
|
| 97 | + * @var int |
|
| 98 | + */ |
|
| 99 | 99 | protected $width; |
| 100 | 100 | |
| 101 | - /** |
|
| 102 | - * @var int |
|
| 103 | - */ |
|
| 101 | + /** |
|
| 102 | + * @var int |
|
| 103 | + */ |
|
| 104 | 104 | protected $height; |
| 105 | 105 | |
| 106 | - /** |
|
| 107 | - * @var int |
|
| 108 | - */ |
|
| 106 | + /** |
|
| 107 | + * @var int |
|
| 108 | + */ |
|
| 109 | 109 | protected $newWidth = 0; |
| 110 | 110 | |
| 111 | - /** |
|
| 112 | - * @var int |
|
| 113 | - */ |
|
| 111 | + /** |
|
| 112 | + * @var int |
|
| 113 | + */ |
|
| 114 | 114 | protected $newHeight = 0; |
| 115 | 115 | |
| 116 | - /** |
|
| 117 | - * @var int |
|
| 118 | - */ |
|
| 116 | + /** |
|
| 117 | + * @var int |
|
| 118 | + */ |
|
| 119 | 119 | protected $quality = 85; |
| 120 | 120 | |
| 121 | 121 | protected static $imageTypes = array( |
@@ -203,17 +203,17 @@ discard block |
||
| 203 | 203 | } |
| 204 | 204 | } |
| 205 | 205 | |
| 206 | - /** |
|
| 207 | - * Factory method: creates a new helper with a blank image. |
|
| 208 | - * |
|
| 209 | - * @param integer $width |
|
| 210 | - * @param integer $height |
|
| 211 | - * @param string $type The target file type when saving |
|
| 212 | - * @return ImageHelper |
|
| 213 | - * @throws ImageHelper_Exception |
|
| 214 | - * |
|
| 215 | - * @see ImageHelper::ERROR_CANNOT_CREATE_IMAGE_OBJECT |
|
| 216 | - */ |
|
| 206 | + /** |
|
| 207 | + * Factory method: creates a new helper with a blank image. |
|
| 208 | + * |
|
| 209 | + * @param integer $width |
|
| 210 | + * @param integer $height |
|
| 211 | + * @param string $type The target file type when saving |
|
| 212 | + * @return ImageHelper |
|
| 213 | + * @throws ImageHelper_Exception |
|
| 214 | + * |
|
| 215 | + * @see ImageHelper::ERROR_CANNOT_CREATE_IMAGE_OBJECT |
|
| 216 | + */ |
|
| 217 | 217 | public static function createNew($width, $height, $type='png') |
| 218 | 218 | { |
| 219 | 219 | $img = imagecreatetruecolor($width, $height); |
@@ -228,18 +228,18 @@ discard block |
||
| 228 | 228 | ); |
| 229 | 229 | } |
| 230 | 230 | |
| 231 | - /** |
|
| 232 | - * Factory method: creates an image helper from an |
|
| 233 | - * existing image resource. |
|
| 234 | - * |
|
| 235 | - * Note: while the resource is type independent, the |
|
| 236 | - * type parameter is required for some methods, as well |
|
| 237 | - * as to be able to save the image. |
|
| 238 | - * |
|
| 239 | - * @param resource $resource |
|
| 240 | - * @param string $type The target image type, e.g. "jpeg", "png", etc. |
|
| 241 | - * @return ImageHelper |
|
| 242 | - */ |
|
| 231 | + /** |
|
| 232 | + * Factory method: creates an image helper from an |
|
| 233 | + * existing image resource. |
|
| 234 | + * |
|
| 235 | + * Note: while the resource is type independent, the |
|
| 236 | + * type parameter is required for some methods, as well |
|
| 237 | + * as to be able to save the image. |
|
| 238 | + * |
|
| 239 | + * @param resource $resource |
|
| 240 | + * @param string $type The target image type, e.g. "jpeg", "png", etc. |
|
| 241 | + * @return ImageHelper |
|
| 242 | + */ |
|
| 243 | 243 | public static function createFromResource($resource, ?string $type=null) |
| 244 | 244 | { |
| 245 | 245 | self::requireResource($resource); |
@@ -247,29 +247,29 @@ discard block |
||
| 247 | 247 | return new ImageHelper(null, $resource, $type); |
| 248 | 248 | } |
| 249 | 249 | |
| 250 | - /** |
|
| 251 | - * Factory method: creates an image helper from an |
|
| 252 | - * image file on disk. |
|
| 253 | - * |
|
| 254 | - * @param string $file |
|
| 255 | - * @return ImageHelper |
|
| 256 | - */ |
|
| 250 | + /** |
|
| 251 | + * Factory method: creates an image helper from an |
|
| 252 | + * image file on disk. |
|
| 253 | + * |
|
| 254 | + * @param string $file |
|
| 255 | + * @return ImageHelper |
|
| 256 | + */ |
|
| 257 | 257 | public static function createFromFile(string $file) : ImageHelper |
| 258 | 258 | { |
| 259 | 259 | return new ImageHelper($file); |
| 260 | 260 | } |
| 261 | 261 | |
| 262 | - /** |
|
| 263 | - * Sets a global image helper configuration value. Available |
|
| 264 | - * configuration settings are: |
|
| 265 | - * |
|
| 266 | - * <ul> |
|
| 267 | - * <li><code>auto-memory-adjustment</code> <i>boolean</i> Whether totry and adjust the memory limit automatically so there will be enough to load/process the target image.</li> |
|
| 268 | - * </ul> |
|
| 269 | - * |
|
| 270 | - * @param string $name |
|
| 271 | - * @param mixed $value |
|
| 272 | - */ |
|
| 262 | + /** |
|
| 263 | + * Sets a global image helper configuration value. Available |
|
| 264 | + * configuration settings are: |
|
| 265 | + * |
|
| 266 | + * <ul> |
|
| 267 | + * <li><code>auto-memory-adjustment</code> <i>boolean</i> Whether totry and adjust the memory limit automatically so there will be enough to load/process the target image.</li> |
|
| 268 | + * </ul> |
|
| 269 | + * |
|
| 270 | + * @param string $name |
|
| 271 | + * @param mixed $value |
|
| 272 | + */ |
|
| 273 | 273 | public static function setConfig($name, $value) |
| 274 | 274 | { |
| 275 | 275 | if(isset(self::$config[$name])) { |
@@ -277,22 +277,22 @@ discard block |
||
| 277 | 277 | } |
| 278 | 278 | } |
| 279 | 279 | |
| 280 | - /** |
|
| 281 | - * Shorthand for setting the automatic memory adjustment |
|
| 282 | - * global configuration setting. |
|
| 283 | - * |
|
| 284 | - * @param bool $enabled |
|
| 285 | - */ |
|
| 280 | + /** |
|
| 281 | + * Shorthand for setting the automatic memory adjustment |
|
| 282 | + * global configuration setting. |
|
| 283 | + * |
|
| 284 | + * @param bool $enabled |
|
| 285 | + */ |
|
| 286 | 286 | public static function setAutoMemoryAdjustment($enabled=true) |
| 287 | 287 | { |
| 288 | 288 | self::setConfig('auto-memory-adjustment', $enabled); |
| 289 | 289 | } |
| 290 | 290 | |
| 291 | - /** |
|
| 292 | - * Duplicates an image resource. |
|
| 293 | - * @param resource $img |
|
| 294 | - * @return resource |
|
| 295 | - */ |
|
| 291 | + /** |
|
| 292 | + * Duplicates an image resource. |
|
| 293 | + * @param resource $img |
|
| 294 | + * @return resource |
|
| 295 | + */ |
|
| 296 | 296 | protected function duplicateImage($img) |
| 297 | 297 | { |
| 298 | 298 | self::requireResource($img); |
@@ -304,12 +304,12 @@ discard block |
||
| 304 | 304 | return $duplicate; |
| 305 | 305 | } |
| 306 | 306 | |
| 307 | - /** |
|
| 308 | - * Duplicates the current state of the image into a new |
|
| 309 | - * image helper instance. |
|
| 310 | - * |
|
| 311 | - * @return ImageHelper |
|
| 312 | - */ |
|
| 307 | + /** |
|
| 308 | + * Duplicates the current state of the image into a new |
|
| 309 | + * image helper instance. |
|
| 310 | + * |
|
| 311 | + * @return ImageHelper |
|
| 312 | + */ |
|
| 313 | 313 | public function duplicate() |
| 314 | 314 | { |
| 315 | 315 | return ImageHelper::createFromResource($this->duplicateImage($this->newImage)); |
@@ -497,13 +497,13 @@ discard block |
||
| 497 | 497 | )); |
| 498 | 498 | } |
| 499 | 499 | |
| 500 | - /** |
|
| 501 | - * Resamples the image to a new width, maintaining |
|
| 502 | - * aspect ratio. |
|
| 503 | - * |
|
| 504 | - * @param int $width |
|
| 505 | - * @return ImageHelper |
|
| 506 | - */ |
|
| 500 | + /** |
|
| 501 | + * Resamples the image to a new width, maintaining |
|
| 502 | + * aspect ratio. |
|
| 503 | + * |
|
| 504 | + * @param int $width |
|
| 505 | + * @return ImageHelper |
|
| 506 | + */ |
|
| 507 | 507 | public function resampleByWidth(int $width) : ImageHelper |
| 508 | 508 | { |
| 509 | 509 | $size = $this->getSizeByWidth($width); |
@@ -513,12 +513,12 @@ discard block |
||
| 513 | 513 | return $this; |
| 514 | 514 | } |
| 515 | 515 | |
| 516 | - /** |
|
| 517 | - * Resamples the image by height, and creates a new image file on disk. |
|
| 518 | - * |
|
| 519 | - * @param int $height |
|
| 520 | - * @return ImageHelper |
|
| 521 | - */ |
|
| 516 | + /** |
|
| 517 | + * Resamples the image by height, and creates a new image file on disk. |
|
| 518 | + * |
|
| 519 | + * @param int $height |
|
| 520 | + * @return ImageHelper |
|
| 521 | + */ |
|
| 522 | 522 | public function resampleByHeight($height) : ImageHelper |
| 523 | 523 | { |
| 524 | 524 | $size = $this->getSizeByHeight($height); |
@@ -526,13 +526,13 @@ discard block |
||
| 526 | 526 | return $this->resampleImage($size->getWidth(), $size->getHeight()); |
| 527 | 527 | } |
| 528 | 528 | |
| 529 | - /** |
|
| 530 | - * Resamples the image without keeping the aspect ratio. |
|
| 531 | - * |
|
| 532 | - * @param int $width |
|
| 533 | - * @param int $height |
|
| 534 | - * @return ImageHelper |
|
| 535 | - */ |
|
| 529 | + /** |
|
| 530 | + * Resamples the image without keeping the aspect ratio. |
|
| 531 | + * |
|
| 532 | + * @param int $width |
|
| 533 | + * @param int $height |
|
| 534 | + * @return ImageHelper |
|
| 535 | + */ |
|
| 536 | 536 | public function resample(?int $width = null, ?int $height = null) : ImageHelper |
| 537 | 537 | { |
| 538 | 538 | if($this->isVector()) { |
@@ -597,12 +597,12 @@ discard block |
||
| 597 | 597 | |
| 598 | 598 | protected $alpha = false; |
| 599 | 599 | |
| 600 | - /** |
|
| 601 | - * Configures the specified image resource to make it alpha compatible. |
|
| 602 | - * |
|
| 603 | - * @param resource $canvas |
|
| 604 | - * @param bool $fill Whether to fill the whole canvas with the transparency |
|
| 605 | - */ |
|
| 600 | + /** |
|
| 601 | + * Configures the specified image resource to make it alpha compatible. |
|
| 602 | + * |
|
| 603 | + * @param resource $canvas |
|
| 604 | + * @param bool $fill Whether to fill the whole canvas with the transparency |
|
| 605 | + */ |
|
| 606 | 606 | public static function addAlphaSupport($canvas, $fill=true) |
| 607 | 607 | { |
| 608 | 608 | self::requireResource($canvas); |
@@ -717,12 +717,12 @@ discard block |
||
| 717 | 717 | $this->quality = $quality * 1; |
| 718 | 718 | } |
| 719 | 719 | |
| 720 | - /** |
|
| 721 | - * Attempts to adjust the memory to the required size |
|
| 722 | - * to work with the current image. |
|
| 723 | - * |
|
| 724 | - * @return boolean |
|
| 725 | - */ |
|
| 720 | + /** |
|
| 721 | + * Attempts to adjust the memory to the required size |
|
| 722 | + * to work with the current image. |
|
| 723 | + * |
|
| 724 | + * @return boolean |
|
| 725 | + */ |
|
| 726 | 726 | protected function adjustMemory() : bool |
| 727 | 727 | { |
| 728 | 728 | if(!self::$config['auto-memory-adjustment']) { |
@@ -762,27 +762,27 @@ discard block |
||
| 762 | 762 | return false; |
| 763 | 763 | } |
| 764 | 764 | |
| 765 | - /** |
|
| 766 | - * Stretches the image to the specified dimensions. |
|
| 767 | - * |
|
| 768 | - * @param int $width |
|
| 769 | - * @param int $height |
|
| 770 | - * @return ImageHelper |
|
| 771 | - */ |
|
| 765 | + /** |
|
| 766 | + * Stretches the image to the specified dimensions. |
|
| 767 | + * |
|
| 768 | + * @param int $width |
|
| 769 | + * @param int $height |
|
| 770 | + * @return ImageHelper |
|
| 771 | + */ |
|
| 772 | 772 | public function stretch(int $width, int $height) : ImageHelper |
| 773 | 773 | { |
| 774 | 774 | return $this->resampleImage($width, $height); |
| 775 | 775 | } |
| 776 | 776 | |
| 777 | - /** |
|
| 778 | - * Creates a new image from the current image, |
|
| 779 | - * resampling it to the new size. |
|
| 780 | - * |
|
| 781 | - * @param int $newWidth |
|
| 782 | - * @param int $newHeight |
|
| 783 | - * @throws ImageHelper_Exception |
|
| 784 | - * @return ImageHelper |
|
| 785 | - */ |
|
| 777 | + /** |
|
| 778 | + * Creates a new image from the current image, |
|
| 779 | + * resampling it to the new size. |
|
| 780 | + * |
|
| 781 | + * @param int $newWidth |
|
| 782 | + * @param int $newHeight |
|
| 783 | + * @throws ImageHelper_Exception |
|
| 784 | + * @return ImageHelper |
|
| 785 | + */ |
|
| 786 | 786 | protected function resampleImage(int $newWidth, int $newHeight) : ImageHelper |
| 787 | 787 | { |
| 788 | 788 | if($this->isVector()) { |
@@ -851,13 +851,13 @@ discard block |
||
| 851 | 851 | return array_unique($types); |
| 852 | 852 | } |
| 853 | 853 | |
| 854 | - /** |
|
| 855 | - * Displays an existing image resource. |
|
| 856 | - * |
|
| 857 | - * @param resource $resource |
|
| 858 | - * @param string $imageType The image format to send, i.e. "jpeg", "png" |
|
| 859 | - * @param int $quality The quality to use for the image. This is 0-9 (0=no compression, 9=max) for PNG, and 0-100 (0=lowest, 100=highest quality) for JPG |
|
| 860 | - */ |
|
| 854 | + /** |
|
| 855 | + * Displays an existing image resource. |
|
| 856 | + * |
|
| 857 | + * @param resource $resource |
|
| 858 | + * @param string $imageType The image format to send, i.e. "jpeg", "png" |
|
| 859 | + * @param int $quality The quality to use for the image. This is 0-9 (0=no compression, 9=max) for PNG, and 0-100 (0=lowest, 100=highest quality) for JPG |
|
| 860 | + */ |
|
| 861 | 861 | public static function displayImageStream($resource, $imageType, $quality=-1) |
| 862 | 862 | { |
| 863 | 863 | $imageType = strtolower($imageType); |
@@ -923,31 +923,31 @@ discard block |
||
| 923 | 923 | readfile($imageFile); |
| 924 | 924 | } |
| 925 | 925 | |
| 926 | - /** |
|
| 927 | - * Displays the current image. |
|
| 928 | - */ |
|
| 926 | + /** |
|
| 927 | + * Displays the current image. |
|
| 928 | + */ |
|
| 929 | 929 | public function display() |
| 930 | 930 | { |
| 931 | 931 | $this->displayImageStream($this->newImage, $this->getType(), $this->resolveQuality()); |
| 932 | 932 | } |
| 933 | 933 | |
| 934 | - /** |
|
| 935 | - * Trims the current loaded image. |
|
| 936 | - * |
|
| 937 | - * @param array $color A color definition, as an associative array with red, green, and blue keys. If not specified, the color at pixel position 0,0 will be used. |
|
| 938 | - */ |
|
| 934 | + /** |
|
| 935 | + * Trims the current loaded image. |
|
| 936 | + * |
|
| 937 | + * @param array $color A color definition, as an associative array with red, green, and blue keys. If not specified, the color at pixel position 0,0 will be used. |
|
| 938 | + */ |
|
| 939 | 939 | public function trim($color=null) |
| 940 | 940 | { |
| 941 | 941 | return $this->trimImage($this->newImage, $color); |
| 942 | 942 | } |
| 943 | 943 | |
| 944 | - /** |
|
| 945 | - * Retrieves a color definition by its index. |
|
| 946 | - * |
|
| 947 | - * @param resource $img A valid image resource. |
|
| 948 | - * @param int $colorIndex The color index, as returned by imagecolorat for example. |
|
| 949 | - * @return array An array with red, green, blue and alpha keys. |
|
| 950 | - */ |
|
| 944 | + /** |
|
| 945 | + * Retrieves a color definition by its index. |
|
| 946 | + * |
|
| 947 | + * @param resource $img A valid image resource. |
|
| 948 | + * @param int $colorIndex The color index, as returned by imagecolorat for example. |
|
| 949 | + * @return array An array with red, green, blue and alpha keys. |
|
| 950 | + */ |
|
| 951 | 951 | public function getIndexedColors($img, int $colorIndex) : array |
| 952 | 952 | { |
| 953 | 953 | $color = imagecolorsforindex($img, $colorIndex); |
@@ -965,14 +965,14 @@ discard block |
||
| 965 | 965 | ); |
| 966 | 966 | } |
| 967 | 967 | |
| 968 | - /** |
|
| 969 | - * Trims the specified image resource by removing the specified color. |
|
| 970 | - * Also works with transparency. |
|
| 971 | - * |
|
| 972 | - * @param resource $img |
|
| 973 | - * @param array $color A color definition, as an associative array with red, green, blue and alpha keys. If not specified, the color at pixel position 0,0 will be used. |
|
| 974 | - * @return ImageHelper |
|
| 975 | - */ |
|
| 968 | + /** |
|
| 969 | + * Trims the specified image resource by removing the specified color. |
|
| 970 | + * Also works with transparency. |
|
| 971 | + * |
|
| 972 | + * @param resource $img |
|
| 973 | + * @param array $color A color definition, as an associative array with red, green, blue and alpha keys. If not specified, the color at pixel position 0,0 will be used. |
|
| 974 | + * @return ImageHelper |
|
| 975 | + */ |
|
| 976 | 976 | protected function trimImage($img, ?array $color=null) : ImageHelper |
| 977 | 977 | { |
| 978 | 978 | if($this->isVector()) { |
@@ -1060,12 +1060,12 @@ discard block |
||
| 1060 | 1060 | return $this; |
| 1061 | 1061 | } |
| 1062 | 1062 | |
| 1063 | - /** |
|
| 1064 | - * Sets the new image after a transformation operation: |
|
| 1065 | - * automatically adjusts the new size information. |
|
| 1066 | - * |
|
| 1067 | - * @param resource $image |
|
| 1068 | - */ |
|
| 1063 | + /** |
|
| 1064 | + * Sets the new image after a transformation operation: |
|
| 1065 | + * automatically adjusts the new size information. |
|
| 1066 | + * |
|
| 1067 | + * @param resource $image |
|
| 1068 | + */ |
|
| 1069 | 1069 | protected function setNewImage($image) |
| 1070 | 1070 | { |
| 1071 | 1071 | self::requireResource($image); |
@@ -1075,12 +1075,12 @@ discard block |
||
| 1075 | 1075 | $this->newHeight= imagesy($image); |
| 1076 | 1076 | } |
| 1077 | 1077 | |
| 1078 | - /** |
|
| 1079 | - * Requires the subject to be a resource. |
|
| 1080 | - * |
|
| 1081 | - * @param resource $subject |
|
| 1082 | - * @throws ImageHelper_Exception |
|
| 1083 | - */ |
|
| 1078 | + /** |
|
| 1079 | + * Requires the subject to be a resource. |
|
| 1080 | + * |
|
| 1081 | + * @param resource $subject |
|
| 1082 | + * @throws ImageHelper_Exception |
|
| 1083 | + */ |
|
| 1084 | 1084 | protected static function requireResource($subject) |
| 1085 | 1085 | { |
| 1086 | 1086 | if(is_resource($subject)) { |
@@ -1097,14 +1097,14 @@ discard block |
||
| 1097 | 1097 | ); |
| 1098 | 1098 | } |
| 1099 | 1099 | |
| 1100 | - /** |
|
| 1101 | - * Creates a new image resource, with transparent background. |
|
| 1102 | - * |
|
| 1103 | - * @param int $width |
|
| 1104 | - * @param int $height |
|
| 1105 | - * @throws ImageHelper_Exception |
|
| 1106 | - * @return resource |
|
| 1107 | - */ |
|
| 1100 | + /** |
|
| 1101 | + * Creates a new image resource, with transparent background. |
|
| 1102 | + * |
|
| 1103 | + * @param int $width |
|
| 1104 | + * @param int $height |
|
| 1105 | + * @throws ImageHelper_Exception |
|
| 1106 | + * @return resource |
|
| 1107 | + */ |
|
| 1108 | 1108 | protected function createNewImage(int $width, int $height) |
| 1109 | 1109 | { |
| 1110 | 1110 | $img = imagecreatetruecolor($width, $height); |
@@ -1123,54 +1123,54 @@ discard block |
||
| 1123 | 1123 | return $img; |
| 1124 | 1124 | } |
| 1125 | 1125 | |
| 1126 | - /** |
|
| 1127 | - * Whether the two specified colors are the same. |
|
| 1128 | - * |
|
| 1129 | - * @param array $a |
|
| 1130 | - * @param array $b |
|
| 1131 | - * @return boolean |
|
| 1132 | - */ |
|
| 1133 | - protected function colorsMatch($a, $b) : bool |
|
| 1134 | - { |
|
| 1135 | - $parts = array('red', 'green', 'blue'); |
|
| 1136 | - foreach($parts as $part) { |
|
| 1137 | - if($a[$part] != $b[$part]) { |
|
| 1138 | - return false; |
|
| 1139 | - } |
|
| 1140 | - } |
|
| 1126 | + /** |
|
| 1127 | + * Whether the two specified colors are the same. |
|
| 1128 | + * |
|
| 1129 | + * @param array $a |
|
| 1130 | + * @param array $b |
|
| 1131 | + * @return boolean |
|
| 1132 | + */ |
|
| 1133 | + protected function colorsMatch($a, $b) : bool |
|
| 1134 | + { |
|
| 1135 | + $parts = array('red', 'green', 'blue'); |
|
| 1136 | + foreach($parts as $part) { |
|
| 1137 | + if($a[$part] != $b[$part]) { |
|
| 1138 | + return false; |
|
| 1139 | + } |
|
| 1140 | + } |
|
| 1141 | 1141 | |
| 1142 | - return true; |
|
| 1143 | - } |
|
| 1142 | + return true; |
|
| 1143 | + } |
|
| 1144 | 1144 | |
| 1145 | - public function fillWhite($x=0, $y=0) |
|
| 1146 | - { |
|
| 1147 | - $this->addRGBColor('white', 255, 255, 255); |
|
| 1145 | + public function fillWhite($x=0, $y=0) |
|
| 1146 | + { |
|
| 1147 | + $this->addRGBColor('white', 255, 255, 255); |
|
| 1148 | 1148 | return $this->fill('white', $x, $y); |
| 1149 | - } |
|
| 1149 | + } |
|
| 1150 | 1150 | |
| 1151 | - public function fillTransparent() : ImageHelper |
|
| 1152 | - { |
|
| 1151 | + public function fillTransparent() : ImageHelper |
|
| 1152 | + { |
|
| 1153 | 1153 | $this->enableAlpha(); |
| 1154 | 1154 | |
| 1155 | - self::fillImageTransparent($this->newImage); |
|
| 1155 | + self::fillImageTransparent($this->newImage); |
|
| 1156 | 1156 | |
| 1157 | - return $this; |
|
| 1158 | - } |
|
| 1157 | + return $this; |
|
| 1158 | + } |
|
| 1159 | 1159 | |
| 1160 | - public static function fillImageTransparent($resource) |
|
| 1161 | - { |
|
| 1162 | - self::requireResource($resource); |
|
| 1160 | + public static function fillImageTransparent($resource) |
|
| 1161 | + { |
|
| 1162 | + self::requireResource($resource); |
|
| 1163 | 1163 | |
| 1164 | - $transparent = imagecolorallocatealpha($resource, 89, 14, 207, 127); |
|
| 1165 | - imagecolortransparent ($resource, $transparent); |
|
| 1166 | - imagefill($resource, 0, 0, $transparent); |
|
| 1167 | - } |
|
| 1164 | + $transparent = imagecolorallocatealpha($resource, 89, 14, 207, 127); |
|
| 1165 | + imagecolortransparent ($resource, $transparent); |
|
| 1166 | + imagefill($resource, 0, 0, $transparent); |
|
| 1167 | + } |
|
| 1168 | 1168 | |
| 1169 | - public function fill($colorName, $x=0, $y=0) |
|
| 1170 | - { |
|
| 1171 | - imagefill($this->newImage, $x, $y, $this->colors[$colorName]); |
|
| 1172 | - return $this; |
|
| 1173 | - } |
|
| 1169 | + public function fill($colorName, $x=0, $y=0) |
|
| 1170 | + { |
|
| 1171 | + imagefill($this->newImage, $x, $y, $this->colors[$colorName]); |
|
| 1172 | + return $this; |
|
| 1173 | + } |
|
| 1174 | 1174 | |
| 1175 | 1175 | protected $colors = array(); |
| 1176 | 1176 | |
@@ -1191,9 +1191,9 @@ discard block |
||
| 1191 | 1191 | return $this; |
| 1192 | 1192 | } |
| 1193 | 1193 | |
| 1194 | - /** |
|
| 1195 | - * @return resource |
|
| 1196 | - */ |
|
| 1194 | + /** |
|
| 1195 | + * @return resource |
|
| 1196 | + */ |
|
| 1197 | 1197 | public function getImage() |
| 1198 | 1198 | { |
| 1199 | 1199 | return $this->newImage; |
@@ -1211,26 +1211,26 @@ discard block |
||
| 1211 | 1211 | return $this; |
| 1212 | 1212 | } |
| 1213 | 1213 | |
| 1214 | - /** |
|
| 1215 | - * Retrieves the size of the image. |
|
| 1216 | - * |
|
| 1217 | - * @return ImageHelper_Size |
|
| 1218 | - * @throws ImageHelper_Exception |
|
| 1219 | - * @see ImageHelper::ERROR_CANNOT_GET_IMAGE_SIZE |
|
| 1220 | - */ |
|
| 1221 | - public function getSize() : ImageHelper_Size |
|
| 1214 | + /** |
|
| 1215 | + * Retrieves the size of the image. |
|
| 1216 | + * |
|
| 1217 | + * @return ImageHelper_Size |
|
| 1218 | + * @throws ImageHelper_Exception |
|
| 1219 | + * @see ImageHelper::ERROR_CANNOT_GET_IMAGE_SIZE |
|
| 1220 | + */ |
|
| 1221 | + public function getSize() : ImageHelper_Size |
|
| 1222 | 1222 | { |
| 1223 | - return self::getImageSize($this->newImage); |
|
| 1223 | + return self::getImageSize($this->newImage); |
|
| 1224 | 1224 | } |
| 1225 | 1225 | |
| 1226 | 1226 | protected $TTFFile; |
| 1227 | 1227 | |
| 1228 | - /** |
|
| 1229 | - * Sets the TTF font file to use for text operations. |
|
| 1230 | - * |
|
| 1231 | - * @param string $filePath |
|
| 1232 | - * @return ImageHelper |
|
| 1233 | - */ |
|
| 1228 | + /** |
|
| 1229 | + * Sets the TTF font file to use for text operations. |
|
| 1230 | + * |
|
| 1231 | + * @param string $filePath |
|
| 1232 | + * @return ImageHelper |
|
| 1233 | + */ |
|
| 1234 | 1234 | public function setFontTTF($filePath) |
| 1235 | 1235 | { |
| 1236 | 1236 | $this->TTFFile = $filePath; |
@@ -1302,63 +1302,63 @@ discard block |
||
| 1302 | 1302 | return; |
| 1303 | 1303 | } |
| 1304 | 1304 | |
| 1305 | - throw new ImageHelper_Exception( |
|
| 1305 | + throw new ImageHelper_Exception( |
|
| 1306 | 1306 | 'No true type font specified', |
| 1307 | 1307 | 'This functionality requires a TTF font file to be specified with the [setFontTTF] method.', |
| 1308 | 1308 | self::ERROR_NO_TRUE_TYPE_FONT_SET |
| 1309 | 1309 | ); |
| 1310 | 1310 | } |
| 1311 | 1311 | |
| 1312 | - /** |
|
| 1313 | - * Retrieves the size of an image file on disk, or |
|
| 1314 | - * an existing image resource. |
|
| 1315 | - * |
|
| 1316 | - * <pre> |
|
| 1317 | - * array( |
|
| 1318 | - * 0: (width), |
|
| 1319 | - * 1: (height), |
|
| 1320 | - * "channels": the amount of channels |
|
| 1321 | - * "bits": bits per channel |
|
| 1312 | + /** |
|
| 1313 | + * Retrieves the size of an image file on disk, or |
|
| 1314 | + * an existing image resource. |
|
| 1315 | + * |
|
| 1316 | + * <pre> |
|
| 1317 | + * array( |
|
| 1318 | + * 0: (width), |
|
| 1319 | + * 1: (height), |
|
| 1320 | + * "channels": the amount of channels |
|
| 1321 | + * "bits": bits per channel |
|
| 1322 | 1322 | * ) |
| 1323 | - * </pre> |
|
| 1324 | - * |
|
| 1325 | - * @param string|resource $pathOrResource |
|
| 1326 | - * @return ImageHelper_Size Size object, can also be accessed like the traditional array from getimagesize |
|
| 1327 | - * @see ImageHelper_Size |
|
| 1328 | - * @throws ImageHelper_Exception |
|
| 1329 | - * @see ImageHelper::ERROR_CANNOT_GET_IMAGE_SIZE |
|
| 1330 | - * @see ImageHelper::ERROR_CANNOT_READ_SVG_IMAGE |
|
| 1331 | - * @see ImageHelper::ERROR_SVG_SOURCE_VIEWBOX_MISSING |
|
| 1332 | - * @see ImageHelper::ERROR_SVG_VIEWBOX_INVALID |
|
| 1333 | - */ |
|
| 1334 | - public static function getImageSize($pathOrResource) : ImageHelper_Size |
|
| 1335 | - { |
|
| 1336 | - if(is_resource($pathOrResource)) |
|
| 1337 | - { |
|
| 1338 | - return new ImageHelper_Size(array( |
|
| 1339 | - 'width' => imagesx($pathOrResource), |
|
| 1340 | - 'height' => imagesy($pathOrResource), |
|
| 1341 | - 'channels' => 1, |
|
| 1342 | - 'bits' => 8 |
|
| 1343 | - )); |
|
| 1344 | - } |
|
| 1323 | + * </pre> |
|
| 1324 | + * |
|
| 1325 | + * @param string|resource $pathOrResource |
|
| 1326 | + * @return ImageHelper_Size Size object, can also be accessed like the traditional array from getimagesize |
|
| 1327 | + * @see ImageHelper_Size |
|
| 1328 | + * @throws ImageHelper_Exception |
|
| 1329 | + * @see ImageHelper::ERROR_CANNOT_GET_IMAGE_SIZE |
|
| 1330 | + * @see ImageHelper::ERROR_CANNOT_READ_SVG_IMAGE |
|
| 1331 | + * @see ImageHelper::ERROR_SVG_SOURCE_VIEWBOX_MISSING |
|
| 1332 | + * @see ImageHelper::ERROR_SVG_VIEWBOX_INVALID |
|
| 1333 | + */ |
|
| 1334 | + public static function getImageSize($pathOrResource) : ImageHelper_Size |
|
| 1335 | + { |
|
| 1336 | + if(is_resource($pathOrResource)) |
|
| 1337 | + { |
|
| 1338 | + return new ImageHelper_Size(array( |
|
| 1339 | + 'width' => imagesx($pathOrResource), |
|
| 1340 | + 'height' => imagesy($pathOrResource), |
|
| 1341 | + 'channels' => 1, |
|
| 1342 | + 'bits' => 8 |
|
| 1343 | + )); |
|
| 1344 | + } |
|
| 1345 | 1345 | |
| 1346 | - $type = self::getFileImageType($pathOrResource); |
|
| 1346 | + $type = self::getFileImageType($pathOrResource); |
|
| 1347 | 1347 | |
| 1348 | - $info = false; |
|
| 1349 | - $method = 'getImageSize_'.$type; |
|
| 1350 | - if(method_exists(__CLASS__, $method)) |
|
| 1351 | - { |
|
| 1352 | - $info = call_user_func(array(__CLASS__, $method), $pathOrResource); |
|
| 1353 | - } |
|
| 1354 | - else |
|
| 1355 | - { |
|
| 1356 | - $info = getimagesize($pathOrResource); |
|
| 1357 | - } |
|
| 1348 | + $info = false; |
|
| 1349 | + $method = 'getImageSize_'.$type; |
|
| 1350 | + if(method_exists(__CLASS__, $method)) |
|
| 1351 | + { |
|
| 1352 | + $info = call_user_func(array(__CLASS__, $method), $pathOrResource); |
|
| 1353 | + } |
|
| 1354 | + else |
|
| 1355 | + { |
|
| 1356 | + $info = getimagesize($pathOrResource); |
|
| 1357 | + } |
|
| 1358 | 1358 | |
| 1359 | - if($info !== false) { |
|
| 1360 | - return new ImageHelper_Size($info); |
|
| 1361 | - } |
|
| 1359 | + if($info !== false) { |
|
| 1360 | + return new ImageHelper_Size($info); |
|
| 1361 | + } |
|
| 1362 | 1362 | |
| 1363 | 1363 | throw new ImageHelper_Exception( |
| 1364 | 1364 | 'Error opening image file', |
@@ -1368,98 +1368,98 @@ discard block |
||
| 1368 | 1368 | ), |
| 1369 | 1369 | self::ERROR_CANNOT_GET_IMAGE_SIZE |
| 1370 | 1370 | ); |
| 1371 | - } |
|
| 1371 | + } |
|
| 1372 | 1372 | |
| 1373 | - /** |
|
| 1374 | - * @param string $imagePath |
|
| 1375 | - * @throws ImageHelper_Exception |
|
| 1376 | - * @return array |
|
| 1377 | - * |
|
| 1378 | - * @todo This should return a ImageHelper_Size instance. |
|
| 1379 | - */ |
|
| 1380 | - protected static function getImageSize_svg(string $imagePath) : array |
|
| 1381 | - { |
|
| 1382 | - $xml = XMLHelper::createSimplexml(); |
|
| 1383 | - $xml->loadFile($imagePath); |
|
| 1373 | + /** |
|
| 1374 | + * @param string $imagePath |
|
| 1375 | + * @throws ImageHelper_Exception |
|
| 1376 | + * @return array |
|
| 1377 | + * |
|
| 1378 | + * @todo This should return a ImageHelper_Size instance. |
|
| 1379 | + */ |
|
| 1380 | + protected static function getImageSize_svg(string $imagePath) : array |
|
| 1381 | + { |
|
| 1382 | + $xml = XMLHelper::createSimplexml(); |
|
| 1383 | + $xml->loadFile($imagePath); |
|
| 1384 | 1384 | |
| 1385 | - if($xml->hasErrors()) { |
|
| 1386 | - throw new ImageHelper_Exception( |
|
| 1387 | - 'Error opening SVG image', |
|
| 1388 | - sprintf( |
|
| 1389 | - 'The XML content of the image [%s] could not be parsed.', |
|
| 1390 | - $imagePath |
|
| 1385 | + if($xml->hasErrors()) { |
|
| 1386 | + throw new ImageHelper_Exception( |
|
| 1387 | + 'Error opening SVG image', |
|
| 1388 | + sprintf( |
|
| 1389 | + 'The XML content of the image [%s] could not be parsed.', |
|
| 1390 | + $imagePath |
|
| 1391 | 1391 | ), |
| 1392 | - self::ERROR_CANNOT_READ_SVG_IMAGE |
|
| 1392 | + self::ERROR_CANNOT_READ_SVG_IMAGE |
|
| 1393 | 1393 | ); |
| 1394 | - } |
|
| 1394 | + } |
|
| 1395 | 1395 | |
| 1396 | - $data = $xml->toArray(); |
|
| 1397 | - $xml->dispose(); |
|
| 1398 | - unset($xml); |
|
| 1396 | + $data = $xml->toArray(); |
|
| 1397 | + $xml->dispose(); |
|
| 1398 | + unset($xml); |
|
| 1399 | 1399 | |
| 1400 | - if(!isset($data['@attributes']) || !isset($data['@attributes']['viewBox'])) { |
|
| 1401 | - throw new ImageHelper_Exception( |
|
| 1402 | - 'SVG Image is corrupted', |
|
| 1403 | - sprintf( |
|
| 1404 | - 'The [viewBox] attribute is missing in the XML of the image at path [%s].', |
|
| 1405 | - $imagePath |
|
| 1400 | + if(!isset($data['@attributes']) || !isset($data['@attributes']['viewBox'])) { |
|
| 1401 | + throw new ImageHelper_Exception( |
|
| 1402 | + 'SVG Image is corrupted', |
|
| 1403 | + sprintf( |
|
| 1404 | + 'The [viewBox] attribute is missing in the XML of the image at path [%s].', |
|
| 1405 | + $imagePath |
|
| 1406 | 1406 | ), |
| 1407 | - self::ERROR_SVG_SOURCE_VIEWBOX_MISSING |
|
| 1407 | + self::ERROR_SVG_SOURCE_VIEWBOX_MISSING |
|
| 1408 | 1408 | ); |
| 1409 | - } |
|
| 1409 | + } |
|
| 1410 | 1410 | |
| 1411 | - $svgWidth = parseNumber($data['@attributes']['width'])->getNumber(); |
|
| 1412 | - $svgHeight = parseNumber($data['@attributes']['height'])->getNumber(); |
|
| 1411 | + $svgWidth = parseNumber($data['@attributes']['width'])->getNumber(); |
|
| 1412 | + $svgHeight = parseNumber($data['@attributes']['height'])->getNumber(); |
|
| 1413 | 1413 | |
| 1414 | - $viewBox = str_replace(' ', ',', $data['@attributes']['viewBox']); |
|
| 1415 | - $size = explode(',', $viewBox); |
|
| 1414 | + $viewBox = str_replace(' ', ',', $data['@attributes']['viewBox']); |
|
| 1415 | + $size = explode(',', $viewBox); |
|
| 1416 | 1416 | |
| 1417 | - if(count($size) != 4) |
|
| 1418 | - { |
|
| 1419 | - throw new ImageHelper_Exception( |
|
| 1420 | - 'SVG image has an invalid viewBox attribute', |
|
| 1421 | - sprintf( |
|
| 1422 | - 'The [viewBox] attribute does not have an expected value: [%s] in path [%s].', |
|
| 1423 | - $viewBox, |
|
| 1424 | - $imagePath |
|
| 1417 | + if(count($size) != 4) |
|
| 1418 | + { |
|
| 1419 | + throw new ImageHelper_Exception( |
|
| 1420 | + 'SVG image has an invalid viewBox attribute', |
|
| 1421 | + sprintf( |
|
| 1422 | + 'The [viewBox] attribute does not have an expected value: [%s] in path [%s].', |
|
| 1423 | + $viewBox, |
|
| 1424 | + $imagePath |
|
| 1425 | 1425 | ), |
| 1426 | - self::ERROR_SVG_VIEWBOX_INVALID |
|
| 1426 | + self::ERROR_SVG_VIEWBOX_INVALID |
|
| 1427 | 1427 | ); |
| 1428 | - } |
|
| 1428 | + } |
|
| 1429 | 1429 | |
| 1430 | - $boxWidth = $size[2]; |
|
| 1431 | - $boxHeight = $size[3]; |
|
| 1430 | + $boxWidth = $size[2]; |
|
| 1431 | + $boxHeight = $size[3]; |
|
| 1432 | 1432 | |
| 1433 | - // calculate the x and y units of the document: |
|
| 1434 | - // @see http://tutorials.jenkov.com/svg/svg-viewport-view-box.html#viewbox |
|
| 1435 | - // |
|
| 1436 | - // The viewbox combined with the width and heigt of the svg |
|
| 1437 | - // allow calculating how many pixels are in one unit of the |
|
| 1438 | - // width and height of the document. |
|
| 1433 | + // calculate the x and y units of the document: |
|
| 1434 | + // @see http://tutorials.jenkov.com/svg/svg-viewport-view-box.html#viewbox |
|
| 1435 | + // |
|
| 1436 | + // The viewbox combined with the width and heigt of the svg |
|
| 1437 | + // allow calculating how many pixels are in one unit of the |
|
| 1438 | + // width and height of the document. |
|
| 1439 | 1439 | // |
| 1440 | - $xUnits = $svgWidth / $boxWidth; |
|
| 1441 | - $yUnits = $svgHeight / $boxHeight; |
|
| 1440 | + $xUnits = $svgWidth / $boxWidth; |
|
| 1441 | + $yUnits = $svgHeight / $boxHeight; |
|
| 1442 | 1442 | |
| 1443 | - $pxWidth = $xUnits * $svgWidth; |
|
| 1444 | - $pxHeight = $yUnits * $svgHeight; |
|
| 1443 | + $pxWidth = $xUnits * $svgWidth; |
|
| 1444 | + $pxHeight = $yUnits * $svgHeight; |
|
| 1445 | 1445 | |
| 1446 | - return array( |
|
| 1447 | - $pxWidth, |
|
| 1448 | - $pxHeight, |
|
| 1449 | - 'bits' => 8 |
|
| 1450 | - ); |
|
| 1451 | - } |
|
| 1446 | + return array( |
|
| 1447 | + $pxWidth, |
|
| 1448 | + $pxHeight, |
|
| 1449 | + 'bits' => 8 |
|
| 1450 | + ); |
|
| 1451 | + } |
|
| 1452 | 1452 | |
| 1453 | - /** |
|
| 1454 | - * Crops the image to the specified width and height, optionally |
|
| 1455 | - * specifying the origin position to crop from. |
|
| 1456 | - * |
|
| 1457 | - * @param integer $width |
|
| 1458 | - * @param integer $height |
|
| 1459 | - * @param integer $x |
|
| 1460 | - * @param integer $y |
|
| 1461 | - * @return ImageHelper |
|
| 1462 | - */ |
|
| 1453 | + /** |
|
| 1454 | + * Crops the image to the specified width and height, optionally |
|
| 1455 | + * specifying the origin position to crop from. |
|
| 1456 | + * |
|
| 1457 | + * @param integer $width |
|
| 1458 | + * @param integer $height |
|
| 1459 | + * @param integer $x |
|
| 1460 | + * @param integer $y |
|
| 1461 | + * @return ImageHelper |
|
| 1462 | + */ |
|
| 1463 | 1463 | public function crop(int $width, int $height, int $x=0, int $y=0) : ImageHelper |
| 1464 | 1464 | { |
| 1465 | 1465 | $new = $this->createNewImage($width, $height); |
@@ -1481,22 +1481,22 @@ discard block |
||
| 1481 | 1481 | return $this->newHeight; |
| 1482 | 1482 | } |
| 1483 | 1483 | |
| 1484 | - /** |
|
| 1485 | - * Calculates the average color value used in |
|
| 1486 | - * the image. Returns an associative array |
|
| 1487 | - * with the red, green, blue and alpha components, |
|
| 1488 | - * or a HEX color string depending on the selected |
|
| 1489 | - * format. |
|
| 1490 | - * |
|
| 1491 | - * NOTE: Use the calcAverageColorXXX methods for |
|
| 1492 | - * strict return types. |
|
| 1493 | - * |
|
| 1494 | - * @param int $format The format in which to return the color value. |
|
| 1495 | - * @return array|string |
|
| 1496 | - * |
|
| 1497 | - * @see ImageHelper::calcAverageColorRGB() |
|
| 1498 | - * @see ImageHelper::calcAverageColorHEX() |
|
| 1499 | - */ |
|
| 1484 | + /** |
|
| 1485 | + * Calculates the average color value used in |
|
| 1486 | + * the image. Returns an associative array |
|
| 1487 | + * with the red, green, blue and alpha components, |
|
| 1488 | + * or a HEX color string depending on the selected |
|
| 1489 | + * format. |
|
| 1490 | + * |
|
| 1491 | + * NOTE: Use the calcAverageColorXXX methods for |
|
| 1492 | + * strict return types. |
|
| 1493 | + * |
|
| 1494 | + * @param int $format The format in which to return the color value. |
|
| 1495 | + * @return array|string |
|
| 1496 | + * |
|
| 1497 | + * @see ImageHelper::calcAverageColorRGB() |
|
| 1498 | + * @see ImageHelper::calcAverageColorHEX() |
|
| 1499 | + */ |
|
| 1500 | 1500 | public function calcAverageColor(int $format=self::COLORFORMAT_RGB) |
| 1501 | 1501 | { |
| 1502 | 1502 | $image = $this->duplicate(); |
@@ -1505,35 +1505,35 @@ discard block |
||
| 1505 | 1505 | return $image->getColorAt(0, 0, $format); |
| 1506 | 1506 | } |
| 1507 | 1507 | |
| 1508 | - /** |
|
| 1509 | - * Calculates the image's average color value, and |
|
| 1510 | - * returns an associative array with red, green, |
|
| 1511 | - * blue and alpha keys. |
|
| 1512 | - * |
|
| 1513 | - * @throws ImageHelper_Exception |
|
| 1514 | - * @return array |
|
| 1515 | - */ |
|
| 1508 | + /** |
|
| 1509 | + * Calculates the image's average color value, and |
|
| 1510 | + * returns an associative array with red, green, |
|
| 1511 | + * blue and alpha keys. |
|
| 1512 | + * |
|
| 1513 | + * @throws ImageHelper_Exception |
|
| 1514 | + * @return array |
|
| 1515 | + */ |
|
| 1516 | 1516 | public function calcAverageColorRGB() : array |
| 1517 | 1517 | { |
| 1518 | - $result = $this->calcAverageColor(self::COLORFORMAT_RGB); |
|
| 1519 | - if(is_array($result)) { |
|
| 1520 | - return $result; |
|
| 1521 | - } |
|
| 1518 | + $result = $this->calcAverageColor(self::COLORFORMAT_RGB); |
|
| 1519 | + if(is_array($result)) { |
|
| 1520 | + return $result; |
|
| 1521 | + } |
|
| 1522 | 1522 | |
| 1523 | - throw new ImageHelper_Exception( |
|
| 1524 | - 'Unexpected color value', |
|
| 1525 | - sprintf('Expected an array, got [%s].', gettype($result)), |
|
| 1526 | - self::ERROR_UNEXPECTED_COLOR_VALUE |
|
| 1527 | - ); |
|
| 1528 | - } |
|
| 1529 | - |
|
| 1530 | - /** |
|
| 1531 | - * Calculates the image's average color value, and |
|
| 1532 | - * returns a hex color string (without the #). |
|
| 1533 | - * |
|
| 1534 | - * @throws ImageHelper_Exception |
|
| 1535 | - * @return string |
|
| 1536 | - */ |
|
| 1523 | + throw new ImageHelper_Exception( |
|
| 1524 | + 'Unexpected color value', |
|
| 1525 | + sprintf('Expected an array, got [%s].', gettype($result)), |
|
| 1526 | + self::ERROR_UNEXPECTED_COLOR_VALUE |
|
| 1527 | + ); |
|
| 1528 | + } |
|
| 1529 | + |
|
| 1530 | + /** |
|
| 1531 | + * Calculates the image's average color value, and |
|
| 1532 | + * returns a hex color string (without the #). |
|
| 1533 | + * |
|
| 1534 | + * @throws ImageHelper_Exception |
|
| 1535 | + * @return string |
|
| 1536 | + */ |
|
| 1537 | 1537 | public function calcAverageColorHex() : string |
| 1538 | 1538 | { |
| 1539 | 1539 | $result = $this->calcAverageColor(self::COLORFORMAT_HEX); |
@@ -1562,18 +1562,18 @@ discard block |
||
| 1562 | 1562 | |
| 1563 | 1563 | const COLORFORMAT_HEX = 2; |
| 1564 | 1564 | |
| 1565 | - /** |
|
| 1566 | - * Retrieves the color value at the specified pixel |
|
| 1567 | - * coordinates in the image. |
|
| 1568 | - * |
|
| 1569 | - * @param int $x |
|
| 1570 | - * @param int $y |
|
| 1571 | - * @param int $format The format in which to return the color value. |
|
| 1572 | - * @return array|string |
|
| 1573 | - * |
|
| 1574 | - * @see ImageHelper::COLORFORMAT_RGB |
|
| 1575 | - * @see ImageHelper::COLORFORMAT_HEX |
|
| 1576 | - */ |
|
| 1565 | + /** |
|
| 1566 | + * Retrieves the color value at the specified pixel |
|
| 1567 | + * coordinates in the image. |
|
| 1568 | + * |
|
| 1569 | + * @param int $x |
|
| 1570 | + * @param int $y |
|
| 1571 | + * @param int $format The format in which to return the color value. |
|
| 1572 | + * @return array|string |
|
| 1573 | + * |
|
| 1574 | + * @see ImageHelper::COLORFORMAT_RGB |
|
| 1575 | + * @see ImageHelper::COLORFORMAT_HEX |
|
| 1576 | + */ |
|
| 1577 | 1577 | public function getColorAt(int $x, int $y, int $format=self::COLORFORMAT_RGB) |
| 1578 | 1578 | { |
| 1579 | 1579 | if($x > $this->getWidth() || $y > $this->getHeight()) |
@@ -1601,21 +1601,21 @@ discard block |
||
| 1601 | 1601 | return $rgb; |
| 1602 | 1602 | } |
| 1603 | 1603 | |
| 1604 | - /** |
|
| 1605 | - * Converts an RGB value to its luminance equivalent. |
|
| 1606 | - * |
|
| 1607 | - * @param array $rgb |
|
| 1608 | - * @return integer Integer, from 0 to 255 (0=black, 255=white) |
|
| 1609 | - */ |
|
| 1604 | + /** |
|
| 1605 | + * Converts an RGB value to its luminance equivalent. |
|
| 1606 | + * |
|
| 1607 | + * @param array $rgb |
|
| 1608 | + * @return integer Integer, from 0 to 255 (0=black, 255=white) |
|
| 1609 | + */ |
|
| 1610 | 1610 | public static function rgb2luma(array $rgb) : int |
| 1611 | 1611 | { |
| 1612 | 1612 | return (int)floor((($rgb['red']*2)+$rgb['blue']+($rgb['green']*3))/6); |
| 1613 | 1613 | } |
| 1614 | 1614 | |
| 1615 | - /** |
|
| 1616 | - * Retrieves the brightness of the image, in percent. |
|
| 1617 | - * @return number |
|
| 1618 | - */ |
|
| 1615 | + /** |
|
| 1616 | + * Retrieves the brightness of the image, in percent. |
|
| 1617 | + * @return number |
|
| 1618 | + */ |
|
| 1619 | 1619 | public function getBrightness() |
| 1620 | 1620 | { |
| 1621 | 1621 | $luma = self::rgb2luma($this->calcAverageColorRGB()); |
@@ -1623,15 +1623,15 @@ discard block |
||
| 1623 | 1623 | return $percent; |
| 1624 | 1624 | } |
| 1625 | 1625 | |
| 1626 | - /** |
|
| 1627 | - * Retrieves an md5 hash of the source image file. |
|
| 1628 | - * |
|
| 1629 | - * NOTE: Only works when the helper has been created |
|
| 1630 | - * from a file. Otherwise an exception is thrown. |
|
| 1631 | - * |
|
| 1632 | - * @return string |
|
| 1633 | - * @throws ImageHelper_Exception |
|
| 1634 | - */ |
|
| 1626 | + /** |
|
| 1627 | + * Retrieves an md5 hash of the source image file. |
|
| 1628 | + * |
|
| 1629 | + * NOTE: Only works when the helper has been created |
|
| 1630 | + * from a file. Otherwise an exception is thrown. |
|
| 1631 | + * |
|
| 1632 | + * @return string |
|
| 1633 | + * @throws ImageHelper_Exception |
|
| 1634 | + */ |
|
| 1635 | 1635 | public function getHash() |
| 1636 | 1636 | { |
| 1637 | 1637 | ob_start(); |
@@ -22,9 +22,9 @@ discard block |
||
| 22 | 22 | */ |
| 23 | 23 | class RequestHelper_Exception extends BaseException |
| 24 | 24 | { |
| 25 | - /** |
|
| 26 | - * @var RequestHelper_Response|NULL |
|
| 27 | - */ |
|
| 25 | + /** |
|
| 26 | + * @var RequestHelper_Response|NULL |
|
| 27 | + */ |
|
| 28 | 28 | protected $response = null; |
| 29 | 29 | |
| 30 | 30 | public function setResponse(RequestHelper_Response $response) |
@@ -32,11 +32,11 @@ discard block |
||
| 32 | 32 | $this->response = $response; |
| 33 | 33 | } |
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * Retrieves the related response instance, if available. |
|
| 37 | - * |
|
| 38 | - * @return RequestHelper_Response|NULL |
|
| 39 | - */ |
|
| 35 | + /** |
|
| 36 | + * Retrieves the related response instance, if available. |
|
| 37 | + * |
|
| 38 | + * @return RequestHelper_Response|NULL |
|
| 39 | + */ |
|
| 40 | 40 | public function getResponse() : ?RequestHelper_Response |
| 41 | 41 | { |
| 42 | 42 | return $this->response; |
@@ -32,23 +32,23 @@ |
||
| 32 | 32 | $this->info = $info; |
| 33 | 33 | } |
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * Enables the authentication information in the URL, |
|
| 37 | - * if a username and password are present. |
|
| 38 | - * |
|
| 39 | - * @param bool $enable Whether to turn it on or off. |
|
| 40 | - * @return URLInfo_Normalizer |
|
| 41 | - */ |
|
| 35 | + /** |
|
| 36 | + * Enables the authentication information in the URL, |
|
| 37 | + * if a username and password are present. |
|
| 38 | + * |
|
| 39 | + * @param bool $enable Whether to turn it on or off. |
|
| 40 | + * @return URLInfo_Normalizer |
|
| 41 | + */ |
|
| 42 | 42 | public function enableAuth(bool $enable=true) : URLInfo_Normalizer |
| 43 | 43 | { |
| 44 | 44 | $this->auth = $enable; |
| 45 | 45 | return $this; |
| 46 | 46 | } |
| 47 | 47 | |
| 48 | - /** |
|
| 49 | - * Retrieves the normalized URL. |
|
| 50 | - * @return string |
|
| 51 | - */ |
|
| 48 | + /** |
|
| 49 | + * Retrieves the normalized URL. |
|
| 50 | + * @return string |
|
| 51 | + */ |
|
| 52 | 52 | public function normalize() : string |
| 53 | 53 | { |
| 54 | 54 | $method = 'normalize_'.$this->info->getType(); |
@@ -17,21 +17,20 @@ discard block |
||
| 17 | 17 | * @package Application Utils |
| 18 | 18 | * @subpackage ConvertHelper |
| 19 | 19 | * @author Sebastian Mordziol <[email protected]> |
| 20 | - |
|
| 21 | 20 | * @see ConvertHelper::interval2string() |
| 22 | 21 | */ |
| 23 | 22 | class ConvertHelper_IntervalConverter |
| 24 | 23 | { |
| 25 | 24 | const ERROR_MISSING_TRANSLATION = 43501; |
| 26 | 25 | |
| 27 | - /** |
|
| 28 | - * @var array|NULL |
|
| 29 | - */ |
|
| 26 | + /** |
|
| 27 | + * @var array|NULL |
|
| 28 | + */ |
|
| 30 | 29 | protected static $texts = null; |
| 31 | 30 | |
| 32 | - /** |
|
| 33 | - * @var array |
|
| 34 | - */ |
|
| 31 | + /** |
|
| 32 | + * @var array |
|
| 33 | + */ |
|
| 35 | 34 | protected $tokens = array('y', 'm', 'd', 'h', 'i', 's'); |
| 36 | 35 | |
| 37 | 36 | public function __construct() |
@@ -41,25 +40,25 @@ discard block |
||
| 41 | 40 | } |
| 42 | 41 | } |
| 43 | 42 | |
| 44 | - /** |
|
| 45 | - * Called whenever the application locale has changed, |
|
| 46 | - * to reset the internal translation cache. |
|
| 47 | - */ |
|
| 43 | + /** |
|
| 44 | + * Called whenever the application locale has changed, |
|
| 45 | + * to reset the internal translation cache. |
|
| 46 | + */ |
|
| 48 | 47 | public function handle_localeChanged() |
| 49 | 48 | { |
| 50 | 49 | self::$texts = null; |
| 51 | 50 | } |
| 52 | 51 | |
| 53 | - /** |
|
| 54 | - * Converts the specified interval to a human readable |
|
| 55 | - * string, e.g. "2 hours and 4 minutes". |
|
| 56 | - * |
|
| 57 | - * @param \DateInterval $interval |
|
| 58 | - * @return string |
|
| 59 | - * @throws ConvertHelper_Exception |
|
| 60 | - * |
|
| 61 | - * @see ConvertHelper_IntervalConverter::ERROR_MISSING_TRANSLATION |
|
| 62 | - */ |
|
| 52 | + /** |
|
| 53 | + * Converts the specified interval to a human readable |
|
| 54 | + * string, e.g. "2 hours and 4 minutes". |
|
| 55 | + * |
|
| 56 | + * @param \DateInterval $interval |
|
| 57 | + * @return string |
|
| 58 | + * @throws ConvertHelper_Exception |
|
| 59 | + * |
|
| 60 | + * @see ConvertHelper_IntervalConverter::ERROR_MISSING_TRANSLATION |
|
| 61 | + */ |
|
| 63 | 62 | public function toString(\DateInterval $interval) : string |
| 64 | 63 | { |
| 65 | 64 | $this->initTexts(); |
@@ -88,14 +87,14 @@ discard block |
||
| 88 | 87 | return t('%1$s and %2$s', implode(', ', $parts), $last); |
| 89 | 88 | } |
| 90 | 89 | |
| 91 | - /** |
|
| 92 | - * Translates the selected time token, e.g. "y" (for year). |
|
| 93 | - * |
|
| 94 | - * @param string $token |
|
| 95 | - * @param ConvertHelper_DateInterval $interval |
|
| 96 | - * @throws ConvertHelper_Exception |
|
| 97 | - * @return string |
|
| 98 | - */ |
|
| 90 | + /** |
|
| 91 | + * Translates the selected time token, e.g. "y" (for year). |
|
| 92 | + * |
|
| 93 | + * @param string $token |
|
| 94 | + * @param ConvertHelper_DateInterval $interval |
|
| 95 | + * @throws ConvertHelper_Exception |
|
| 96 | + * @return string |
|
| 97 | + */ |
|
| 99 | 98 | protected function translateToken(string $token, ConvertHelper_DateInterval $interval) : string |
| 100 | 99 | { |
| 101 | 100 | $value = $interval->getToken($token); |
@@ -123,13 +122,13 @@ discard block |
||
| 123 | 122 | ); |
| 124 | 123 | } |
| 125 | 124 | |
| 126 | - /** |
|
| 127 | - * Resolves all time tokens that need to be translated in |
|
| 128 | - * the subject interval, depending on its length. |
|
| 129 | - * |
|
| 130 | - * @param ConvertHelper_DateInterval $interval |
|
| 131 | - * @return array |
|
| 132 | - */ |
|
| 125 | + /** |
|
| 126 | + * Resolves all time tokens that need to be translated in |
|
| 127 | + * the subject interval, depending on its length. |
|
| 128 | + * |
|
| 129 | + * @param ConvertHelper_DateInterval $interval |
|
| 130 | + * @return array |
|
| 131 | + */ |
|
| 133 | 132 | protected function resolveTokens(ConvertHelper_DateInterval $interval) : array |
| 134 | 133 | { |
| 135 | 134 | $offset = 0; |
@@ -147,9 +146,9 @@ discard block |
||
| 147 | 146 | return array(); |
| 148 | 147 | } |
| 149 | 148 | |
| 150 | - /** |
|
| 151 | - * Initializes the translateable strings. |
|
| 152 | - */ |
|
| 149 | + /** |
|
| 150 | + * Initializes the translateable strings. |
|
| 151 | + */ |
|
| 153 | 152 | protected function initTexts() : void |
| 154 | 153 | { |
| 155 | 154 | if(isset(self::$texts)) { |