Mistralys / application-utils

src/JSHelper.php

Indentation +48 added lines, -48 removed lines

@@ -38,27 +38,27 @@ 
     public const JS_REGEX_JSON = 'json';
 
     /**
-    * @var array<string,string>
-    */
+     * @var array<string,string>
+     */
     protected static array $variableCache = array();
     protected static int $elementCounter = 0;
     protected static string $idPrefix = 'E';
     
-   /**
-    * Builds a javascript statement. The first parameter is the
-    * javascript function to call, any additional parameters are
-    * used as arguments for the javascript function call. Variable
-    * types are automagically converted to the javascript equivalents.
-    *
-    * Examples:
-    *
-    * // add an alert(); statement:
-    * JSHelper::buildStatement('alert');
-    *
-    * // add an alert('Alert text'); statement
-    * JSHelper::buildStatement('alert', 'Alert text');
-    *
-    */
+    /**
+     * Builds a javascript statement. The first parameter is the
+     * javascript function to call, any additional parameters are
+     * used as arguments for the javascript function call. Variable
+     * types are automagically converted to the javascript equivalents.
+     *
+     * Examples:
+     *
+     * // add an alert(); statement:
+     * JSHelper::buildStatement('alert');
+     *
+     * // add an alert('Alert text'); statement
+     * JSHelper::buildStatement('alert', 'Alert text');
+     *
+     */
     public static function buildStatement() : string
     {
         $args = func_get_args();
@@ -66,13 +66,13 @@ 
         return call_user_func_array(array(self::class, 'buildStatementQuoteStyle'), $args);
     }
     
-   /**
-    * Like {@link JSHelper::buildStatement()}, but using single quotes
-    * to make it possible to use the statement in an HTML tag attribute.
-    * 
-    * @return string
-    * @see JSHelper::buildStatement()
-    */
+    /**
+     * Like {@link JSHelper::buildStatement()}, but using single quotes
+     * to make it possible to use the statement in an HTML tag attribute.
+     * 
+     * @return string
+     * @see JSHelper::buildStatement()
+     */
     public static function buildStatementAttribute() : string
     {
         $args = func_get_args();
@@ -225,13 +225,13 @@ 
         return self::phpVariable2JS($variable, self::QUOTE_STYLE_SINGLE);
     }
 
-   /**
-    * Generates a dynamic element ID to be used with dynamically generated
-    * HTML code to tie in with clientside javascript when compact but unique
-    * IDs are needed in a  request.
-    *
-    * @return string
-    */
+    /**
+     * Generates a dynamic element ID to be used with dynamically generated
+     * HTML code to tie in with clientside javascript when compact but unique
+     * IDs are needed in a  request.
+     *
+     * @return string
+     */
     public static function nextElementID() : string
     {
         self::$elementCounter++;
@@ -239,33 +239,33 @@ 
         return self::$idPrefix . self::$elementCounter;
     }
     
-   /**
-    * Retrieves the ID prefix currently used.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the ID prefix currently used.
+     * 
+     * @return string
+     */
     public static function getIDPrefix() : string
     {
         return self::$idPrefix;
     }
     
-   /**
-    * Retrieves the value of the internal elements counter.
-    * 
-    * @return integer
-    */
+    /**
+     * Retrieves the value of the internal elements counter.
+     * 
+     * @return integer
+     */
     public static function getElementCounter() : int
     {
         return self::$elementCounter;
     }
     
-   /**
-    * Sets the prefix that is added in front of all IDs
-    * retrieved using the {@link nextElementID()} method.
-    * 
-    * @param string $prefix
-    * @see JSHelper::nextElementID()
-    */
+    /**
+     * Sets the prefix that is added in front of all IDs
+     * retrieved using the {@link nextElementID()} method.
+     * 
+     * @param string $prefix
+     * @see JSHelper::nextElementID()
+     */
     public static function setIDPrefix(string $prefix) : void
     {
         self::$idPrefix = $prefix;

src/ZIPHelper.php

Indentation +29 added lines, -29 removed lines

@@ -40,14 +40,14 @@ 
         'WriteThreshold' => 100
     );
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $file;
     
