Mistralys / application-utils

src/ImageHelper.php

Indentation +435 added lines, -435 removed lines

@@ -68,54 +68,54 @@ 
     
     const ERROR_UNEXPECTED_COLOR_VALUE = 513025;
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $file;
 
-   /**
-    * @var ImageHelper_Size
-    */
+    /**
+     * @var ImageHelper_Size
+     */
     protected $info;
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $type;
 
-   /**
-    * @var resource|NULL
-    */
+    /**
+     * @var resource|NULL
+     */
     protected $newImage;
 
-   /**
-    * @var resource
-    */
+    /**
+     * @var resource
+     */
     protected $sourceImage;
 
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $width;
 
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $height;
 
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $newWidth = 0;
 
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $newHeight = 0;
 
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $quality = 85;
     
     protected static $imageTypes = array(
@@ -203,17 +203,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($width, $height, $type='png')
     {
         $img = imagecreatetruecolor($width, $height);
@@ -228,18 +228,18 @@ 
         );
     }
     
-   /**
-    * Factory method: creates an image helper from an
-    * existing image resource.
-    *
-    * Note: while the resource is type independent, the
-    * type parameter is required for some methods, as well
-    * as to be able to save the image.
-    *
-    * @param resource $resource
-    * @param string $type The target image type, e.g. "jpeg", "png", etc.
-    * @return ImageHelper
-    */
+    /**
+     * Factory method: creates an image helper from an
+     * existing image resource.
+     *
+     * Note: while the resource is type independent, the
+     * type parameter is required for some methods, as well
+     * as to be able to save the image.
+     *
+     * @param resource $resource
+     * @param string $type The target image type, e.g. "jpeg", "png", etc.
+     * @return ImageHelper
+     */
     public static function createFromResource($resource, ?string $type=null)
     {
         self::requireResource($resource);
@@ -247,29 +247,29 @@ 
         return new ImageHelper(null, $resource, $type);
     }
     
-   /**
-    * Factory method: creates an image helper from an
-    * image file on disk.
-    *
-    * @param string $file
-    * @return ImageHelper
-    */
+    /**
+     * Factory method: creates an image helper from an
+     * image file on disk.
+     *
+     * @param string $file
+     * @return ImageHelper
+     */
     public static function createFromFile(string $file) : ImageHelper
     {
         return new ImageHelper($file);
     }
     
-   /**
-    * Sets a global image helper configuration value. Available
-    * configuration settings are:
-    * 
-    * <ul>
-    * <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>
-    * </ul>
-    * 
-    * @param string $name
-    * @param mixed $value
-    */
+    /**
+     * Sets a global image helper configuration value. Available
+     * configuration settings are:
+     * 
+     * <ul>
+     * <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>
+     * </ul>
+     * 
+     * @param string $name
+     * @param mixed $value
+     */
     public static function setConfig($name, $value)
     {
         if(isset(self::$config[$name])) {
@@ -277,22 +277,22 @@ 
         }
     }
     
-   /**
-    * Shorthand for setting the automatic memory adjustment
-    * global configuration setting.
-    * 
-    * @param bool $enabled
-    */
+    /**
+     * Shorthand for setting the automatic memory adjustment
+     * global configuration setting.
+     * 
+     * @param bool $enabled
+     */
     public static function setAutoMemoryAdjustment($enabled=true)
     {
         self::setConfig('auto-memory-adjustment', $enabled);
     }
     
-   /**
-    * Duplicates an image resource.
-    * @param resource $img
-    * @return resource
-    */
+    /**
+     * Duplicates an image resource.
+     * @param resource $img
+     * @return resource
+     */
     protected function duplicateImage($img)
     {
         self::requireResource($img);
@@ -304,12 +304,12 @@ 
         return $duplicate;
     }
     
-   /**
-    * Duplicates the current state of the image into a new
-    * image helper instance.
-    * 
-    * @return ImageHelper
-    */
+    /**
+     * Duplicates the current state of the image into a new
+     * image helper instance.
+     * 
+     * @return ImageHelper
+     */
     public function duplicate()
     {
         return ImageHelper::createFromResource($this->duplicateImage($this->newImage));
@@ -497,13 +497,13 @@ 
         ));
     }
     
-   /**
-    * Resamples the image to a new width, maintaining
-    * aspect ratio.
-    * 
-    * @param int $width
-    * @return ImageHelper
-    */
+    /**
+     * Resamples the image to a new width, maintaining
+     * aspect ratio.
+     * 
+     * @param int $width
+     * @return ImageHelper
+     */
     public function resampleByWidth(int $width) : ImageHelper
     {
         $size = $this->getSizeByWidth($width);
@@ -513,12 +513,12 @@ 
         return $this;
     }
 
-   /**
-    * Resamples the image by height, and creates a new image file on disk.
-    * 
-    * @param int $height
-    * @return ImageHelper
-    */
+    /**
+     * Resamples the image by height, and creates a new image file on disk.
+     * 
+     * @param int $height
+     * @return ImageHelper
+     */
     public function resampleByHeight($height) : ImageHelper
     {
         $size = $this->getSizeByHeight($height);
@@ -526,13 +526,13 @@ 
         return $this->resampleImage($size->getWidth(), $size->getHeight());
     }
 
