Mistralys / application-utils

src/HSVColor.php

Spacing +2 added lines, -2 removed lines

@@ -33,9 +33,9 @@
     private BrightnessChannel $brightness;
     private ColorChannel $alpha;
 
-    public function __construct(HueChannel $hue, SaturationChannel $saturation, BrightnessChannel $brightness, ?ColorChannel $alpha=null)
+    public function __construct(HueChannel $hue, SaturationChannel $saturation, BrightnessChannel $brightness, ?ColorChannel $alpha = null)
     {
-        if($alpha === null) {
+        if ($alpha === null) {
             $alpha = ColorChannel::alpha(0);
         }
 

src/ImageHelper.php

Indentation +213 added lines, -213 removed lines

@@ -73,13 +73,13 @@ 
     protected array $colors = array();
 
     /**
-    * @var resource|NULL
-    */
+     * @var resource|NULL
+     */
     protected $newImage;
 
-   /**
-    * @var resource
-    */
+    /**
+     * @var resource
+     */
     protected $sourceImage;
 
     /**
@@ -188,17 +188,17 @@ 
         }
     }
 
-   /**
-    * Factory method: creates a new helper with a blank image.
-    * 
-    * @param integer $width
-    * @param integer $height
-    * @param string $type The target file type when saving
-    * @return ImageHelper
-    * @throws ImageHelper_Exception
-    *
-    * @see ImageHelper::ERROR_CANNOT_CREATE_IMAGE_OBJECT
-    */
+    /**
+     * Factory method: creates a new helper with a blank image.
+     * 
+     * @param integer $width
+     * @param integer $height
+     * @param string $type The target file type when saving
+     * @return ImageHelper
+     * @throws ImageHelper_Exception
+     *
+     * @see ImageHelper::ERROR_CANNOT_CREATE_IMAGE_OBJECT
+     */
     public static function createNew(int $width, int $height, string $type='png') : self
     {
         $img = imagecreatetruecolor($width, $height);
@@ -249,17 +249,17 @@ 
         return new ImageHelper($file, null, self::getFileImageType($file));
     }
     
-   /**
-    * Sets a global image helper configuration value. Available
-    * configuration settings are:
-    * 
-    * <ul>
-    * <li><code>auto-memory-adjustment</code> <i>boolean</i> Whether to try and adjust the memory limit automatically so there will be enough to load/process the target image.</li>
-    * </ul>
-    * 
-    * @param string $name
-    * @param mixed|NULL $value
-    */
+    /**
+     * Sets a global image helper configuration value. Available
+     * configuration settings are:
+     * 
+     * <ul>
+     * <li><code>auto-memory-adjustment</code> <i>boolean</i> Whether to try and adjust the memory limit automatically so there will be enough to load/process the target image.</li>
+     * </ul>
+     * 
+     * @param string $name
+     * @param mixed|NULL $value
+     */
     public static function setConfig(string $name, $value) : void
     {
         if(isset(self::$config[$name])) {
@@ -267,13 +267,13 @@ 
         }
     }
 
-   /**
-    * Shorthand for setting the automatic memory adjustment
-    * global configuration setting.
-    *
-    * @param bool $enabled
-    * @return void
-    */
+    /**
+     * Shorthand for setting the automatic memory adjustment
+     * global configuration setting.
+     *
+     * @param bool $enabled
+     * @return void
+     */
     public static function setAutoMemoryAdjustment(bool $enabled=true) : void
     {
         self::setConfig('auto-memory-adjustment', $enabled);
@@ -747,12 +747,12 @@ 
         return $this;
     }
 
-   /**
-    * Attempts to adjust the memory to the required size
-    * to work with the current image.
-    * 
-    * @return boolean
-    */
+    /**
+     * Attempts to adjust the memory to the required size
+     * to work with the current image.
+     * 
+     * @return boolean
+     */
     protected function adjustMemory() : bool
     {
         if(!self::$config['auto-memory-adjustment']) {
@@ -805,15 +805,15 @@ 
         return $this->resampleImage($width, $height);
     }
 
-   /**
-    * Creates a new image from the current image,
-    * resampling it to the new size.
-    * 
-    * @param int $newWidth
-    * @param int $newHeight   
-    * @throws ImageHelper_Exception
-    * @return ImageHelper
-    */
+    /**
+     * Creates a new image from the current image,
+     * resampling it to the new size.
+     * 
+     * @param int $newWidth
+     * @param int $newHeight   
+     * @throws ImageHelper_Exception
+     * @return ImageHelper
+     */
     protected function resampleImage(int $newWidth, int $newHeight) : ImageHelper
     {
         if($this->isVector()) {
@@ -885,17 +885,17 @@ 
         return array_unique($types);
     }
     
-   /**
-    * Displays an existing image resource.
-    *
-    * @param resource $resource
-    * @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
-    *
-    * @throws ImageHelper_Exception
-    * @see ImageHelper::ERROR_NOT_A_RESOURCE
-    * @see ImageHelper::ERROR_INVALID_STREAM_IMAGE_TYPE
-    */
+    /**
+     * Displays an existing image resource.
+     *
+     * @param resource $resource
+     * @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
+     *
+     * @throws ImageHelper_Exception
+     * @see ImageHelper::ERROR_NOT_A_RESOURCE
+     * @see ImageHelper::ERROR_INVALID_STREAM_IMAGE_TYPE
+     */
     public static function displayImageStream($resource, string $imageType, int $quality=-1) : void
     {
         self::requireResource($resource);
@@ -979,11 +979,11 @@ 
         readfile($imageFile);
     }
     
-   /**
-    * Displays the current image.
-    *
-    * NOTE: You must call `exit()` manually after this.
-    */
+    /**
+     * Displays the current image.
+     *
+     * NOTE: You must call `exit()` manually after this.
+     */
     public function display() : void
     {
         self::displayImageStream(
@@ -1097,14 +1097,14 @@ 
         return $this;
     }
     
-   /**
-    * Requires the subject to be a resource.
-    * 
-    * @param resource|GdImage|mixed $subject
-    *
-    * @throws ImageHelper_Exception
-    * @see ImageHelper::ERROR_NOT_A_RESOURCE
-    */
+    /**
+     * Requires the subject to be a resource.
+     * 
+     * @param resource|GdImage|mixed $subject
+     *
+     * @throws ImageHelper_Exception
+     * @see ImageHelper::ERROR_NOT_A_RESOURCE
+     */
     public static function requireResource($subject) : void
     {
         if(is_resource($subject) && imagesx($subject)) {
@@ -1125,14 +1125,14 @@ 
         );
     }
     
-   /**
-    * Creates a new image resource, with transparent background.
-    * 
-    * @param int $width
-    * @param int $height
-    * @throws ImageHelper_Exception
-    * @return resource
-    */
+    /**
+     * Creates a new image resource, with transparent background.
+     * 
+     * @param int $width
+     * @param int $height
+     * @throws ImageHelper_Exception
+     * @return resource
+     */
     public function createNewImage(int $width, int $height)
     {
         $img = imagecreatetruecolor($width, $height);
@@ -1156,38 +1156,38 @@ 
      * @param int $y
      * @return $this
      */
-	public function fillWhite(int $x=0, int $y=0) : self
-	{
-	    $this->addRGBColor('white', 255, 255, 255);
+    public function fillWhite(int $x=0, int $y=0) : self
+    {
+        $this->addRGBColor('white', 255, 255, 255);
         return $this->fill('white', $x, $y);
-	}
+    }
 
     /**
      * @return $this
      * @throws ImageHelper_Exception
      */
-	public function fillTransparent() : self
-	{
+    public function fillTransparent() : self
+    {
         $this->enableAlpha();
 	    
-	    self::fillImageTransparent($this->newImage);
+        self::fillImageTransparent($this->newImage);
 	    
-	    return $this;
-	}
+        return $this;
+    }
 
     /**
      * @param resource $resource
      * @return void
      * @throws ImageHelper_Exception
      */
-	public static function fillImageTransparent($resource) : void
-	{
-	    self::requireResource($resource);
+    public static function fillImageTransparent($resource) : void
+    {
+        self::requireResource($resource);
 	    
-	    $transparent = imagecolorallocatealpha($resource, 89, 14, 207, 127);
-	    imagecolortransparent ($resource, $transparent);
-	    imagefill($resource, 0, 0, $transparent);
-	}
+        $transparent = imagecolorallocatealpha($resource, 89, 14, 207, 127);
+        imagecolortransparent ($resource, $transparent);
+        imagefill($resource, 0, 0, $transparent);
+    }
 
     /**
      * @param string $colorName
@@ -1195,11 +1195,11 @@ 
      * @param int $y
      * @return $this
      */
-	public function fill(string $colorName, int $x=0, int $y=0) : self
-	{
-	    imagefill($this->newImage, $x, $y, $this->colors[$colorName]);
-	    return $this;
-	}
+    public function fill(string $colorName, int $x=0, int $y=0) : self
+    {
+        imagefill($this->newImage, $x, $y, $this->colors[$colorName]);
+        return $this;
+    }
 
     /**
      * @param string $name
@@ -1243,9 +1243,9 @@ 
         return $this;
     }
     
-   /**
-    * @return resource
-    */
+    /**
+     * @return resource
+     */
     public function getImage()
     {
         return $this->newImage;
@@ -1293,17 +1293,17 @@ 
      *
      * @see ImageHelper::ERROR_CANNOT_GET_IMAGE_SIZE
      */
-	public function getSize() : ImageHelper_Size
+    public function getSize() : ImageHelper_Size
     {
-	    return self::getImageSize($this->newImage);
+        return self::getImageSize($this->newImage);
     }
     
-   /**
-    * Sets the TTF font file to use for text operations.
-    * 
-    * @param string $filePath
-    * @return $this
-    */
+    /**
+     * Sets the TTF font file to use for text operations.
+     * 
+     * @param string $filePath
+     * @return $this
+     */
     public function setFontTTF(string $filePath) : self
     {
         $this->TTFFile = $filePath;
@@ -1381,7 +1381,7 @@ 
             return;
         }
         
-	    throw new ImageHelper_Exception(
+        throw new ImageHelper_Exception(
             'No true type font specified',
             'This functionality requires a TTF font file to be specified with the [setFontTTF] method.',
             self::ERROR_NO_TRUE_TYPE_FONT_SET    
@@ -1404,37 +1404,37 @@ 
      * @see ImageHelper::ERROR_SVG_SOURCE_VIEWBOX_MISSING
      * @see ImageHelper::ERROR_SVG_VIEWBOX_INVALID
      */
-	public static function getImageSize($pathOrResource) : ImageHelper_Size
-	{
-	    if(is_resource($pathOrResource) || $pathOrResource instanceof GdImage)
-	    {
-	        return new ImageHelper_Size(array(
-	            'width' => imagesx($pathOrResource),
-	            'height' => imagesy($pathOrResource),
-	            'channels' => 1,
-	            'bits' => 8
-	        ));
-	    }
+    public static function getImageSize($pathOrResource) : ImageHelper_Size
+    {
+        if(is_resource($pathOrResource) || $pathOrResource instanceof GdImage)
+        {
+            return new ImageHelper_Size(array(
+                'width' => imagesx($pathOrResource),
+                'height' => imagesy($pathOrResource),
+                'channels' => 1,
+                'bits' => 8
+            ));
+        }
 
-	    $type = self::getFileImageType($pathOrResource);
+        $type = self::getFileImageType($pathOrResource);
 
         $sizeMethods = array(
             'svg' => array(self::class, 'getImageSize_svg')
         );
 
-	    if(isset($sizeMethods[$type]))
-	    {
-	        return ClassHelper::requireObjectInstanceOf(
+        if(isset($sizeMethods[$type]))
+        {
+            return ClassHelper::requireObjectInstanceOf(
                 ImageHelper_Size::class,
                 $sizeMethods[$type]($pathOrResource)
             );
-	    }
+        }
 
-	    $info = getimagesize($pathOrResource);
+        $info = getimagesize($pathOrResource);
 
-	    if($info !== false) {
-	        return new ImageHelper_Size($info);
-	    }
+        if($info !== false) {
+            return new ImageHelper_Size($info);
+        }
 	    
         throw new ImageHelper_Exception(
             'Error opening image file',
@@ -1444,7 +1444,7 @@ 
             ),
             self::ERROR_CANNOT_GET_IMAGE_SIZE
         );
-	}
+    }
 
     /**
      * @param string $imagePath
@@ -1454,78 +1454,78 @@ 
      * @throws XMLHelper_Exception
      * @throws JsonException
      */
-	protected static function getImageSize_svg(string $imagePath) : ImageHelper_Size
-	{
-	    $xml = XMLHelper::createSimplexml();
-	    $xml->loadFile($imagePath);
+    protected static function getImageSize_svg(string $imagePath) : ImageHelper_Size
+    {
+        $xml = XMLHelper::createSimplexml();
+        $xml->loadFile($imagePath);
 	    
-	    if($xml->hasErrors()) {
-	        throw new ImageHelper_Exception(
-	            'Error opening SVG image',
-	            sprintf(
-	                'The XML content of the image [%s] could not be parsed.',
-	                $imagePath
+        if($xml->hasErrors()) {
+            throw new ImageHelper_Exception(
+                'Error opening SVG image',
+                sprintf(
+                    'The XML content of the image [%s] could not be parsed.',
+                    $imagePath
                 ),
-	            self::ERROR_CANNOT_READ_SVG_IMAGE
+                self::ERROR_CANNOT_READ_SVG_IMAGE
             );
-	    }
+        }
 	    
-	    $data = $xml->toArray();
-	    $xml->dispose();
-	    unset($xml);
+        $data = $xml->toArray();
+        $xml->dispose();
+        unset($xml);
 	    
-	    if(!isset($data['@attributes']['viewBox'])) {
-	        throw new ImageHelper_Exception(
-	            'SVG Image is corrupted',
-	            sprintf(
-	                'The [viewBox] attribute is missing in the XML of the image at path [%s].',
-	                $imagePath
+        if(!isset($data['@attributes']['viewBox'])) {
+            throw new ImageHelper_Exception(
+                'SVG Image is corrupted',
+                sprintf(
+                    'The [viewBox] attribute is missing in the XML of the image at path [%s].',
+                    $imagePath
                 ),
-	            self::ERROR_SVG_SOURCE_VIEWBOX_MISSING
+                self::ERROR_SVG_SOURCE_VIEWBOX_MISSING
             );
-	    }
+        }
 	    
-	    $svgWidth = parseNumber($data['@attributes']['width'])->getNumber();
-	    $svgHeight = parseNumber($data['@attributes']['height'])->getNumber();
+        $svgWidth = parseNumber($data['@attributes']['width'])->getNumber();
+        $svgHeight = parseNumber($data['@attributes']['height'])->getNumber();
 	    
-	    $viewBox = str_replace(' ', ',', $data['@attributes']['viewBox']);
-	    $size = explode(',', $viewBox);
+        $viewBox = str_replace(' ', ',', $data['@attributes']['viewBox']);
+        $size = explode(',', $viewBox);
 	    
-	    if(count($size) !== 4)
-	    {
-	        throw new ImageHelper_Exception(
-	            'SVG image has an invalid viewBox attribute',
-	            sprintf(
-	               'The [viewBox] attribute does not have an expected value: [%s] in path [%s].',
-	                $viewBox,
-	                $imagePath
+        if(count($size) !== 4)
+        {
+            throw new ImageHelper_Exception(
+                'SVG image has an invalid viewBox attribute',
+                sprintf(
+                    'The [viewBox] attribute does not have an expected value: [%s] in path [%s].',
+                    $viewBox,
+                    $imagePath
                 ),
-	            self::ERROR_SVG_VIEWBOX_INVALID
+                self::ERROR_SVG_VIEWBOX_INVALID
             );
-	    }
+        }
 	    
-	    $boxWidth = (float)$size[2];
-	    $boxHeight = (float)$size[3];
+        $boxWidth = (float)$size[2];
+        $boxHeight = (float)$size[3];
 	    
-	    // calculate the x and y units of the document: 
-	    // @see http://tutorials.jenkov.com/svg/svg-viewport-view-box.html#viewbox
-	    //
-	    // The viewbox combined with the width and height of the svg
-	    // allow calculating how many pixels are in one unit of the 
-	    // width and height of the document.
+        // calculate the x and y units of the document: 
+        // @see http://tutorials.jenkov.com/svg/svg-viewport-view-box.html#viewbox
         //
-	    $xUnits = $svgWidth / $boxWidth;
-	    $yUnits = $svgHeight / $boxHeight;
+        // The viewbox combined with the width and height of the svg
+        // allow calculating how many pixels are in one unit of the 
+        // width and height of the document.
+        //
+        $xUnits = $svgWidth / $boxWidth;
+        $yUnits = $svgHeight / $boxHeight;
 	    
-	    $pxWidth = $xUnits * $svgWidth;
-	    $pxHeight = $yUnits * $svgHeight;
+        $pxWidth = $xUnits * $svgWidth;
+        $pxHeight = $yUnits * $svgHeight;
 	    
-	    return new ImageHelper_Size(array(
+        return new ImageHelper_Size(array(
             (int)$pxWidth,
             (int)$pxHeight,
-	        'bits' => 8
-	    ));
-	}
+            'bits' => 8
+        ));
+    }
 
     /**
      * Crops the image to the specified width and height, optionally
@@ -1584,26 +1584,26 @@ 
         return $image->getColorAt(0, 0);
     }
     
-   /**
-    * Calculates the image's average color value, and
-    * returns an associative array with red, green,
-    * blue and alpha keys.
-    * 
-    * @throws ImageHelper_Exception
-    * @return RGBAColor
-    */
+    /**
+     * Calculates the image's average color value, and
+     * returns an associative array with red, green,
+     * blue and alpha keys.
+     * 
+     * @throws ImageHelper_Exception
+     * @return RGBAColor
+     */
     public function calcAverageColorRGB() : RGBAColor
     {
-       return $this->calcAverageColor();
+        return $this->calcAverageColor();
     }
     
-   /**
-    * Calculates the image's average color value, and
-    * returns a hex color string (without the #).
-    * 
-    * @throws ImageHelper_Exception
-    * @return string
-    */
+    /**
+     * Calculates the image's average color value, and
+     * returns a hex color string (without the #).
+     * 
+     * @throws ImageHelper_Exception
+     * @return string
+     */
     public function calcAverageColorHex() : string
     {
         return $this->calcAverageColor()->toHEX();
@@ -1656,15 +1656,15 @@ 
             ->getValue();
     }
     
-   /**
-    * Retrieves a md5 hash of the source image file.
-    * 
-    * NOTE: Only works when the helper has been created
-    * from a file. Otherwise, an exception is thrown.
-    * 
-    * @return string
-    * @throws ImageHelper_Exception|OutputBuffering_Exception
-    */
+    /**
+     * Retrieves a md5 hash of the source image file.
+     * 
+     * NOTE: Only works when the helper has been created
+     * from a file. Otherwise, an exception is thrown.
+     * 
+     * @return string
+     * @throws ImageHelper_Exception|OutputBuffering_Exception
+     */
     public function getHash() : string
     {
         if($this->newImage === null)