-   /**
-    * @var ZipArchive|NULL
-    */
+    /**
+     * @var ZipArchive|NULL
+     */
     protected $zip;
 
     protected bool $open = false;
@@ -57,35 +57,35 @@ 
         $this->file = $targetFile;
     }
     
-   /**
-    * Sets an option, among the available options:
-    * 
-    * <ul>
-    * <li>WriteThreshold: The amount of files to add before the zip is automatically written to disk and re-opened to release the file handles. Set to 0 to disable.</li>
-    * </ul>
-    * 
-    * @param string $name
-    * @param mixed $value
-    * @return ZIPHelper
-    */
+    /**
+     * Sets an option, among the available options:
+     * 
+     * <ul>
+     * <li>WriteThreshold: The amount of files to add before the zip is automatically written to disk and re-opened to release the file handles. Set to 0 to disable.</li>
+     * </ul>
+     * 
+     * @param string $name
+     * @param mixed $value
+     * @return ZIPHelper
+     */
     public function setOption(string $name, $value) : ZIPHelper
     {
         $this->options[$name] = $value;
         return $this;
     }
     
-   /**
-    * Adds a file to the zip. By default, the file is stored
-    * with the same name in the root of the zip. Use the optional
-    * parameter to change the location in the zip.
-    * 
-    * @param string $filePath
-    * @param string|null $zipPath If no path is specified, file will be added with the same name in the ZIP's root.
-    * @throws ZIPHelper_Exception
-    * @return bool
-    * 
-    * @see FileHelper::ERROR_SOURCE_FILE_DOES_NOT_EXIST
-    */
+    /**
+     * Adds a file to the zip. By default, the file is stored
+     * with the same name in the root of the zip. Use the optional
+     * parameter to change the location in the zip.
+     * 
+     * @param string $filePath
+     * @param string|null $zipPath If no path is specified, file will be added with the same name in the ZIP's root.
+     * @throws ZIPHelper_Exception
+     * @return bool
+     * 
+     * @see FileHelper::ERROR_SOURCE_FILE_DOES_NOT_EXIST
+     */
     public function addFile(string $filePath, ?string $zipPath=null) : bool
     {
         $this->open();

src/URLInfo/URIParser.php

Indentation +60 added lines, -60 removed lines

@@ -42,18 +42,18 @@ 
     protected bool $isValid = false;
     protected bool $encodeUTF = false;
 
-   /**
-    * @var array{code:int,message:string}|NULL
-    */
+    /**
+     * @var array{code:int,message:string}|NULL
+     */
     protected ?array $error = null;
     
-   /**
-    * Stores a list of all unicode characters in the URL
-    * that have been filtered out before parsing it with
-    * parse_url.
-    * 
-    * @var array<string,string>
-    */
+    /**
+     * Stores a list of all unicode characters in the URL
+     * that have been filtered out before parsing it with
+     * parse_url.
+     * 
+     * @var array<string,string>
+     */
     protected array $unicodeChars = array();
 
     /**
@@ -78,10 +78,10 @@ 
     );
 
     /**
-    * 
-    * @param string $url The target URL.
-    * @param bool $encodeUTF Whether to URL encode any plain text unicode characters.
-    */
+     * 
+     * @param string $url The target URL.
+     * @param bool $encodeUTF Whether to URL encode any plain text unicode characters.
+     */
     public function __construct(string $url, bool $encodeUTF)
     {
         $this->url = $url;
@@ -92,12 +92,12 @@ 
         $this->validate();
     }
 
-   /**
-    * Retrieves the array as parsed by PHP's parse_url,
-    * filtered and adjusted as necessary.
-    * 
-    * @return array<string,mixed>
-    */
+    /**
+     * Retrieves the array as parsed by PHP's parse_url,
+     * filtered and adjusted as necessary.
+     * 
+     * @return array<string,mixed>
+     */
     public function getInfo() : array
     {
         return $this->info;
@@ -153,11 +153,11 @@ 
         $this->url = implode(':', $parts);
     }
 
-   /**
-    * Finds any non-url encoded unicode characters in 
-    * the URL, and encodes them before the URL is 
-    * passed to parse_url.
-    */
+    /**
+     * Finds any non-url encoded unicode characters in 
+     * the URL, and encodes them before the URL is 
+     * passed to parse_url.
+     */
     protected function filterUnicodeChars() : void
     {
         $chars = ConvertHelper::string2array($this->url);
@@ -228,23 +228,23 @@ 
         $this->isValid = true;
     }
 
-   /**
-    * Goes through all information in the parse_url result
-    * array, and attempts to fix any user errors in formatting
-    * that can be recovered from, mostly regarding stray spaces.
-    */
+    /**
+     * Goes through all information in the parse_url result
+     * array, and attempts to fix any user errors in formatting
+     * that can be recovered from, mostly regarding stray spaces.
+     */
     protected function filterParsed() : void
     {
         $this->info = (new ParsedInfoFilter($this->url, $this->info))->filter();
     }
     
-   /**
-    * Recursively goes through the array, and converts all previously
-    * URL encoded characters with their unicode character counterparts.
-    * 
-    * @param array<string,mixed> $subject
-    * @return array<string,mixed>
-    */
+    /**
+     * Recursively goes through the array, and converts all previously
+     * URL encoded characters with their unicode character counterparts.
+     * 
+     * @param array<string,mixed> $subject
+     * @return array<string,mixed>
+     */
     protected function restoreUnicodeChars(array $subject) : array
     {
         $result = array();
@@ -268,13 +268,13 @@ 
         return $result;
     }
     
-   /**
-    * Replaces all URL encoded unicode characters
-    * in the string with the unicode character.
-    * 
-    * @param string $string
-    * @return string
-    */
+    /**
+     * Replaces all URL encoded unicode characters
+     * in the string with the unicode character.
+     * 
+     * @param string $string
+     * @return string
+     */
     protected function restoreUnicodeChar(string $string) : string
     {
         if(strpos($string, '%') !== false)
@@ -295,32 +295,32 @@ 
         );
     }
    