-   /**
-    * Resamples the image without keeping the aspect ratio.
-    * 
-    * @param int $width
-    * @param int $height
-    * @return ImageHelper
-    */
+    /**
+     * Resamples the image without keeping the aspect ratio.
+     * 
+     * @param int $width
+     * @param int $height
+     * @return ImageHelper
+     */
     public function resample(?int $width = null, ?int $height = null) : ImageHelper
     {
         if($this->isVector()) {
@@ -597,12 +597,12 @@ 
     
     protected $alpha = false;
 
-   /**
-    * Configures the specified image resource to make it alpha compatible.
-    * 
-    * @param resource $canvas
-    * @param bool $fill Whether to fill the whole canvas with the transparency
-    */
+    /**
+     * Configures the specified image resource to make it alpha compatible.
+     * 
+     * @param resource $canvas
+     * @param bool $fill Whether to fill the whole canvas with the transparency
+     */
     public static function addAlphaSupport($canvas, $fill=true)
     {
         self::requireResource($canvas);
@@ -717,12 +717,12 @@ 
         $this->quality = $quality * 1;
     }
 
-   /**
-    * 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']) {
@@ -762,27 +762,27 @@ 
         return false;
     }
 
-   /**
-    * Stretches the image to the specified dimensions.
-    * 
-    * @param int $width
-    * @param int $height
-    * @return ImageHelper
-    */
+    /**
+     * Stretches the image to the specified dimensions.
+     * 
+     * @param int $width
+     * @param int $height
+     * @return ImageHelper
+     */
     public function stretch(int $width, int $height) : ImageHelper
     {
         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()) {
@@ -851,13 +851,13 @@ 
         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 
-    */
+    /**
+     * 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 
+     */
     public static function displayImageStream($resource, $imageType, $quality=-1)
     {
         $imageType = strtolower($imageType);
@@ -923,31 +923,31 @@ 
         readfile($imageFile);
     }
     
-   /**
-    * Displays the current image.
-    */
+    /**
+     * Displays the current image.
+     */
     public function display()
     {
         $this->displayImageStream($this->newImage, $this->getType(), $this->resolveQuality());
     }
     
-   /**
-    * Trims the current loaded image.
-    * 
-    * @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.
-    */
+    /**
+     * Trims the current loaded image.
+     * 
+     * @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)
     {
         return $this->trimImage($this->newImage, $color);
     }
     
-   /**
-    * Retrieves a color definition by its index.
-    * 
-    * @param resource $img A valid image resource.
-    * @param int $colorIndex The color index, as returned by imagecolorat for example.
-    * @return array An array with red, green, blue and alpha keys.
-    */
+    /**
+     * Retrieves a color definition by its index.
+     * 
+     * @param resource $img A valid image resource.
+     * @param int $colorIndex The color index, as returned by imagecolorat for example.
+     * @return array An array with red, green, blue and alpha keys.
+     */
     public function getIndexedColors($img, int $colorIndex) : array
     {
         $color = imagecolorsforindex($img, $colorIndex);
@@ -965,14 +965,14 @@ 
         );
     }
         
-   /**
-    * Trims the specified image resource by removing the specified color.
-    * Also works with transparency.
-    * 
-    * @param resource $img
-    * @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
-    */
+    /**
+     * Trims the specified image resource by removing the specified color.
+     * Also works with transparency.
+     * 
+     * @param resource $img
+     * @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
     {
         if($this->isVector()) {
@@ -1060,12 +1060,12 @@ 
         return $this;
     }
     
-   /**
-    * Sets the new image after a transformation operation:
-    * automatically adjusts the new size information.
-    * 
-    * @param resource $image
-    */
+    /**
+     * Sets the new image after a transformation operation:
+     * automatically adjusts the new size information.
+     * 
+     * @param resource $image
+     */
     protected function setNewImage($image)
     {
         self::requireResource($image);
@@ -1075,12 +1075,12 @@ 
         $this->newHeight= imagesy($image);
     }
     
-   /**
-    * Requires the subject to be a resource.
-    * 
-    * @param resource $subject
-    * @throws ImageHelper_Exception
-    */
+    /**
+     * Requires the subject to be a resource.
+     * 
+     * @param resource $subject
+     * @throws ImageHelper_Exception
+     */
     protected static function requireResource($subject)
     {
         if(is_resource($subject)) {
@@ -1097,14 +1097,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
+     */
     protected function createNewImage(int $width, int $height)
     {
         $img = imagecreatetruecolor($width, $height);
@@ -1123,54 +1123,54 @@ 
         return $img;
     }
     
-   /**
-    * Whether the two specified colors are the same.
-    * 
-    * @param array $a
-    * @param array $b
-    * @return boolean
-    */
-	protected function colorsMatch($a, $b) : bool
-	{
-		$parts = array('red', 'green', 'blue');
-		foreach($parts as $part) {
-			if($a[$part] != $b[$part]) {
-				return false;
-			}
-		} 
+    /**
+     * Whether the two specified colors are the same.
+     * 
+     * @param array $a
+     * @param array $b
+     * @return boolean
+     */
+    protected function colorsMatch($a, $b) : bool
+    {
+        $parts = array('red', 'green', 'blue');
+        foreach($parts as $part) {
+            if($a[$part] != $b[$part]) {
+                return false;
+            }
+        } 
 		
-		return true;
-	}
+        return true;
+    }
 	
-	public function fillWhite($x=0, $y=0)
-	{
-	    $this->addRGBColor('white', 255, 255, 255);
+    public function fillWhite($x=0, $y=0)
+    {
+        $this->addRGBColor('white', 255, 255, 255);
         return $this->fill('white', $x, $y);
-	}
+    }
 	
-	public function fillTransparent() : ImageHelper
-	{
+    public function fillTransparent() : ImageHelper
+    {
         $this->enableAlpha();
 	    
-	    self::fillImageTransparent($this->newImage);
+        self::fillImageTransparent($this->newImage);
 	    
-	    return $this;
-	}
+        return $this;
+    }
 	
-	public static function fillImageTransparent($resource)
-	{
-	    self::requireResource($resource);
+    public static function fillImageTransparent($resource)
+    {
+        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);
+    }
 	
-	public function fill($colorName, $x=0, $y=0)
-	{
-	    imagefill($this->newImage, $x, $y, $this->colors[$colorName]);
-	    return $this;
-	}
+    public function fill($colorName, $x=0, $y=0)
+    {
+        imagefill($this->newImage, $x, $y, $this->colors[$colorName]);
+        return $this;
+    }
 	
     protected $colors = array();
 
@@ -1191,9 +1191,9 @@ 
         return $this;
     }
     
-   /**
-    * @return resource
-    */
+    /**
+     * @return resource
+     */
     public function getImage()
     {
         return $this->newImage;
@@ -1211,26 +1211,26 @@ 
         return $this;
     }
     
-   /**
-    * Retrieves the size of the image.
-    * 
-    * @return ImageHelper_Size
-    * @throws ImageHelper_Exception
-    * @see ImageHelper::ERROR_CANNOT_GET_IMAGE_SIZE
-    */
-	public function getSize() : ImageHelper_Size
+    /**
+     * Retrieves the size of the image.
+     * 
+     * @return ImageHelper_Size
+     * @throws ImageHelper_Exception
+     * @see ImageHelper::ERROR_CANNOT_GET_IMAGE_SIZE
+     */
+    public function getSize() : ImageHelper_Size
     {
-	    return self::getImageSize($this->newImage);
+        return self::getImageSize($this->newImage);
     }
     
     protected $TTFFile;
     
-   /**
-    * Sets the TTF font file to use for text operations.
-    * 
-    * @param string $filePath
-    * @return ImageHelper
-    */
+    /**
+     * Sets the TTF font file to use for text operations.
+     * 
+     * @param string $filePath
+     * @return ImageHelper
+     */
     public function setFontTTF($filePath)
     {
         $this->TTFFile = $filePath;
@@ -1302,63 +1302,63 @@ 
             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    
         );
     }
     
-   /**
-	 * Retrieves the size of an image file on disk, or
-	 * an existing image resource.
-	 *
-	 * <pre>
-	 * array(
-	 *     0: (width),
-	 *     1: (height),
-	 *     "channels": the amount of channels
-	 *     "bits": bits per channel
+    /**
+     * Retrieves the size of an image file on disk, or
+     * an existing image resource.
+     *
+     * <pre>
+     * array(
+     *     0: (width),
+     *     1: (height),
+     *     "channels": the amount of channels
+     *     "bits": bits per channel
      * )     
-	 * </pre>
-	 *
-	 * @param string|resource $pathOrResource
-	 * @return ImageHelper_Size Size object, can also be accessed like the traditional array from getimagesize
-	 * @see ImageHelper_Size
-	 * @throws ImageHelper_Exception
-	 * @see ImageHelper::ERROR_CANNOT_GET_IMAGE_SIZE
-	 * @see ImageHelper::ERROR_CANNOT_READ_SVG_IMAGE
-	 * @see ImageHelper::ERROR_SVG_SOURCE_VIEWBOX_MISSING
-	 * @see ImageHelper::ERROR_SVG_VIEWBOX_INVALID
-	 */
-	public static function getImageSize($pathOrResource) : ImageHelper_Size
-	{
-	    if(is_resource($pathOrResource)) 
-	    {
-	        return new ImageHelper_Size(array(
-	            'width' => imagesx($pathOrResource),
-	            'height' => imagesy($pathOrResource),
-	            'channels' => 1,
-	            'bits' => 8
-	        ));
-	    }
+     * </pre>
+     *
+     * @param string|resource $pathOrResource
+     * @return ImageHelper_Size Size object, can also be accessed like the traditional array from getimagesize
+     * @see ImageHelper_Size
+     * @throws ImageHelper_Exception
+     * @see ImageHelper::ERROR_CANNOT_GET_IMAGE_SIZE
+     * @see ImageHelper::ERROR_CANNOT_READ_SVG_IMAGE
+     * @see ImageHelper::ERROR_SVG_SOURCE_VIEWBOX_MISSING
+     * @see ImageHelper::ERROR_SVG_VIEWBOX_INVALID
+     */
+    public static function getImageSize($pathOrResource) : ImageHelper_Size
+    {
+        if(is_resource($pathOrResource)) 
+        {
+            return new ImageHelper_Size(array(
+                'width' => imagesx($pathOrResource),
+                'height' => imagesy($pathOrResource),
+                'channels' => 1,
+                'bits' => 8
+            ));
+        }
 	    
-	    $type = self::getFileImageType($pathOrResource);
+        $type = self::getFileImageType($pathOrResource);
 	    
-	    $info = false;
-	    $method = 'getImageSize_'.$type;
-	    if(method_exists(__CLASS__, $method)) 
-	    {
-	        $info = call_user_func(array(__CLASS__, $method), $pathOrResource);
-	    } 
-	    else 
-	    {
-	        $info = getimagesize($pathOrResource);
-	    }
+        $info = false;
+        $method = 'getImageSize_'.$type;
+        if(method_exists(__CLASS__, $method)) 
+        {
+            $info = call_user_func(array(__CLASS__, $method), $pathOrResource);
+        } 
+        else 
+        {
+            $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',
@@ -1368,98 +1368,98 @@ 
             ),
             self::ERROR_CANNOT_GET_IMAGE_SIZE
         );
-	}
+    }
 	
-   /**
-    * @param string $imagePath
-    * @throws ImageHelper_Exception
-    * @return array
-    * 
-    * @todo This should return a ImageHelper_Size instance.
-    */
-	protected static function getImageSize_svg(string $imagePath) : array
-	{
-	    $xml = XMLHelper::createSimplexml();
-	    $xml->loadFile($imagePath);
+    /**
+     * @param string $imagePath
+     * @throws ImageHelper_Exception
+     * @return array
+     * 
+     * @todo This should return a ImageHelper_Size instance.
+     */
+    protected static function getImageSize_svg(string $imagePath) : array
+    {
+        $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']) || !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']) || !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 = $size[2];
-	    $boxHeight = $size[3];
+        $boxWidth = $size[2];
+        $boxHeight = $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 heigt 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
+        //
+        // The viewbox combined with the width and heigt 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;
+        $xUnits = $svgWidth / $boxWidth;
+        $yUnits = $svgHeight / $boxHeight;
 	    
-	    $pxWidth = $xUnits * $svgWidth;
-	    $pxHeight = $yUnits * $svgHeight;
+        $pxWidth = $xUnits * $svgWidth;
+        $pxHeight = $yUnits * $svgHeight;
 	    
-	    return array(
-	        $pxWidth,
-	        $pxHeight,
-	        'bits' => 8
-	    );
-	}
+        return array(
+            $pxWidth,
+            $pxHeight,
+            'bits' => 8
+        );
+    }
 	
