Mistralys / application-utils

src/ImageHelper.php

Spacing +95 added lines, -95 removed lines

@@ -134,10 +134,10 @@ 
         'gif'
     );
     
-    public function __construct($sourceFile=null, $resource=null, $type=null)
+    public function __construct($sourceFile = null, $resource = null, $type = null)
     {
         // ensure that the GD library is installed
-        if(!function_exists('imagecreate')) 
+        if (!function_exists('imagecreate')) 
         {
             throw new ImageHelper_Exception(
                 'The PHP GD extension is not installed or not enabled.',
@@ -146,7 +146,7 @@ 
             );
         }
         
-        if(is_resource($resource)) 
+        if (is_resource($resource)) 
         {
             $this->sourceImage = $resource;
             $this->type = $type;
@@ -170,21 +170,21 @@ 
             if (is_null($this->type)) {
                 throw new ImageHelper_Exception(
                     'Error opening image',
-                    'Not a valid supported image type for image ' . $this->file,
+                    'Not a valid supported image type for image '.$this->file,
                     self::ERROR_UNSUPPORTED_IMAGE_TYPE
                 );
             }
 
             $this->info = self::getImageSize($this->file);
 
-            if(!$this->isVector()) 
+            if (!$this->isVector()) 
             {
-                $method = 'imagecreatefrom' . $this->type;
+                $method = 'imagecreatefrom'.$this->type;
                 $this->sourceImage = $method($this->file);
                 if (!$this->sourceImage) {
                     throw new ImageHelper_Exception(
                         'Error creating new image',
-                        $method . ' failed',
+                        $method.' failed',
                         self::ERROR_FAILED_TO_CREATE_NEW_IMAGE
                     );
                 }
@@ -196,7 +196,7 @@ 
         $this->width = $this->info->getWidth();
         $this->height = $this->info->getHeight();
 
-        if(!$this->isVector()) {
+        if (!$this->isVector()) {
             $this->setNewImage($this->duplicateImage($this->sourceImage));
         }
     }
@@ -212,10 +212,10 @@ 
     *
     * @see ImageHelper::ERROR_CANNOT_CREATE_IMAGE_OBJECT
     */
-    public static function createNew($width, $height, $type='png')
+    public static function createNew($width, $height, $type = 'png')
     {
         $img = imagecreatetruecolor($width, $height);
-        if($img !== false) {
+        if ($img !== false) {
             return self::createFromResource($img, 'png');
         }
         
@@ -238,7 +238,7 @@ 
     * @param string $type The target image type, e.g. "jpeg", "png", etc.
     * @return ImageHelper
     */
-    public static function createFromResource($resource, ?string $type=null)
+    public static function createFromResource($resource, ?string $type = null)
     {
         self::requireResource($resource);
         
@@ -270,7 +270,7 @@ 
     */
     public static function setConfig($name, $value)
     {
-        if(isset(self::$config[$name])) {
+        if (isset(self::$config[$name])) {
             self::$config[$name] = $value;
         }
     }
@@ -281,7 +281,7 @@ 
     * 
     * @param bool $enabled
     */
-    public static function setAutoMemoryAdjustment($enabled=true)
+    public static function setAutoMemoryAdjustment($enabled = true)
     {
         self::setConfig('auto-memory-adjustment', $enabled);
     }
@@ -315,7 +315,7 @@ 
 
     public function enableAlpha()
     {
-        if(!$this->alpha) 
+        if (!$this->alpha) 
         {
             self::addAlphaSupport($this->newImage, false);
             $this->alpha = true;
@@ -346,9 +346,9 @@ 
      * @param number $percent
      * @return ImageHelper
      */
-    public function sharpen($percent=0)
+    public function sharpen($percent = 0)
     {
-        if($percent <= 0) {
+        if ($percent <= 0) {
             return $this;
         }
         
@@ -357,9 +357,9 @@ 
         return $this->convolute($factor);
     }
     
-    public function blur($percent=0)
+    public function blur($percent = 0)
     {
-        if($percent <= 0) {
+        if ($percent <= 0) {
             return $this;
         }
         
@@ -372,12 +372,12 @@ 
     {
         // get a value thats equal to 64 - abs( factor )
         // ( using min/max to limited the factor to 0 - 64 to not get out of range values )
-        $val1Adjustment = 64 - min( 64, max( 0, abs( $factor ) ) );
+        $val1Adjustment = 64 - min(64, max(0, abs($factor)));
         
         // the base factor for the "current" pixel depends on if we are blurring or sharpening.
         // If we are blurring use 1, if sharpening use 9.
         $val1Base = 9;
-        if( abs( $factor ) != $factor ) {
+        if (abs($factor) != $factor) {
             $val1Base = 1;
         }
         
@@ -390,24 +390,24 @@ 
         
         // the value for the surrounding pixels is either positive or negative depending on if we are blurring or sharpening.
         $val2 = -1;
-        if( abs( $factor ) != $factor ) {
+        if (abs($factor) != $factor) {
             $val2 = 1;
         }
         
         // setup matrix ..
         $matrix = array(
-            array( $val2, $val2, $val2 ),
-            array( $val2, $val1, $val2 ),
-            array( $val2, $val2, $val2 )
+            array($val2, $val2, $val2),
+            array($val2, $val1, $val2),
+            array($val2, $val2, $val2)
         );
         
         // calculate the correct divisor
         // actual divisor is equal to "$divisor = $val1 + $val2 * 8;"
         // but the following line is more generic
-        $divisor = array_sum( array_map( 'array_sum', $matrix ) );
+        $divisor = array_sum(array_map('array_sum', $matrix));
         
         // apply the matrix
-        imageconvolution( $this->newImage, $matrix, $divisor, 0 );
+        imageconvolution($this->newImage, $matrix, $divisor, 0);
         
         return $this;
     }
@@ -533,7 +533,7 @@ 
     */
     public function resample(?int $width = null, ?int $height = null) : ImageHelper
     {
-        if($this->isVector()) {
+        if ($this->isVector()) {
             return $this;
         }
         
@@ -554,7 +554,7 @@ 
 
     public function resampleAndCrop($width, $height) : ImageHelper
     {
-        if($this->isVector()) {
+        if ($this->isVector()) {
             return $this;
         }
 
@@ -601,14 +601,14 @@ 
     * @param resource $canvas
     * @param bool $fill Whether to fill the whole canvas with the transparency
     */
-    public static function addAlphaSupport($canvas, $fill=true)
+    public static function addAlphaSupport($canvas, $fill = true)
     {
         self::requireResource($canvas);
         
-        imagealphablending($canvas,true);
+        imagealphablending($canvas, true);
         imagesavealpha($canvas, true);
 
-        if($fill) {
+        if ($fill) {
             self::fillImageTransparent($canvas);
         }
     }
@@ -618,13 +618,13 @@ 
         return $this->alpha;
     }
 
-    public function save(string $targetFile, $dispose=true)
+    public function save(string $targetFile, $dispose = true)
     {
-        if($this->isVector()) {
+        if ($this->isVector()) {
             return true;
         }
         
-        if(!is_resource($this->newImage)) {
+        if (!is_resource($this->newImage)) {
             throw new ImageHelper_Exception(
                 'Error creating new image',
                 'Cannot save an image, no valid image resource was created. You have to call one of the resample methods to create a new image.',
@@ -636,7 +636,7 @@ 
             unlink($targetFile);
         }
         
-        $method = 'image' . $this->type;
+        $method = 'image'.$this->type;
         if (!$method($this->newImage, $targetFile, $this->resolveQuality())) {
             throw new ImageHelper_Exception(
                 'Error creating new image',
@@ -657,7 +657,7 @@ 
             );
         }
 
-        if($dispose) {
+        if ($dispose) {
             $this->dispose();
         }
         
@@ -666,11 +666,11 @@ 
     
     public function dispose()
     {
-        if(is_resource($this->sourceImage)) {
+        if (is_resource($this->sourceImage)) {
             imagedestroy($this->sourceImage);
         }
         
-        if(is_resource($this->newImage)) {
+        if (is_resource($this->newImage)) {
             imagedestroy($this->newImage);
         }
     }
@@ -723,7 +723,7 @@ 
     */
     protected function adjustMemory() : bool
     {
-        if(!self::$config['auto-memory-adjustment']) {
+        if (!self::$config['auto-memory-adjustment']) {
             return true;
         }
         
@@ -752,7 +752,7 @@ 
         if (function_exists('memory_get_usage') && memory_get_usage() + $memoryNeeded > $memoryLimit) {
             $newLimit = ($memoryLimit + (memory_get_usage() + $memoryNeeded)) / $MB;
             $newLimit = ceil($newLimit);
-            ini_set('memory_limit', $newLimit . 'M');
+            ini_set('memory_limit', $newLimit.'M');
 
             return true;
         }
@@ -783,16 +783,16 @@ 
     */
     protected function resampleImage(int $newWidth, int $newHeight) : ImageHelper
     {
-        if($this->isVector()) {
+        if ($this->isVector()) {
             return $this;
         }
 
-        if($this->newWidth==$newWidth && $this->newHeight==$newHeight) {
+        if ($this->newWidth == $newWidth && $this->newHeight == $newHeight) {
             return $this;
         }
         
-        if($newWidth < 1) { $newWidth = 1; }
-        if($newHeight < 1) { $newHeight = 1; }
+        if ($newWidth < 1) { $newWidth = 1; }
+        if ($newHeight < 1) { $newHeight = 1; }
         
         $this->adjustMemory();
 
@@ -856,11 +856,11 @@ 
      * @param string $imageType The image format to send, i.e. "jpeg", "png"
      * @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 
      */
-    public static function displayImageStream($resource, $imageType, $quality=-1)
+    public static function displayImageStream($resource, $imageType, $quality = -1)
     {
         $imageType = strtolower($imageType);
         
-        if(!in_array($imageType, self::$streamTypes)) {
+        if (!in_array($imageType, self::$streamTypes)) {
             throw new ImageHelper_Exception(
                 'Invalid image stream type',
                 sprintf(
@@ -871,9 +871,9 @@ 
             );
         }
         
-        header('Content-type:image/' . $imageType);
+        header('Content-type:image/'.$imageType);
 
-        $function = 'image' . $imageType;
+        $function = 'image'.$imageType;
         
         $function($resource, null, $quality);
     }
@@ -889,7 +889,7 @@ 
         if (headers_sent($file, $line)) {
             throw new ImageHelper_Exception(
                 'Error displaying image',
-                'Headers have already been sent: in file ' . $file . ':' . $line,
+                'Headers have already been sent: in file '.$file.':'.$line,
                 self::ERROR_HEADERS_ALREADY_SENT
             );
         }
@@ -906,16 +906,16 @@ 
         }
 
         $format = self::getFileImageType($imageFile);
-        if($format == 'svg') {
+        if ($format == 'svg') {
             $format = 'svg+xml';
         }
 
-        $contentType = 'image/' . $format;
+        $contentType = 'image/'.$format;
         
         header('Content-Type: '.$contentType);
-        header("Last-Modified: " . gmdate("D, d M Y H:i:s", filemtime($imageFile)) . " GMT");
+        header("Last-Modified: ".gmdate("D, d M Y H:i:s", filemtime($imageFile))." GMT");
         header('Cache-Control: public');
-        header('Content-Length: ' . filesize($imageFile));
+        header('Content-Length: '.filesize($imageFile));
 
         readfile($imageFile);
     }
@@ -933,7 +933,7 @@ 
     * 
     * @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.
     */
-    public function trim($color=null)
+    public function trim($color = null)
     {
         return $this->trimImage($this->newImage, $color);
     }
@@ -950,7 +950,7 @@ 
         $color = imagecolorsforindex($img, $colorIndex);
         
         // it seems imagecolorsforindex may return false (undocumented, unproven)
-        if(is_array($color)) {
+        if (is_array($color)) {
             return $color;
         }
         
@@ -970,15 +970,15 @@ 
     * @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.
     * @return ImageHelper
     */
-    protected function trimImage($img, ?array $color=null) : ImageHelper
+    protected function trimImage($img, ?array $color = null) : ImageHelper
     {
-        if($this->isVector()) {
+        if ($this->isVector()) {
             return $this;
         }
 
         self::requireResource($img);
         
-        if(empty($color)) 
+        if (empty($color)) 
         {
             $color = imagecolorat($img, 0, 0);
             $color = $this->getIndexedColors($img, $color);
@@ -995,16 +995,16 @@ 
         $ymax = null;
          
         // Start scanning for the edges.
-        for ($iy=0; $iy<$imh; $iy++)
+        for ($iy = 0; $iy < $imh; $iy++)
         {
             $first = true;
             
-            for ($ix=0; $ix<$imw; $ix++)
+            for ($ix = 0; $ix < $imw; $ix++)
             {
                 $ndx = imagecolorat($img, $ix, $iy);
                 $colors = $this->getIndexedColors($img, $ndx);
                 
-                if(!$this->colorsMatch($colors, $color)) 
+                if (!$this->colorsMatch($colors, $color)) 
                 {
                     if ($xmin > $ix) { $xmin = $ix; }
                     if ($xmax < $ix) { $xmax = $ix; }
@@ -1012,7 +1012,7 @@ 
                     
                     $ymax = $iy;
                     
-                    if($first)
+                    if ($first)
                     { 
                         $ix = $xmax; 
                         $first = false; 
@@ -1022,18 +1022,18 @@ 
         }
         
         // no trimming border found
-        if($ymax === null && $ymax === null) {
+        if ($ymax === null && $ymax === null) {
             return $this;
         }
         
         // The new width and height of the image. 
-        $imw = 1+$xmax-$xmin; // Image width in pixels
-        $imh = 1+$ymax-$ymin; // Image height in pixels
+        $imw = 1 + $xmax - $xmin; // Image width in pixels
+        $imh = 1 + $ymax - $ymin; // Image height in pixels
 
         // Make another image to place the trimmed version in.
         $im2 = $this->createNewImage($imw, $imh);
         
-        if($color['alpha'] > 0) 
+        if ($color['alpha'] > 0) 
         {
             $bg2 = imagecolorallocatealpha($im2, $color['red'], $color['green'], $color['blue'], $color['alpha']);
             imagecolortransparent($im2, $bg2);
@@ -1069,7 +1069,7 @@ 
         
         $this->newImage = $image;
         $this->newWidth = imagesx($image);
-        $this->newHeight= imagesy($image);
+        $this->newHeight = imagesy($image);
     }
     
    /**
@@ -1080,7 +1080,7 @@ 
     */
     protected static function requireResource($subject)
     {
-        if(is_resource($subject)) {
+        if (is_resource($subject)) {
             return;
         }
         
@@ -1106,7 +1106,7 @@ 
     {
         $img = imagecreatetruecolor($width, $height);
         
-        if($img === false) 
+        if ($img === false) 
         {
             throw new ImageHelper_Exception(
                 'Error creating new image',
@@ -1130,8 +1130,8 @@ 
 	protected function colorsMatch($a, $b) : bool
 	{
 		$parts = array('red', 'green', 'blue');
-		foreach($parts as $part) {
-			if($a[$part] != $b[$part]) {
+		foreach ($parts as $part) {
+			if ($a[$part] != $b[$part]) {
 				return false;
 			}
 		} 
@@ -1139,7 +1139,7 @@ 
 		return true;
 	}
 	
-	public function fillWhite($x=0, $y=0)
+	public function fillWhite($x = 0, $y = 0)
 	{
 	    $this->addRGBColor('white', 255, 255, 255);
         return $this->fill('white', $x, $y);
@@ -1159,11 +1159,11 @@ 
 	    self::requireResource($resource);
 	    
 	    $transparent = imagecolorallocatealpha($resource, 89, 14, 207, 127);
-	    imagecolortransparent ($resource, $transparent);
+	    imagecolortransparent($resource, $transparent);
 	    imagefill($resource, 0, 0, $transparent);
 	}
 	
-	public function fill($colorName, $x=0, $y=0)
+	public function fill($colorName, $x = 0, $y = 0)
 	{
 	    imagefill($this->newImage, $x, $y, $this->colors[$colorName]);
 	    return $this;
@@ -1177,7 +1177,7 @@ 
         return $this;
     }
     
-    public function textTTF($text, $size, $colorName, $x=0, $y=0, $angle=0)
+    public function textTTF($text, $size, $colorName, $x = 0, $y = 0, $angle = 0)
     {
         imagealphablending($this->newImage, true);
         
@@ -1196,11 +1196,11 @@ 
         return $this->newImage;
     }
     
-    public function paste(ImageHelper $target, $xpos=0, $ypos=0, $sourceX=0, $sourceY=0)
+    public function paste(ImageHelper $target, $xpos = 0, $ypos = 0, $sourceX = 0, $sourceY = 0)
     {
         $img = $target->getImage();
         
-        if($target->isAlpha()) {
+        if ($target->isAlpha()) {
             $this->enableAlpha();
         }
         
@@ -1246,10 +1246,10 @@ 
     public function fitText($text, $matchWidth)
     {
         $sizes = array();
-        for($i=1; $i<=1000; $i=$i+0.1) {
+        for ($i = 1; $i <= 1000; $i = $i + 0.1) {
             $size = $this->calcTextSize($text, $i);
             $sizes[] = $size;
-            if($size['width'] >= $matchWidth) {
+            if ($size['width'] >= $matchWidth) {
                 break;
             }
         }
@@ -1261,7 +1261,7 @@ 
         $diffLast = $last['width'] - $matchWidth;
         $diffPrev = $matchWidth - $prev['width'];
     
-        if($diffLast <= $diffPrev) {
+        if ($diffLast <= $diffPrev) {
             return $last;
         }
     
@@ -1289,14 +1289,14 @@ 
             'bottom_left_y' => $box[1],
             'bottom_right_x' => $box[2],
             'bottom_right_y' => $box[3],
-            'width' => $right-$left,
-            'height' => $bottom-$top
+            'width' => $right - $left,
+            'height' => $bottom - $top
         );
     }
     
     protected function requireTTFFont()
     {
-        if(isset($this->TTFFile)) {
+        if (isset($this->TTFFile)) {
             return;
         }
         
@@ -1331,7 +1331,7 @@ 
 	 */
 	public static function getImageSize($pathOrResource) : ImageHelper_Size
 	{
-	    if(is_resource($pathOrResource)) 
+	    if (is_resource($pathOrResource)) 
 	    {
 	        return new ImageHelper_Size(array(
 	            'width' => imagesx($pathOrResource),
@@ -1345,7 +1345,7 @@ 
 	    
 	    $info = false;
 	    $method = 'getImageSize_'.$type;
-	    if(method_exists(__CLASS__, $method)) 
+	    if (method_exists(__CLASS__, $method)) 
 	    {
 	        $info = call_user_func(array(__CLASS__, $method), $pathOrResource);
 	    } 
@@ -1354,7 +1354,7 @@ 
 	        $info = getimagesize($pathOrResource);
 	    }
 	    
-	    if($info !== false) {
+	    if ($info !== false) {
 	        return new ImageHelper_Size($info);
 	    }
 	    
@@ -1380,7 +1380,7 @@ 
 	    $xml = XMLHelper::createSimplexml();
 	    $xml->loadFile($imagePath);
 	    
-	    if($xml->hasErrors()) {
+	    if ($xml->hasErrors()) {
 	        throw new ImageHelper_Exception(
 	            'Error opening SVG image',
 	            sprintf(
@@ -1395,7 +1395,7 @@ 
 	    $xml->dispose();
 	    unset($xml);
 	    
-	    if(!isset($data['@attributes']) || !isset($data['@attributes']['viewBox'])) {
+	    if (!isset($data['@attributes']) || !isset($data['@attributes']['viewBox'])) {
 	        throw new ImageHelper_Exception(
 	            'SVG Image is corrupted',
 	            sprintf(
@@ -1411,7 +1411,7 @@ 
 	    
 	    $viewBox = str_replace(' ', ',', $data['@attributes']['viewBox']);
 	    $viewBox = explode(',', $viewBox);
-	    if(count($viewBox) != 4) {
+	    if (count($viewBox) != 4) {
 	        throw new ImageHelper_Exception(
 	            'SVG image has an invalid viewBox attribute',
 	            sprintf(
@@ -1456,7 +1456,7 @@ 
     * @param integer $y
     * @return ImageHelper
     */
-    public function crop(int $width, int $height, int $x=0, int $y=0) : ImageHelper
+    public function crop(int $width, int $height, int $x = 0, int $y = 0) : ImageHelper
     {
         $new = $this->createNewImage($width, $height);
         
@@ -1485,7 +1485,7 @@ 
     * @param int $format The format in which to return the color value.
     * @return array|string
     */
-    public function calcAverageColor(int $format=self::COLORFORMAT_RGB)
+    public function calcAverageColor(int $format = self::COLORFORMAT_RGB)
     {
         $image = $this->duplicate();
         $image->resample(1, 1);
@@ -1519,9 +1519,9 @@ 
     * @see ImageHelper::COLORFORMAT_RGB
     * @see ImageHelper::COLORFORMAT_HEX
     */
-    public function getColorAt(int $x, int $y, int $format=self::COLORFORMAT_RGB)
+    public function getColorAt(int $x, int $y, int $format = self::COLORFORMAT_RGB)
     {
-        if($x > $this->getWidth() || $y > $this->getHeight()) 
+        if ($x > $this->getWidth() || $y > $this->getHeight()) 
         {
             throw new ImageHelper_Exception(
                 'Position out of bounds',
@@ -1539,7 +1539,7 @@ 
         $idx = imagecolorat($this->newImage, $x, $y);
         $rgb = $this->getIndexedColors($this->newImage, $idx);
         
-        if($format == self::COLORFORMAT_HEX) {
+        if ($format == self::COLORFORMAT_HEX) {
             return self::rgb2hex($rgb);
         }
 
@@ -1554,7 +1554,7 @@ 
     */
     public static function rgb2luma($rgb)
     {
-        return (($rgb['red']*2)+$rgb['blue']+($rgb['green']*3))/6;
+        return (($rgb['red'] * 2) + $rgb['blue'] + ($rgb['green'] * 3)) / 6;
     }
     
    /**