-   /**
-    * Checks whether the URL that was parsed is valid.
-    * @return bool
-    */
+    /**
+     * Checks whether the URL that was parsed is valid.
+     * @return bool
+     */
     public function isValid() : bool
     {
         return $this->isValid;
     }
 
-   /**
-    * If the validation failed, retrieves the validation
-    * error message.
-    * 
-    * @return string
-    */
+    /**
+     * If the validation failed, retrieves the validation
+     * error message.
+     * 
+     * @return string
+     */
     public function getErrorMessage() : string
     {
         return $this->error['message'] ?? '';
     }
     
-   /**
-    * If the validation failed, retrieves the validation
-    * error code.
-    * 
-    * @return int
-    */
+    /**
+     * If the validation failed, retrieves the validation
+     * error code.
+     * 
+     * @return int
+     */
     public function getErrorCode() : int
     {
         return $this->error['code'] ?? -1;

src/URLInfo.php

Indentation +184 added lines, -184 removed lines

@@ -44,42 +44,42 @@ 
     public const TYPE_URL = 'url';
     public const TYPE_NONE = 'none';
 
-   /**
-    * The original URL that was passed to the constructor.
-    * @var string
-    */
+    /**
+     * The original URL that was passed to the constructor.
+     * @var string
+     */
     protected string $rawURL;
 
-   /**
-    * @var array<string,mixed>
-    */
+    /**
+     * @var array<string,mixed>
+     */
     protected array $info;
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected array $excludedParams = array();
     
-   /**
-    * @var bool
-    * @see URLInfo::setParamExclusion()
-    */
+    /**
+     * @var bool
+     * @see URLInfo::setParamExclusion()
+     */
     protected bool $paramExclusion = false;
     
-   /**
-    * @var array<string,string>|NULL
-    * @see URLInfo::getTypeLabel()
-    */
+    /**
+     * @var array<string,string>|NULL
+     * @see URLInfo::getTypeLabel()
+     */
     protected static ?array $typeLabels = null;
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected bool $highlightExcluded = false;
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected array $infoKeys = array(
         'scheme',
         'host',
@@ -91,24 +91,24 @@ 
         'fragment'
     );
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected string $url;
     
-   /**
-    * @var URIParser
-    */
+    /**
+     * @var URIParser
+     */
     protected URIParser $parser;
     
-   /**
-    * @var URINormalizer|NULL
-    */
+    /**
+     * @var URINormalizer|NULL
+     */
     protected ?URINormalizer $normalizer = null;
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected bool $encodeUTFChars = false;
     
     public function __construct(string $url)
@@ -130,14 +130,14 @@ 
         return $this->parser;
     }
 