-	/**
-    * Crops the image to the specified width and height, optionally
-    * specifying the origin position to crop from.
-    * 
-    * @param integer $width
-    * @param integer $height
-    * @param integer $x
-    * @param integer $y
-    * @return ImageHelper
-    */
+    /**
+     * Crops the image to the specified width and height, optionally
+     * specifying the origin position to crop from.
+     * 
+     * @param integer $width
+     * @param integer $height
+     * @param integer $x
+     * @param integer $y
+     * @return ImageHelper
+     */
     public function crop(int $width, int $height, int $x=0, int $y=0) : ImageHelper
     {
         $new = $this->createNewImage($width, $height);
@@ -1481,22 +1481,22 @@ 
         return $this->newHeight;
     }
 
-   /**
-    * Calculates the average color value used in 
-    * the image. Returns an associative array
-    * with the red, green, blue and alpha components,
-    * or a HEX color string depending on the selected
-    * format.
-    * 
-    * NOTE: Use the calcAverageColorXXX methods for
-    * strict return types. 
-    * 
-    * @param int $format The format in which to return the color value.
-    * @return array|string
-    * 
-    * @see ImageHelper::calcAverageColorRGB()
-    * @see ImageHelper::calcAverageColorHEX()
-    */
+    /**
+     * Calculates the average color value used in 
+     * the image. Returns an associative array
+     * with the red, green, blue and alpha components,
+     * or a HEX color string depending on the selected
+     * format.
+     * 
+     * NOTE: Use the calcAverageColorXXX methods for
+     * strict return types. 
+     * 
+     * @param int $format The format in which to return the color value.
+     * @return array|string
+     * 
+     * @see ImageHelper::calcAverageColorRGB()
+     * @see ImageHelper::calcAverageColorHEX()
+     */
     public function calcAverageColor(int $format=self::COLORFORMAT_RGB)
     {
         $image = $this->duplicate();
@@ -1505,35 +1505,35 @@ 
         return $image->getColorAt(0, 0, $format);
     }
     