-   /**
-    * Whether to URL encode any non-encoded UTF8 characters in the URL.
-    * Default is to leave them as-is for better readability, since 
-    * browsers handle this well.
-    * 
-    * @param bool $enabled
-    * @return URLInfo
-    */
+    /**
+     * Whether to URL encode any non-encoded UTF8 characters in the URL.
+     * Default is to leave them as-is for better readability, since 
+     * browsers handle this well.
+     * 
+     * @param bool $enabled
+     * @return URLInfo
+     */
     public function setUTFEncoding(bool $enabled=true) : URLInfo
     {
         if($this->encodeUTFChars !== $enabled)
@@ -154,13 +154,13 @@ 
         return $this->encodeUTFChars;
     }
     
-   /**
-    * Filters a URL: removes control characters and the
-    * like to have a clean URL to work with.
-    * 
-    * @param string $url
-    * @return string
-    */
+    /**
+     * Filters a URL: removes control characters and the
+     * like to have a clean URL to work with.
+     * 
+     * @param string $url
+     * @return string
+     */
     public static function filterURL(string $url) : string
     {
         return URIFilter::filter($url);
@@ -190,12 +190,12 @@ 
         return $this->info['type'] === self::TYPE_PHONE;
     }
     
-   /**
-    * Whether the URL is a regular URL, not one of the 
-    * other types like a phone number or email address.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether the URL is a regular URL, not one of the 
+     * other types like a phone number or email address.
+     * 
+     * @return bool
+     */
     public function isURL() : bool
     {
         $host = $this->getHost();
@@ -207,20 +207,20 @@ 
         return $this->parser->isValid();
     }
     
-   /**
-    * Retrieves the host name, or an empty string if none is present.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the host name, or an empty string if none is present.
+     * 
+     * @return string
+     */
     public function getHost() : string
     {
         return $this->getInfoKey('host');
     }
     
-   /**
-    * Retrieves the path, or an empty string if none is present.
-    * @return string
-    */
+    /**
+     * Retrieves the path, or an empty string if none is present.
+     * @return string
+     */
     public function getPath() : string
     {
         return $this->getInfoKey('path');
@@ -236,10 +236,10 @@ 
         return $this->getInfoKey('scheme');
     }
     
-   /**
-    * Retrieves the port specified in the URL, or -1 if none is present.
-    * @return int
-    */
+    /**
+     * Retrieves the port specified in the URL, or -1 if none is present.
+     * @return int
+     */
     public function getPort() : int
     {
         $port = $this->getInfoKey('port');
@@ -251,13 +251,13 @@ 
         return -1;
     }
     
-   /**
-    * Retrieves the raw query string, or an empty string if none is present.
-    * 
-    * @return string
-    * 
-    * @see URLInfo::getParams()
-    */
+    /**
+     * Retrieves the raw query string, or an empty string if none is present.
+     * 
+     * @return string
+     * 
+     * @see URLInfo::getParams()
+     */
     public function getQuery() : string
     {
         return $this->getInfoKey('query');
@@ -273,20 +273,20 @@ 
         return $this->getInfoKey('pass');
     }
     
-   /**
-    * Whether the URL contains a port number.
-    * @return bool
-    */
+    /**
+     * Whether the URL contains a port number.
+     * @return bool
+     */
     public function hasPort() : bool
     {
         return $this->getPort() !== -1;
     }
     
-   /**
-    * Alias for the hasParams() method.
-    * @return bool
-    * @see URLInfo::hasParams()
-    */
+    /**
+     * Alias for the hasParams() method.
+     * @return bool
+     * @see URLInfo::hasParams()
+     */
     public function hasQuery() : bool
     {
         return $this->hasParams();
@@ -331,23 +331,23 @@ 
         return '';
     }
 
-   /**
-    * Retrieves a normalized URL: this ensures that all parameters
-    * in the URL are always in the same order.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves a normalized URL: this ensures that all parameters
+     * in the URL are always in the same order.
+     * 
+     * @return string
+     */
     public function getNormalized() : string
     {
         return $this->normalize();
     }
     
-   /**
-    * Like getNormalized(), but if a username and password are present
-    * in the URL, returns the URL without them.
-    * 
-    * @return string
-    */
+    /**
+     * Like getNormalized(), but if a username and password are present
+     * in the URL, returns the URL without them.
+     * 
+     * @return string
+     */
     public function getNormalizedWithoutAuth() : string
     {
         return $this->normalize(false);
@@ -368,25 +368,25 @@ 
         return $this->normalizer->normalize();
     }
     
-   /**
-    * Creates a hash of the URL, which can be used for comparisons.
-    * Since any parameters in the URL's query are sorted alphabetically,
-    * the same links with a different parameter order will have the 
-    * same hash.
-    * 
-    * @return string
-    */
+    /**
+     * Creates a hash of the URL, which can be used for comparisons.
+     * Since any parameters in the URL's query are sorted alphabetically,
+     * the same links with a different parameter order will have the 
+     * same hash.
+     * 
+     * @return string
+     */
     public function getHash() : string
     {
         return ConvertHelper::string2shortHash($this->getNormalized());
     }
 