-   /**
-    * Calculates the image's average color value, and
-    * returns an associative array with red, green,
-    * blue and alpha keys.
-    * 
-    * @throws ImageHelper_Exception
-    * @return array
-    */
+    /**
+     * Calculates the image's average color value, and
+     * returns an associative array with red, green,
+     * blue and alpha keys.
+     * 
+     * @throws ImageHelper_Exception
+     * @return array
+     */
     public function calcAverageColorRGB() : array
     {
-       $result = $this->calcAverageColor(self::COLORFORMAT_RGB);
-       if(is_array($result)) {
-           return $result;
-       }
+        $result = $this->calcAverageColor(self::COLORFORMAT_RGB);
+        if(is_array($result)) {
+            return $result;
+        }
        
-       throw new ImageHelper_Exception(
-           'Unexpected color value',
-           sprintf('Expected an array, got [%s].', gettype($result)),
-           self::ERROR_UNEXPECTED_COLOR_VALUE
-       );
-    }
-    
-   /**
-    * Calculates the image's average color value, and
-    * returns a hex color string (without the #).
-    * 
-    * @throws ImageHelper_Exception
-    * @return string
-    */
+        throw new ImageHelper_Exception(
+            'Unexpected color value',
+            sprintf('Expected an array, got [%s].', gettype($result)),
+            self::ERROR_UNEXPECTED_COLOR_VALUE
+        );
+    }
+    
+    /**
+     * Calculates the image's average color value, and
+     * returns a hex color string (without the #).
+     * 
+     * @throws ImageHelper_Exception
+     * @return string
+     */
     public function calcAverageColorHex() : string
     {
         $result = $this->calcAverageColor(self::COLORFORMAT_HEX);
@@ -1562,18 +1562,18 @@ 
     
     const COLORFORMAT_HEX = 2;
     
-   /**
-    * Retrieves the color value at the specified pixel
-    * coordinates in the image.
-    * 
-    * @param int $x
-    * @param int $y
-    * @param int $format The format in which to return the color value.
-    * @return array|string
-    * 
-    * @see ImageHelper::COLORFORMAT_RGB
-    * @see ImageHelper::COLORFORMAT_HEX
-    */
+    /**
+     * Retrieves the color value at the specified pixel
+     * coordinates in the image.
+     * 
+     * @param int $x
+     * @param int $y
+     * @param int $format The format in which to return the color value.
+     * @return array|string
+     * 
+     * @see ImageHelper::COLORFORMAT_RGB
+     * @see ImageHelper::COLORFORMAT_HEX
+     */
     public function getColorAt(int $x, int $y, int $format=self::COLORFORMAT_RGB)
     {
         if($x > $this->getWidth() || $y > $this->getHeight()) 
@@ -1601,21 +1601,21 @@ 
         return $rgb;
     }
     
-   /**
-    * Converts an RGB value to its luminance equivalent.
-    * 
-    * @param array $rgb
-    * @return integer Integer, from 0 to 255 (0=black, 255=white)
-    */
+    /**
+     * Converts an RGB value to its luminance equivalent.
+     * 
+     * @param array $rgb
+     * @return integer Integer, from 0 to 255 (0=black, 255=white)
+     */
     public static function rgb2luma(array $rgb) : int
     {
         return (int)floor((($rgb['red']*2)+$rgb['blue']+($rgb['green']*3))/6);
     }
     
-   /**
-    * Retrieves the brightness of the image, in percent.
-    * @return number
-    */
+    /**
+     * Retrieves the brightness of the image, in percent.
+     * @return number
+     */
     public function getBrightness()
     {
         $luma = self::rgb2luma($this->calcAverageColorRGB());
@@ -1623,15 +1623,15 @@ 
         return $percent;
     }
     
-   /**
-    * Retrieves an 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
-    */
+    /**
+     * Retrieves an 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
+     */
     public function getHash()
     {
         ob_start();

src/Traits/Optionable.php

Indentation +100 added lines, -100 removed lines

@@ -26,18 +26,18 @@ 
  */
 trait Traits_Optionable
 {
-   /**
-    * @var array
-    */
+    /**
+     * @var array
+     */
     protected $options;
     
-   /**
-    * Sets an option to the specified value. This can be any
-    * kind of variable type, including objects, as needed.
-    * 
-    * @param string $name
-    * @param mixed $value
-    */
+    /**
+     * Sets an option to the specified value. This can be any
+     * kind of variable type, including objects, as needed.
+     * 
+     * @param string $name
+     * @param mixed $value
+     */
     public function setOption(string $name, $value)
     {
         if(!isset($this->options)) {
@@ -48,12 +48,12 @@ 
         return $this;
     }
     
-   /**
-    * Sets a collection of options at once, from an
-    * associative array.
-    * 
-    * @param array $options
-    */
+    /**
+     * Sets a collection of options at once, from an
+     * associative array.
+     * 
+     * @param array $options
+     */
     public function setOptions(array $options)
     {
         foreach($options as $name => $value) {
@@ -63,16 +63,16 @@ 
         return $this;
     }
     
-   /**
-    * Retrieves an option's value.
-    * 
-    * NOTE: Use the specialized type getters to ensure an option
-    * contains the expected type (for ex. getArrayOption()). 
-    * 
-    * @param string $name
-    * @param mixed $default The default value to return if the option does not exist.
-    * @return mixed
-    */
+    /**
+     * Retrieves an option's value.
+     * 
+     * NOTE: Use the specialized type getters to ensure an option
+     * contains the expected type (for ex. getArrayOption()). 
+     * 
+     * @param string $name
+     * @param mixed $default The default value to return if the option does not exist.
+     * @return mixed
+     */
     public function getOption(string $name, $default=null)
     {
         if(!isset($this->options)) {
@@ -86,16 +86,16 @@ 
         return $default;
     }
     
-   /**
-    * Enforces that the option value is a string. Numbers are converted
-    * to string, strings are passed through, and all other types will 
-    * return the default value. The default value is also returned if
-    * the string is empty.
-    * 
-    * @param string $name
-    * @param string $default Used if the option does not exist, is invalid, or empty.
-    * @return string
-    */
+    /**
+     * Enforces that the option value is a string. Numbers are converted
+     * to string, strings are passed through, and all other types will 
+     * return the default value. The default value is also returned if
+     * the string is empty.
+     * 
+     * @param string $name
+     * @param string $default Used if the option does not exist, is invalid, or empty.
+     * @return string
+     */
     public function getStringOption(string $name, string $default='') : string
     {
         $value = $this->getOption($name, false);
@@ -107,15 +107,15 @@ 
         return $default;
     }
     
-   /**
-    * Treats the option value as a boolean value: will return
-    * true if the value actually is a boolean true.
-    * 
-    * NOTE: boolean string representations are not accepted.
-    * 
-    * @param string $name
-    * @return bool
-    */
+    /**
+     * Treats the option value as a boolean value: will return
+     * true if the value actually is a boolean true.
+     * 
+     * NOTE: boolean string representations are not accepted.
+     * 
+     * @param string $name
+     * @return bool
+     */
     public function getBoolOption(string $name, bool $default=false) : bool
     {
         if($this->getOption($name) === true) {
@@ -125,15 +125,15 @@ 
         return $default;
     }
     
-   /**
-    * Treats the option value as an integer value: will return
-    * valid integer values (also from integer strings), or the
-    * default value otherwise.
-    * 
-    * @param string $name
-    * @param int $default
-    * @return int
-    */
+    /**
+     * Treats the option value as an integer value: will return
+     * valid integer values (also from integer strings), or the
+     * default value otherwise.
+     * 
+     * @param string $name
+     * @param int $default
+     * @return int
+     */
     public function getIntOption(string $name, int $default=0) : int
     {
         $value = $this->getOption($name);
@@ -144,14 +144,14 @@ 
         return $default;
     }
     
-   /**
-    * Treats an option as an array, and returns its value
-    * only if it contains an array - otherwise, an empty
-    * array is returned.
-    * 
-    * @param string $name
-    * @return array
-    */
+    /**
+     * Treats an option as an array, and returns its value
+     * only if it contains an array - otherwise, an empty
+     * array is returned.
+     * 
+     * @param string $name
+     * @return array
+     */
     public function getArrayOption(string $name) : array
     {
         $val = $this->getOption($name);
@@ -162,13 +162,13 @@ 
         return array();
     }
     
-   /**
-    * Checks whether the specified option exists - even
-    * if it has a NULL value.
-    * 
-    * @param string $name
-    * @return bool
-    */
+    /**
+     * Checks whether the specified option exists - even
+     * if it has a NULL value.
+     * 
+     * @param string $name
+     * @return bool
+     */
     public function hasOption(string $name) : bool
     {
         if(!isset($this->options)) {
@@ -178,10 +178,10 @@ 
         return array_key_exists($name, $this->options);
     }
     
-   /**
-    * Returns all options in one associative array.
-    * @return array
-    */
+    /**
+     * Returns all options in one associative array.
+     * @return array
+     */
     public function getOptions() : array
     {
         if(!isset($this->options)) {
@@ -191,24 +191,24 @@ 
         return $this->options;
     }
     
-   /**
-    * Checks whether the option's value is the one specified.
-    * 
-    * @param string $name
-    * @param mixed $value
-    * @return bool
-    */
+    /**
+     * Checks whether the option's value is the one specified.
+     * 
+     * @param string $name
+     * @param mixed $value
+     * @return bool
+     */
     public function isOption(string $name, $value) : bool
     {
         return $this->getOption($name) === $value;
     }
     
-   /**
-    * Retrieves the default available options as an 
-    * associative array with option name => value pairs.
-    * 
-    * @return array
-    */
+    /**
+     * Retrieves the default available options as an 
+     * associative array with option name => value pairs.
+     * 
+     * @return array
+     */
     abstract public function getDefaultOptions() : array;
 }
 
@@ -226,24 +226,24 @@ 
  */
 interface Interface_Optionable
 {
-   /**
-    * @param string $name
-    * @param mixed $value
-    * @return Interface_Optionable
-    */
+    /**
+     * @param string $name
+     * @param mixed $value
+     * @return Interface_Optionable
+     */
     function setOption(string $name, $value);
     
-   /**
-    * @param string $name
-    * @param mixed $default
-    * @return Interface_Optionable
-    */
+    /**
+     * @param string $name
+     * @param mixed $default
+     * @return Interface_Optionable
+     */
     function getOption(string $name, $default=null);
     
-   /**
-    * @param array $options
-    * @return Interface_Optionable    
-    */
+    /**
+     * @param array $options
+     * @return Interface_Optionable    
+     */
     function setOptions(array $options);
     function getOptions() : array;
     function isOption(string $name, $value) : bool;

src/ConvertHelper.php

Indentation +453 added lines, -453 removed lines

@@ -162,41 +162,41 @@ 
         return implode(', ', $tokens) . ' ' . t('and') . ' ' . $last;
     }
 
-   /**
-    * Converts a timestamp into an easily understandable
-    * format, e.g. "2 hours", "1 day", "3 months"
-    *
-    * If you set the date to parameter, the difference
-    * will be calculated between the two dates and not
-    * the current time.
-    *
-    * @param integer|\DateTime $datefrom
-    * @param integer|\DateTime $dateto
-    * @return string
-    */
+    /**
+     * Converts a timestamp into an easily understandable
+     * format, e.g. "2 hours", "1 day", "3 months"
+     *
+     * If you set the date to parameter, the difference
+     * will be calculated between the two dates and not
+     * the current time.
+     *
+     * @param integer|\DateTime $datefrom
+     * @param integer|\DateTime $dateto
+     * @return string
+     */
     public static function duration2string($datefrom, $dateto = -1) : string
     {
-         $converter = new ConvertHelper_DurationConverter();
+            $converter = new ConvertHelper_DurationConverter();
          
-         if($datefrom instanceof \DateTime)
-         {
-             $converter->setDateFrom($datefrom);
-         }
-         else
-         {
-             $converter->setDateFrom(self::timestamp2date($datefrom)); 
-         }
+            if($datefrom instanceof \DateTime)
+            {
+                $converter->setDateFrom($datefrom);
+            }
+            else
+            {
+                $converter->setDateFrom(self::timestamp2date($datefrom)); 
+            }
 
-         if($dateto instanceof \DateTime)
-         {
-             $converter->setDateTo($dateto);
-         }
-         else if($dateto > 0)
-         {
-             $converter->setDateTo(self::timestamp2date($dateto));
-         }
+            if($dateto instanceof \DateTime)
+            {
+                $converter->setDateTo($dateto);
+            }
+            else if($dateto > 0)
+            {
+                $converter->setDateTo(self::timestamp2date($dateto));
+            }
 
-         return $converter->convert();
+            return $converter->convert();
     }
 
     /**
@@ -235,44 +235,44 @@ 
         return $geshi->parse_code();
     }
     
-   /**
-    * Converts a number of bytes to a human readable form,
-    * e.g. xx Kb / xx Mb / xx Gb
-    *
-    * @param int $bytes The amount of bytes to convert.
-    * @param int $precision The amount of decimals
-    * @param int $base The base to calculate with: Base 10 is default (=1000 Bytes in a KB), Base 2 is mainly used for Windows memory (=1024 Bytes in a KB).
-    * @return string
-    * 
-    * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions
-    */
+    /**
+     * Converts a number of bytes to a human readable form,
+     * e.g. xx Kb / xx Mb / xx Gb
+     *
+     * @param int $bytes The amount of bytes to convert.
+     * @param int $precision The amount of decimals
+     * @param int $base The base to calculate with: Base 10 is default (=1000 Bytes in a KB), Base 2 is mainly used for Windows memory (=1024 Bytes in a KB).
+     * @return string
+     * 
+     * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions
+     */
     public static function bytes2readable(int $bytes, int $precision = 1, int $base = ConvertHelper_StorageSizeEnum::BASE_10) : string
     {
         return self::parseBytes($bytes)->toString($precision, $base);
     }
     
-   /**
-    * Parses a number of bytes, and creates a converter instance which
-    * allows doing common operations with it.
-    * 
-    * @param int $bytes
-    * @return ConvertHelper_ByteConverter
-    */
+    /**
+     * Parses a number of bytes, and creates a converter instance which
+     * allows doing common operations with it.
+     * 
+     * @param int $bytes
+     * @return ConvertHelper_ByteConverter
+     */
     public static function parseBytes(int $bytes) : ConvertHelper_ByteConverter
     {
         return new ConvertHelper_ByteConverter($bytes);
     }
 
-   /**
-    * Cuts a text to the specified length if it is longer than the
-    * target length. Appends a text to signify it has been cut at 
-    * the end of the string.
-    * 
-    * @param string $text
-    * @param int $targetLength
-    * @param string $append
-    * @return string
-    */
+    /**
+     * Cuts a text to the specified length if it is longer than the
+     * target length. Appends a text to signify it has been cut at 
+     * the end of the string.
+     * 
+     * @param string $text
+     * @param int $targetLength
+     * @param string $append
+     * @return string
+     */
     public static function text_cut(string $text, int $targetLength, string $append = '...') : string
     {
         $length = mb_strlen($text);
@@ -296,14 +296,14 @@ 
         return $info->toString();
     }
     
-   /**
-    * Pretty print_r.
-    * 
-    * @param mixed $var The variable to dump.
-    * @param bool $return Whether to return the dumped code.
-    * @param bool $html Whether to style the dump as HTML.
-    * @return string
-    */
+    /**
+     * Pretty print_r.
+     * 
+     * @param mixed $var The variable to dump.
+     * @param bool $return Whether to return the dumped code.
+     * @param bool $html Whether to style the dump as HTML.
+     * @return string
+     */
     public static function print_r($var, bool $return=false, bool $html=true) : string
     {
         $result = parseVariable($var)->enableType()->toString();
@@ -333,15 +333,15 @@ 
         'no' => false
     );
 
-   /**
-    * Converts a string, number or boolean value to a boolean value.
-    * 
-    * @param string|number|bool $string
-    * @throws ConvertHelper_Exception
-    * @return bool
-    * 
-    * @see ConvertHelper::ERROR_INVALID_BOOLEAN_STRING
-    */
+    /**
+     * Converts a string, number or boolean value to a boolean value.
+     * 
+     * @param string|number|bool $string
+     * @throws ConvertHelper_Exception
+     * @return bool
+     * 
+     * @see ConvertHelper::ERROR_INVALID_BOOLEAN_STRING
+     */
     public static function string2bool($string) : bool
     {
         if($string === '' || $string === null || !is_scalar($string)) 
@@ -369,27 +369,27 @@ 
         );
     }
     
-   /**
-    * Whether the specified string is a boolean string or boolean value.
-    * Alias for {@link ConvertHelper::isBoolean()}.
-    * 
-    * @param mixed $string
-    * @return bool
-    * @deprecated
-    * @see ConvertHelper::isBoolean()
-    */
+    /**
+     * Whether the specified string is a boolean string or boolean value.
+     * Alias for {@link ConvertHelper::isBoolean()}.
+     * 
+     * @param mixed $string
+     * @return bool
+     * @deprecated
+     * @see ConvertHelper::isBoolean()
+     */
     public static function isBooleanString($string) : bool
     {
         return self::isBoolean($string);
     }
 
-   /**
-    * Alias for the {@\AppUtils\XMLHelper::string2xml()} method.
-    * 
-    * @param string $text
-    * @return string
-    * @deprecated
-    */
+    /**
+     * Alias for the {@\AppUtils\XMLHelper::string2xml()} method.
+     * 
+     * @param string $text
+     * @return string
+     * @deprecated
+     */
     public static function text_makeXMLCompliant($text)
     {
         return XMLHelper::string2xml($text);
@@ -491,13 +491,13 @@ 
         return $translit->convert($string);
     }
     
-   /**
-    * Retrieves the HEX character codes for all control
-    * characters that the {@link stripControlCharacters()} 
-    * method will remove.
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves the HEX character codes for all control
+     * characters that the {@link stripControlCharacters()} 
+     * method will remove.
+     * 
+     * @return string[]
+     */
     public static function getControlCharactersAsHex()
     {
         $hexAlphabet = array('0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F');
@@ -533,13 +533,13 @@ 
         return $stack;
     }
     
-   /**
-    * Retrieves an array of all control characters that
-    * the {@link stripControlCharacters()} method will 
-    * remove, as the actual UTF-8 characters.
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves an array of all control characters that
+     * the {@link stripControlCharacters()} method will 
+     * remove, as the actual UTF-8 characters.
+     * 
+     * @return string[]
+     */
     public static function getControlCharactersAsUTF8()
     {
         $chars = self::getControlCharactersAsHex();
@@ -552,12 +552,12 @@ 
         return $result;
     }
     
-   /**
-    * Retrieves all control characters as JSON encoded
-    * characters, e.g. "\u200b".
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves all control characters as JSON encoded
+     * characters, e.g. "\u200b".
+     * 
+     * @return string[]
+     */
     public static function getControlCharactersAsJSON()
     {
         $chars = self::getControlCharactersAsHex();
@@ -614,20 +614,20 @@ 
         return preg_replace(self::$controlCharsRegex, '', $string);
     }
 
-   /**
-    * Converts a unicode character to the PHPO notation.
-    * 
-    * Example:
-    * 
-    * <pre>unicodeChar2php('"\u0000"')</pre>
-    * 
-    * Returns
-    * 
-    * <pre>\x0</pre>
-    * 
-    * @param string $unicodeChar
-    * @return string
-    */
+    /**
+     * Converts a unicode character to the PHPO notation.
+     * 
+     * Example:
+     * 
+     * <pre>unicodeChar2php('"\u0000"')</pre>
+     * 
+     * Returns
+     * 
+     * <pre>\x0</pre>
+     * 
+     * @param string $unicodeChar
+     * @return string
+     */
     public static function unicodeChar2php($unicodeChar) 
     {
         $unicodeChar = json_decode($unicodeChar);
@@ -750,25 +750,25 @@ 
         return 'false';
     }
     
-   /**
-    * Converts an associative array with attribute name > value pairs
-    * to an attribute string that can be used in an HTML tag. Empty 
-    * attribute values are ignored.
-    * 
-    * Example:
-    * 
-    * array2attributeString(array(
-    *     'id' => 45,
-    *     'href' => 'http://www.mistralys.com'
-    * ));
-    * 
-    * Result:
-    * 
-    * id="45" href="http://www.mistralys.com"
-    * 
-    * @param array $array
-    * @return string
-    */
+    /**
+     * Converts an associative array with attribute name > value pairs
+     * to an attribute string that can be used in an HTML tag. Empty 
+     * attribute values are ignored.
+     * 
+     * Example:
+     * 
+     * array2attributeString(array(
+     *     'id' => 45,
+     *     'href' => 'http://www.mistralys.com'
+     * ));
+     * 
+     * Result:
+     * 
+     * id="45" href="http://www.mistralys.com"
+     * 
+     * @param array $array
+     * @return string
+     */
     public static function array2attributeString($array)
     {
         $tokens = array();
@@ -787,14 +787,14 @@ 
         return ' '.implode(' ', $tokens);
     }
     
-   /**
-    * Converts a string so it can safely be used in a javascript
-    * statement in an HTML tag: uses single quotes around the string
-    * and encodes all special characters as needed.
-    * 
-    * @param string $string
-    * @return string
-    */
+    /**
+     * Converts a string so it can safely be used in a javascript
+     * statement in an HTML tag: uses single quotes around the string
+     * and encodes all special characters as needed.
+     * 
+     * @param string $string
+     * @return string
+     */
     public static function string2attributeJS($string, $quoted=true)
     {
         $converted = addslashes(htmlspecialchars(strip_tags($string), ENT_QUOTES, 'UTF-8'));
@@ -805,15 +805,15 @@ 
         return $converted;
     }
     
-   /**
-    * Checks if the specified string is a boolean value, which
-    * includes string representations of boolean values, like 
-    * <code>yes</code> or <code>no</code>, and <code>true</code>
-    * or <code>false</code>.
-    * 
-    * @param mixed $value
-    * @return boolean
-    */
+    /**
+     * Checks if the specified string is a boolean value, which
+     * includes string representations of boolean values, like 
+     * <code>yes</code> or <code>no</code>, and <code>true</code>
+     * or <code>false</code>.
+     * 
+     * @param mixed $value
+     * @return boolean
+     */
     public static function isBoolean($value) : bool
     {
         if(is_bool($value)) {
@@ -827,12 +827,12 @@ 
         return array_key_exists($value, self::$booleanStrings);
     }
     
-   /**
-    * Converts an associative array to an HTML style attribute value string.
-    * 
-    * @param array $subject
-    * @return string
-    */
+    /**
+     * Converts an associative array to an HTML style attribute value string.
+     * 
+     * @param array $subject
+     * @return string
+     */
     public static function array2styleString(array $subject) : string
     {
         $tokens = array();
@@ -843,23 +843,23 @@ 
         return implode(';', $tokens);
     }
     
-   /**
-    * Converts a DateTime object to a timestamp, which
-    * is PHP 5.2 compatible.
-    * 
-    * @param \DateTime $date
-    * @return integer
-    */
+    /**
+     * Converts a DateTime object to a timestamp, which
+     * is PHP 5.2 compatible.
+     * 
+     * @param \DateTime $date
+     * @return integer
+     */
     public static function date2timestamp(\DateTime $date) : int
     {
         return (int)$date->format('U');
     }
     
-   /**
-    * Converts a timestamp into a DateTime instance.
-    * @param int $timestamp
-    * @return \DateTime
-    */
+    /**
+     * Converts a timestamp into a DateTime instance.
+     * @param int $timestamp
+     * @return \DateTime
+     */
     public static function timestamp2date(int $timestamp) : \DateTime
     {
         $date = new \DateTime();
@@ -867,50 +867,50 @@ 
         return $date;
     }
     
-   /**
-    * Strips an absolute path to a file within the application
-    * to make the path relative to the application root path.
-    * 
-    * @param string $path
-    * @return string
-    * 
-    * @see FileHelper::relativizePath()
-    * @see FileHelper::relativizePathByDepth()
-    */
+    /**
+     * Strips an absolute path to a file within the application
+     * to make the path relative to the application root path.
+     * 
+     * @param string $path
+     * @return string
+     * 
+     * @see FileHelper::relativizePath()
+     * @see FileHelper::relativizePathByDepth()
+     */
     public static function fileRelativize(string $path) : string
     {
         return FileHelper::relativizePathByDepth($path);
     }
     
     /**
-    * Converts a PHP regex to a javascript RegExp object statement.
-    * 
-    * NOTE: This is an alias for the JSHelper's `convertRegex` method. 
-    * More details are available on its usage there.
-    *
-    * @param string $regex A PHP preg regex
-    * @param string $statementType The type of statement to return: Defaults to a statement to create a RegExp object.
-    * @return array|string Depending on the specified return type.
-    * 
-    * @see JSHelper::buildRegexStatement()
-    */
+     * Converts a PHP regex to a javascript RegExp object statement.
+     * 
+     * NOTE: This is an alias for the JSHelper's `convertRegex` method. 
+     * More details are available on its usage there.
+     *
+     * @param string $regex A PHP preg regex
+     * @param string $statementType The type of statement to return: Defaults to a statement to create a RegExp object.
+     * @return array|string Depending on the specified return type.
+     * 
+     * @see JSHelper::buildRegexStatement()
+     */
     public static function regex2js(string $regex, string $statementType=JSHelper::JS_REGEX_OBJECT)
     {
         return JSHelper::buildRegexStatement($regex, $statementType);
     }
     
-   /**
-    * Converts the specified variable to JSON. Works just
-    * like the native `json_encode` method, except that it
-    * will trigger an exception on failure, which has the 
-    * json error details included in its developer details.
-    * 
-    * @param mixed $variable
-    * @param int $options JSON encode options.
-    * @param int $depth 
-    * @throws ConvertHelper_Exception
-    * @return string
-    */
+    /**
+     * Converts the specified variable to JSON. Works just
+     * like the native `json_encode` method, except that it
+     * will trigger an exception on failure, which has the 
+     * json error details included in its developer details.
+     * 
+     * @param mixed $variable
+     * @param int $options JSON encode options.
+     * @param int $depth 
+     * @throws ConvertHelper_Exception
+     * @return string
+     */
     public static function var2json($variable, int $options=0, int $depth=512) : string
     {
         $result = json_encode($variable, $options, $depth);
@@ -931,12 +931,12 @@ 
         );
     }
     
-   /**
-    * Strips all known UTF byte order marks from the specified string.
-    * 
-    * @param string $string
-    * @return string
-    */
+    /**
+     * Strips all known UTF byte order marks from the specified string.
+     * 
+     * @param string $string
+     * @return string
+     */
     public static function stripUTFBom($string)
     {
         $boms = FileHelper::getUTFBOMs();
@@ -951,13 +951,13 @@ 
         return $string;
     }
 
-   /**
-    * Converts a string to valid utf8, regardless
-    * of the string's encoding(s).
-    * 
-    * @param string $string
-    * @return string
-    */
+    /**
+     * Converts a string to valid utf8, regardless
+     * of the string's encoding(s).
+     * 
+     * @param string $string
+     * @return string
+     */
     public static function string2utf8($string)
     {
         if(!self::isStringASCII($string)) {
@@ -967,15 +967,15 @@ 
         return $string;
     }
     
-   /**
-    * Checks whether the specified string is an ASCII
-    * string, without any special or UTF8 characters.
-    * Note: empty strings and NULL are considered ASCII.
-    * Any variable types other than strings are not.
-    * 
-    * @param mixed $string
-    * @return boolean
-    */
+    /**
+     * Checks whether the specified string is an ASCII
+     * string, without any special or UTF8 characters.
+     * Note: empty strings and NULL are considered ASCII.
+     * Any variable types other than strings are not.
+     * 
+     * @param mixed $string
+     * @return boolean
+     */
     public static function isStringASCII($string) : bool
     {
         if($string === '' || $string === NULL) {
@@ -1000,22 +1000,22 @@ 
         return $url;
     }
 
-   /**
-    * Calculates a percentage match of the source string with the target string.
-    * 
-    * Options are:
-    * 
-    * - maxLevenshtein, default: 10
-    *   Any levenshtein results above this value are ignored.
-    *   
-    * - precision, default: 1
-    *   The precision of the percentage float value
-    * 
-    * @param string $source
-    * @param string $target
-    * @param array $options
-    * @return float
-    */
+    /**
+     * Calculates a percentage match of the source string with the target string.
+     * 
+     * Options are:
+     * 
+     * - maxLevenshtein, default: 10
+     *   Any levenshtein results above this value are ignored.
+     *   
+     * - precision, default: 1
+     *   The precision of the percentage float value
+     * 
+     * @param string $source
+     * @param string $target
+     * @param array $options
+     * @return float
+     */
     public static function matchString($source, $target, $options=array())
     {
         $defaults = array(
@@ -1039,14 +1039,14 @@ 
         return round(100 - $percent, $options['precision']);
     }
     
-   /**
-    * Converts a date interval to a human readable string with
-    * all necessary time components, e.g. "1 year, 2 months and 4 days".
-    * 
-    * @param \DateInterval $interval
-    * @return string
-    * @see ConvertHelper_IntervalConverter
-    */
+    /**
+     * Converts a date interval to a human readable string with
+     * all necessary time components, e.g. "1 year, 2 months and 4 days".
+     * 
+     * @param \DateInterval $interval
+     * @return string
+     * @see ConvertHelper_IntervalConverter
+     */
     public static function interval2string(\DateInterval $interval) : string
     {
         $converter = new ConvertHelper_IntervalConverter();
@@ -1061,60 +1061,60 @@ 
     
     const INTERVAL_SECONDS = 'seconds';
     
-   /**
-    * Converts an interval to its total amount of days.
-    * @param \DateInterval $interval
-    * @return int
-    */
+    /**
+     * Converts an interval to its total amount of days.
+     * @param \DateInterval $interval
+     * @return int
+     */
     public static function interval2days(\DateInterval $interval) : int
     {
         return self::interval2total($interval, self::INTERVAL_DAYS);
     }
 
-   /**
-    * Converts an interval to its total amount of hours.
-    * @param \DateInterval $interval
-    * @return int
-    */
+    /**
+     * Converts an interval to its total amount of hours.
+     * @param \DateInterval $interval
+     * @return int
+     */
     public static function interval2hours(\DateInterval $interval) : int
     {
         return self::interval2total($interval, self::INTERVAL_HOURS);
     }
     
-   /**
-    * Converts an interval to its total amount of minutes. 
-    * @param \DateInterval $interval
-    * @return int
-    */
+    /**
+     * Converts an interval to its total amount of minutes. 
+     * @param \DateInterval $interval
+     * @return int
+     */
     public static function interval2minutes(\DateInterval $interval) : int
     {
         return self::interval2total($interval, self::INTERVAL_MINUTES);
     }
     
-   /**
-    * Converts an interval to its total amount of seconds.
-    * @param \DateInterval $interval
-    * @return int
-    */    
+    /**
+     * Converts an interval to its total amount of seconds.
+     * @param \DateInterval $interval
+     * @return int
+     */    
     public static function interval2seconds(\DateInterval $interval) : int
     {
         return self::interval2total($interval, self::INTERVAL_SECONDS);
     }
     
-   /**
-    * Calculates the total amount of days / hours / minutes or seconds
-    * of a date interval object (depending in the specified units), and 
-    * returns the total amount.
-    * 
-    * @param \DateInterval $interval
-    * @param string $unit What total value to calculate.
-    * @return integer
-    * 
-    * @see ConvertHelper::INTERVAL_SECONDS
-    * @see ConvertHelper::INTERVAL_MINUTES
-    * @see ConvertHelper::INTERVAL_HOURS
-    * @see ConvertHelper::INTERVAL_DAYS
-    */
+    /**
+     * Calculates the total amount of days / hours / minutes or seconds
+     * of a date interval object (depending in the specified units), and 
+     * returns the total amount.
+     * 
+     * @param \DateInterval $interval
+     * @param string $unit What total value to calculate.
+     * @return integer
+     * 
+     * @see ConvertHelper::INTERVAL_SECONDS
+     * @see ConvertHelper::INTERVAL_MINUTES
+     * @see ConvertHelper::INTERVAL_HOURS
+     * @see ConvertHelper::INTERVAL_DAYS
+     */
     public static function interval2total(\DateInterval $interval, $unit=self::INTERVAL_SECONDS) : int
     {
         $total = (int)$interval->format('%a');
@@ -1154,13 +1154,13 @@ 
         'Sunday'
     );
     
-   /**
-    * Converts a date to the corresponding day name.
-    * 
-    * @param \DateTime $date
-    * @param bool $short
-    * @return string|NULL
-    */
+    /**
+     * Converts a date to the corresponding day name.
+     * 
+     * @param \DateTime $date
+     * @param bool $short
+     * @return string|NULL
+     */
     public static function date2dayName(\DateTime $date, bool $short=false)
     {
         $day = $date->format('l');
@@ -1175,21 +1175,21 @@ 
         return null;
     }
     
-   /**
-    * Retrieves a list of english day names.
-    * @return string[]
-    */
+    /**
+     * Retrieves a list of english day names.
+     * @return string[]
+     */
     public static function getDayNamesInvariant()
     {
         return self::$daysInvariant;
     }
     
-   /**
-    * Retrieves the day names list for the current locale.
-    * 
-    * @param bool $short
-    * @return array
-    */
+    /**
+     * Retrieves the day names list for the current locale.
+     * 
+     * @param bool $short
+     * @return array
+     */
     public static function getDayNames(bool $short=false) : array
     {
         if($short) {
@@ -1249,16 +1249,16 @@ 
         return $last;
     }
     
-   /**
-    * Splits a string into an array of all characters it is composed of.
-    * Unicode character safe.
-    * 
-    * NOTE: Spaces and newlines (both \r and \n) are also considered single
-    * characters.
-    * 
-    * @param string $string
-    * @return array
-    */
+    /**
+     * Splits a string into an array of all characters it is composed of.
+     * Unicode character safe.
+     * 
+     * NOTE: Spaces and newlines (both \r and \n) are also considered single
+     * characters.
+     * 
+     * @param string $string
+     * @return array
+     */
     public static function string2array(string $string) : array
     {
         $result = preg_split('//u', $string, null, PREG_SPLIT_NO_EMPTY);
@@ -1269,12 +1269,12 @@ 
         return array();
     }
     
-   /**
-    * Checks whether the specified string contains HTML code.
-    * 
-    * @param string $string
-    * @return boolean
-    */
+    /**
+     * Checks whether the specified string contains HTML code.
+     * 
+     * @param string $string
+     * @return boolean
+     */
     public static function isStringHTML(string $string) : bool
     {
         if(preg_match('%<[a-z/][\s\S]*>%siU', $string)) {
@@ -1289,17 +1289,17 @@ 
         return false;
     }
     
-   /**
-    * UTF8-safe wordwrap method: works like the regular wordwrap
-    * PHP function but compatible with UTF8. Otherwise the lengths
-    * are not calculated correctly.
-    * 
-    * @param string $str
-    * @param int $width
-    * @param string $break
-    * @param bool $cut
-    * @return string
-    */
+    /**
+     * UTF8-safe wordwrap method: works like the regular wordwrap
+     * PHP function but compatible with UTF8. Otherwise the lengths
+     * are not calculated correctly.
+     * 
+     * @param string $str
+     * @param int $width
+     * @param string $break
+     * @param bool $cut
+     * @return string
+     */
     public static function wordwrap(string $str, int $width = 75, string $break = "\n", bool $cut = false) : string 
     {
         $wrapper = new ConvertHelper_WordWrapper();
@@ -1311,27 +1311,27 @@ 
         ->wrapText($str);
     }
     
-   /**
-    * Calculates the byte length of a string, taking into 
-    * account any unicode characters.
-    * 
-    * @param string $string
-    * @return int
-    * @see https://stackoverflow.com/a/9718273/2298192
-    */
+    /**
+     * Calculates the byte length of a string, taking into 
+     * account any unicode characters.
+     * 
+     * @param string $string
+     * @return int
+     * @see https://stackoverflow.com/a/9718273/2298192
+     */
     public static function string2bytes($string)
     {
         return mb_strlen($string, '8bit');
     }
     
-   /**
-    * Creates a short, 8-character long hash for the specified string.
-    * 
-    * WARNING: Not cryptographically safe.
-    * 
-    * @param string $string
-    * @return string
-    */
+    /**
+     * Creates a short, 8-character long hash for the specified string.
+     * 
+     * WARNING: Not cryptographically safe.
+     * 
+     * @param string $string
+     * @return string
+     */
     public static function string2shortHash($string)
     {
         return hash('crc32', $string, false);
@@ -1357,40 +1357,40 @@ 
         return ConvertHelper_ThrowableInfo::fromThrowable($e);
     }
     
-   /**
-    * Parses the specified query string like the native 
-    * function <code>parse_str</code>, without the key
-    * naming limitations.
-    * 
-    * Using parse_str, dots or spaces in key names are 
-    * replaced by underscores. This method keeps all names
-    * intact.
-    * 
-    * It still uses the parse_str implementation as it 
-    * is tested and tried, but fixes the parameter names
-    * after parsing, as needed.
-    * 
-    * @param string $queryString
-    * @return array
-    * @see ConvertHelper_QueryParser
-    */
+    /**
+     * Parses the specified query string like the native 
+     * function <code>parse_str</code>, without the key
+     * naming limitations.
+     * 
+     * Using parse_str, dots or spaces in key names are 
+     * replaced by underscores. This method keeps all names
+     * intact.
+     * 
+     * It still uses the parse_str implementation as it 
+     * is tested and tried, but fixes the parameter names
+     * after parsing, as needed.
+     * 
+     * @param string $queryString
+     * @return array
+     * @see ConvertHelper_QueryParser
+     */
     public static function parseQueryString(string $queryString) : array
     {
         $parser = new ConvertHelper_QueryParser();
         return $parser->parse($queryString);
     }
 
-   /**
-    * Searches for needle in the specified string, and returns a list
-    * of all occurrences, including the matched string. The matched 
-    * string is useful when doing a case insensitive search, as it 
-    * shows the exact matched case of needle.
-    *   
-    * @param string $needle
-    * @param string $haystack
-    * @param bool $caseInsensitive
-    * @return ConvertHelper_StringMatch[]
-    */
+    /**
+     * Searches for needle in the specified string, and returns a list
+     * of all occurrences, including the matched string. The matched 
+     * string is useful when doing a case insensitive search, as it 
+     * shows the exact matched case of needle.
+     *   
+     * @param string $needle
+     * @param string $haystack
+     * @param bool $caseInsensitive
+     * @return ConvertHelper_StringMatch[]
+     */
     public static function findString(string $needle, string $haystack, bool $caseInsensitive=false)
     {
         if($needle === '') {
@@ -1416,14 +1416,14 @@ 
         return $positions;
     }
     
-   /**
-    * Like explode, but trims all entries, and removes 
-    * empty entries from the resulting array.
-    * 
-    * @param string $delimiter
-    * @param string $string
-    * @return string[]
-    */
+    /**
+     * Like explode, but trims all entries, and removes 
+     * empty entries from the resulting array.
+     * 
+     * @param string $delimiter
+     * @param string $string
+     * @return string[]
+     */
     public static function explodeTrim(string $delimiter, string $string) : array
     {
         if(empty($string) || empty($delimiter)) {
@@ -1445,12 +1445,12 @@ 
     
     protected static $eolChars;
 
-   /**
-    * Detects the most used end-of-line character in the subject string.
-    * 
-    * @param string $subjectString The string to check.
-    * @return NULL|ConvertHelper_EOL The detected EOL instance, or NULL if none has been detected.
-    */
+    /**
+     * Detects the most used end-of-line character in the subject string.
+     * 
+     * @param string $subjectString The string to check.
+     * @return NULL|ConvertHelper_EOL The detected EOL instance, or NULL if none has been detected.
+     */
     public static function detectEOLCharacter(string $subjectString) : ?ConvertHelper_EOL
     {
         if(empty($subjectString)) {
@@ -1462,27 +1462,27 @@ 
             $cr = chr((int)hexdec('0d'));
             $lf = chr((int)hexdec('0a'));
             
-           self::$eolChars = array(
-               array(
-                   'char' => $cr.$lf,
-                   'type' => ConvertHelper_EOL::TYPE_CRLF,
-                   'description' => t('Carriage return followed by a line feed'),
-               ),
-               array(
-                   'char' => $lf.$cr,
-                   'type' => ConvertHelper_EOL::TYPE_LFCR,
-                   'description' => t('Line feed followed by a carriage return'),
-               ),
-               array(
-                  'char' => $lf,
-                  'type' => ConvertHelper_EOL::TYPE_LF,
-                  'description' => t('Line feed'),
-               ),
-               array(
-                  'char' => $cr,
-                  'type' => ConvertHelper_EOL::TYPE_CR,
-                  'description' => t('Carriage Return'),
-               ),
+            self::$eolChars = array(
+                array(
+                    'char' => $cr.$lf,
+                    'type' => ConvertHelper_EOL::TYPE_CRLF,
+                    'description' => t('Carriage return followed by a line feed'),
+                ),
+                array(
+                    'char' => $lf.$cr,
+                    'type' => ConvertHelper_EOL::TYPE_LFCR,
+                    'description' => t('Line feed followed by a carriage return'),
+                ),
+                array(
+                    'char' => $lf,
+                    'type' => ConvertHelper_EOL::TYPE_LF,
+                    'description' => t('Line feed'),
+                ),
+                array(
+                    'char' => $cr,
+                    'type' => ConvertHelper_EOL::TYPE_CR,
+                    'description' => t('Carriage Return'),
+                ),
             );
         }
         
@@ -1510,13 +1510,13 @@ 
         );
     }
 
-   /**
-    * Removes the specified keys from the target array,
-    * if they exist.
-    * 
-    * @param array $array
-    * @param array $keys
-    */
+    /**
+     * Removes the specified keys from the target array,
+     * if they exist.
+     * 
+     * @param array $array
+     * @param array $keys
+     */
     public static function arrayRemoveKeys(array &$array, array $keys) : void
     {
         foreach($keys as $key) 
@@ -1527,13 +1527,13 @@ 
         }
     }
     
-   /**
-    * Checks if the specified variable is an integer or a string containing an integer.
-    * Accepts both positive and negative integers.
-    * 
-    * @param mixed $value
-    * @return bool
-    */
+    /**
+     * Checks if the specified variable is an integer or a string containing an integer.
+     * Accepts both positive and negative integers.
+     * 
+     * @param mixed $value
+     * @return bool
+     */
     public static function isInteger($value) : bool
     {
         if(is_int($value)) {
@@ -1553,40 +1553,40 @@ 
         return false;    
     }
     
-   /**
-    * Converts an amount of seconds to a DateInterval object.
-    * 
-    * @param int $seconds
-    * @return \DateInterval
-    * @throws ConvertHelper_Exception If the date interval cannot be created.
-    * 
-    * @see ConvertHelper::ERROR_CANNOT_GET_DATE_DIFF
-    */
+    /**
+     * Converts an amount of seconds to a DateInterval object.
+     * 
+     * @param int $seconds
+     * @return \DateInterval
+     * @throws ConvertHelper_Exception If the date interval cannot be created.
+     * 
+     * @see ConvertHelper::ERROR_CANNOT_GET_DATE_DIFF
+     */
     public static function seconds2interval(int $seconds) : \DateInterval
     {
         return ConvertHelper_DateInterval::fromSeconds($seconds)->getInterval();
     }
     
-   /**
-    * Converts a size string like "50 MB" to the corresponding byte size.
-    * It is case insensitive, ignores spaces, and supports both traditional
-    * "MB" and "MiB" notations.
-    * 
-    * @param string $size
-    * @return int
-    */
+    /**
+     * Converts a size string like "50 MB" to the corresponding byte size.
+     * It is case insensitive, ignores spaces, and supports both traditional
+     * "MB" and "MiB" notations.
+     * 
+     * @param string $size
+     * @return int
+     */
     public static function size2bytes(string $size) : int
     {
         return self::parseSize($size)->toBytes();
     }
     
-   /**
-    * Parses a size string like "50 MB" and returns a size notation instance
-    * that has utility methods to access information on it, and convert it.
-    * 
-    * @param string $size
-    * @return ConvertHelper_SizeNotation
-    */
+    /**
+     * Parses a size string like "50 MB" and returns a size notation instance
+     * that has utility methods to access information on it, and convert it.
+     * 
+     * @param string $size
+     * @return ConvertHelper_SizeNotation
+     */
     public static function parseSize(string $size) : ConvertHelper_SizeNotation
     {
         return new ConvertHelper_SizeNotation($size);