-   /**
-    * Highlights the URL using HTML tags with specific highlighting
-    * class names.
-    * 
-    * @return string Will return an empty string if the URL is not valid.
-    */
+    /**
+     * Highlights the URL using HTML tags with specific highlighting
+     * class names.
+     * 
+     * @return string Will return an empty string if the URL is not valid.
+     */
     public function getHighlighted() : string
     {
         if(!$this->isValid()) {
@@ -418,15 +418,15 @@ 
         return count($params);
     }
     
-   /**
-    * Retrieves all parameters specified in the url,
-    * if any, as an associative array. 
-    * 
-    * NOTE: Ignores parameters that have been added
-    * to the excluded parameters list.
-    *
-    * @return array<string,string>
-    */
+    /**
+     * Retrieves all parameters specified in the url,
+     * if any, as an associative array. 
+     * 
+     * NOTE: Ignores parameters that have been added
+     * to the excluded parameters list.
+     *
+     * @return array<string,string>
+     */
     public function getParams() : array
     {
         if(!$this->paramExclusion || empty($this->excludedParams)) {
@@ -444,37 +444,37 @@ 
         return $keep;
     }
     
-   /**
-    * Retrieves the names of all parameters present in the URL, if any.
-    * @return string[]
-    */
+    /**
+     * Retrieves the names of all parameters present in the URL, if any.
+     * @return string[]
+     */
     public function getParamNames() : array
     {
         $params = $this->getParams();
         return array_keys($params);
     }
     
-   /**
-    * Retrieves a specific parameter value from the URL.
-    * 
-    * @param string $name
-    * @return string The parameter value, or an empty string if it does not exist.
-    */
+    /**
+     * Retrieves a specific parameter value from the URL.
+     * 
+     * @param string $name
+     * @return string The parameter value, or an empty string if it does not exist.
+     */
     public function getParam(string $name) : string
     {
         return $this->info['params'][$name] ?? '';
     }
     
-   /**
-    * Excludes a URL parameter entirely if present:
-    * the parser will act as if the parameter was not
-    * even present in the source URL, effectively
-    * stripping it.
-    *
-    * @param string $name
-    * @param string $reason A human-readable explanation why this is excluded - used when highlighting links.
-    * @return URLInfo
-    */
+    /**
+     * Excludes a URL parameter entirely if present:
+     * the parser will act as if the parameter was not
+     * even present in the source URL, effectively
+     * stripping it.
+     *
+     * @param string $name
+     * @param string $reason A human-readable explanation why this is excluded - used when highlighting links.
+     * @return URLInfo
+     */
     public function excludeParam(string $name, string $reason='') : URLInfo
     {
         if(!isset($this->excludedParams[$name]))
@@ -529,14 +529,14 @@ 
         return self::$typeLabels[$this->getType()];
     }
 
-   /**
-    * Whether excluded parameters should be highlighted in
-    * a different color in the URL when using the
-    * {@link URLInfo::getHighlighted()} method.
-    *
-    * @param bool $highlight
-    * @return URLInfo
-    */
+    /**
+     * Whether excluded parameters should be highlighted in
+     * a different color in the URL when using the
+     * {@link URLInfo::getHighlighted()} method.
+     *
+     * @param bool $highlight
+     * @return URLInfo
+     */
     public function setHighlightExcluded(bool $highlight=true) : URLInfo
     {
         $this->highlightExcluded = $highlight;
@@ -592,24 +592,24 @@ 
         return $this;
     }
     
-   /**
-    * Whether the parameter exclusion mode is enabled:
-    * In this case, if any parameters have been added to the
-    * exclusion list, all relevant methods will exclude these.
-    *
-    * @return bool
-    */
+    /**
+     * Whether the parameter exclusion mode is enabled:
+     * In this case, if any parameters have been added to the
+     * exclusion list, all relevant methods will exclude these.
+     *
+     * @return bool
+     */
     public function isParamExclusionEnabled() : bool
     {
         return $this->paramExclusion;
     }
     
-   /**
-    * Checks whether the link contains any parameters that
-    * are on the list of excluded parameters.
-    *
-    * @return bool
-    */
+    /**
+     * Checks whether the link contains any parameters that
+     * are on the list of excluded parameters.
+     *
+     * @return bool
+     */
     public function containsExcludedParams() : bool
     {
         if(empty($this->excludedParams)) {
@@ -697,26 +697,26 @@ 
             ->canConnect();
     }
     
-   /**
-    * Creates the connection tester instance that is used
-    * to check if a URL can be connected to, and which is
-    * used in the {@see URLInfo::tryConnect()} method. It
-    * allows more settings to be used.
-    * 
-    * @return URIConnectionTester
-    */
+    /**
+     * Creates the connection tester instance that is used
+     * to check if a URL can be connected to, and which is
+     * used in the {@see URLInfo::tryConnect()} method. It
+     * allows more settings to be used.
+     * 
+     * @return URIConnectionTester
+     */
     public function createConnectionTester() : URIConnectionTester
     {
         return new URIConnectionTester($this);
     }
     
-   /**
-    * Adds/overwrites a URL parameter.
-    *  
-    * @param string $name
-    * @param string $val
-    * @return URLInfo
-    */
+    /**
+     * Adds/overwrites a URL parameter.
+     *  
+     * @param string $name
+     * @param string $val
+     * @return URLInfo
+     */
     public function setParam(string $name, string $val) : URLInfo
     {
         $this->info['params'][$name] = $val;
@@ -724,13 +724,13 @@ 
         return $this;
     }
     
-   /**
-    * Removes a URL parameter. Has no effect if the
-    * parameter is not present to begin with.
-    * 
-    * @param string $param
-    * @return URLInfo
-    */
+    /**
+     * Removes a URL parameter. Has no effect if the
+     * parameter is not present to begin with.
+     * 
+     * @param string $param
+     * @return URLInfo
+     */
     public function removeParam(string $param) : URLInfo
     {
         if(isset($this->info['params'][$param]))

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)