Mistralys / application-utils

src/Request.php

Indentation +97 added lines, -97 removed lines

@@ -39,9 +39,9 @@ 
      */
     protected static $instance;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $baseURL = '';
     
     public function __construct()
@@ -51,10 +51,10 @@ 
         $this->init();
     }
     
-   /**
-    * Can be extended in a subclass, to avoid
-    * redefining the constructor.
-    */
+    /**
+     * Can be extended in a subclass, to avoid
+     * redefining the constructor.
+     */
     protected function init()
     {
         
@@ -124,12 +124,12 @@ 
         return $this->buildURL($params, $dispatcher);
     }
     
-   /**
-    * Retrieves the name of the current dispatcher script / page.
-    * This is made to be extended and implemented in a subclass.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the name of the current dispatcher script / page.
+     * This is made to be extended and implemented in a subclass.
+     * 
+     * @return string
+     */
     public function getDispatcher() : string
     {
         return '';
@@ -198,10 +198,10 @@ 
         return $url;
     }
     
-   /**
-    * Retrieves the base URL of the application.
-    * @return string
-    */
+    /**
+     * Retrieves the base URL of the application.
+     * @return string
+     */
     public function getBaseURL() : string
     {
         return $this->baseURL;
@@ -231,13 +231,13 @@ 
         return $this->knownParams[$name];
     }
     
-   /**
-    * Retrieves a previously registered parameter instance.
-    * 
-    * @param string $name
-    * @throws Request_Exception
-    * @return Request_Param
-    */
+    /**
+     * Retrieves a previously registered parameter instance.
+     * 
+     * @param string $name
+     * @throws Request_Exception
+     * @return Request_Param
+     */
     public function getRegisteredParam(string $name) : Request_Param
     {
         if(isset($this->knownParams[$name])) {
@@ -254,13 +254,13 @@ 
         );
     }
     
-   /**
-    * Checks whether a parameter with the specified name 
-    * has been registered.
-    * 
-    * @param string $name
-    * @return bool
-    */
+    /**
+     * Checks whether a parameter with the specified name 
+     * has been registered.
+     * 
+     * @param string $name
+     * @return bool
+     */
     public function hasRegisteredParam(string $name) : bool
     {
         return isset($this->knownParams[$name]);
@@ -389,14 +389,14 @@ 
         return false;
     }
     
-   /**
-    * Removes a single parameter from the request.
-    * If the parameter has been registered, also
-    * removes the registration info.
-    * 
-    * @param string $name
-    * @return Request
-    */
+    /**
+     * Removes a single parameter from the request.
+     * If the parameter has been registered, also
+     * removes the registration info.
+     * 
+     * @param string $name
+     * @return Request
+     */
     public function removeParam(string $name) : Request
     {
         if(isset($_REQUEST[$name])) {
@@ -410,12 +410,12 @@ 
         return $this;
     }
     
-   /**
-    * Removes several parameters from the request.
-    * 
-    * @param string[] $names
-    * @return Request
-    */
+    /**
+     * Removes several parameters from the request.
+     * 
+     * @param string[] $names
+     * @return Request
+     */
     public function removeParams(array $names) : Request
     {
         foreach($names as $name) {
@@ -480,18 +480,18 @@ 
         return $val;
     }
     
-   /**
-    * Treats the request parameter as a JSON string, and
-    * if it exists and contains valid JSON, returns the
-    * decoded JSON value as an array (default).
-    *
-    * @param string $name
-    * @param bool $assoc
-    * @return array|object
-    * 
-    * @see Request::getJSONAssoc()
-    * @see Request::getJSONObject()
-    */
+    /**
+     * Treats the request parameter as a JSON string, and
+     * if it exists and contains valid JSON, returns the
+     * decoded JSON value as an array (default).
+     *
+     * @param string $name
+     * @param bool $assoc
+     * @return array|object
+     * 
+     * @see Request::getJSONAssoc()
+     * @see Request::getJSONObject()
+     */
     public function getJSON(string $name, bool $assoc=true)
     {
         $value = $this->getParam($name);
@@ -516,13 +516,13 @@ 
         return new \stdClass();
     }
     
-   /**
-    * Like {@link Request::getJSON()}, but omitting the second
-    * parameter. Use this for more readable code.
-    * 
-    * @param string $name
-    * @return array
-    */
+    /**
+     * Like {@link Request::getJSON()}, but omitting the second
+     * parameter. Use this for more readable code.
+     * 
+     * @param string $name
+     * @return array
+     */
     public function getJSONAssoc(string $name) : array
     {
         $result = $this->getJSON($name);
@@ -533,13 +533,13 @@ 
         return array();
     }
     
-   /**
-    * Like {@link Request::getJSON()}, but omitting the second
-    * parameter. Use this for more readable code.
-    *
-    * @param string $name
-    * @return object
-    */
+    /**
+     * Like {@link Request::getJSON()}, but omitting the second
+     * parameter. Use this for more readable code.
+     *
+     * @param string $name
+     * @return object
+     */
     public function getJSONObject(string $name) : object
     {
         $result = $this->getJSON($name, false);
@@ -550,12 +550,12 @@ 
         return new \stdClass();
     }
     
-   /**
-    * Sends a JSON response with the correct headers.
-    *
-    * @param array|string $data
-    * @param bool $exit Whether to exit the script afterwards.
-    */
+    /**
+     * Sends a JSON response with the correct headers.
+     *
+     * @param array|string $data
+     * @param bool $exit Whether to exit the script afterwards.
+     */
     public static function sendJSON($data, bool $exit=true)
     {
         $payload = $data;
@@ -575,12 +575,12 @@ 
         }
     }
     
-   /**
-    * Sends HTML to the browser with the correct headers.
-    * 
-    * @param string $html
-    * @param bool $exit Whether to exit the script afterwards.
-    */
+    /**
+     * Sends HTML to the browser with the correct headers.
+     * 
+     * @param string $html
+     * @param bool $exit Whether to exit the script afterwards.
+     */
     public static function sendHTML(string $html, bool $exit=true)
     {
         header('Cache-Control: no-cache, must-revalidate');
@@ -595,16 +595,16 @@ 
         }
     }
     
-   /**
-    * Creates a new instance of the URL comparer, which can check 
-    * whether the specified URLs match, regardless of the order in 
-    * which the query parameters are, if any.
-    * 
-    * @param string $sourceURL
-    * @param string $targetURL
-    * @param array $limitParams Whether to limit the comparison to these specific parameter names (if present)
-    * @return Request_URLComparer
-    */
+    /**
+     * Creates a new instance of the URL comparer, which can check 
+     * whether the specified URLs match, regardless of the order in 
+     * which the query parameters are, if any.
+     * 
+     * @param string $sourceURL
+     * @param string $targetURL
+     * @param array $limitParams Whether to limit the comparison to these specific parameter names (if present)
+     * @return Request_URLComparer
+     */
     public function createURLComparer(string $sourceURL, string $targetURL, array $limitParams=array()) : Request_URLComparer
     {
         $comparer = new Request_URLComparer($this, $sourceURL, $targetURL);
@@ -613,10 +613,10 @@ 
         return $comparer;
     }
     
-   /**
-    * Retrieves the full URL that was used to access the current page.
-    * @return string
-    */
+    /**
+     * Retrieves the full URL that was used to access the current page.
+     * @return string
+     */
     public function getCurrentURL() : string
     {
         return $_SERVER['HTTP_HOST'].$_SERVER['REQUEST_URI'];

src/Request/Param.php

Indentation +135 added lines, -135 removed lines

@@ -111,18 +111,18 @@ 
         }
     }
     
-   /**
-    * Adds a callback as a validation method. The callback gets the
-    * value to validate as first parameter, and any additional 
-    * parameters passed here get appended to that.
-    * 
-    * The callback must return boolean true or false depending on
-    * whether the value is valid.
-    * 
-    * @param mixed $callback
-    * @param array $args
-    * @return Request_Param
-    */
+    /**
+     * Adds a callback as a validation method. The callback gets the
+     * value to validate as first parameter, and any additional 
+     * parameters passed here get appended to that.
+     * 
+     * The callback must return boolean true or false depending on
+     * whether the value is valid.
+     * 
+     * @param mixed $callback
+     * @param array $args
+     * @return Request_Param
+     */
     public function setCallback($callback, $args=array())
     {
         if(!is_callable($callback)) {
@@ -264,13 +264,13 @@ 
     
     protected $valueType = self::VALUE_TYPE_STRING;
 
-   /**
-    * Sets the variable to contain a comma-separated list of integer IDs.
-    * Example: <code>145,248,4556</code>. A single ID is also allowed, e.g.
-    * <code>145</code>.
-    * 
-    * @return Request_Param
-    */
+    /**
+     * Sets the variable to contain a comma-separated list of integer IDs.
+     * Example: <code>145,248,4556</code>. A single ID is also allowed, e.g.
+     * <code>145</code>.
+     * 
+     * @return Request_Param
+     */
     public function setIDList()
     {
         $this->valueType = self::VALUE_TYPE_ID_LIST;
@@ -279,13 +279,13 @@ 
         return $this;
     }
     
-   /**
-    * Sets the variable to be an alias, as defined by the
-    * {@link RegexHelper::REGEX_ALIAS} regular expression.
-    * 
-    * @return Request_Param
-    * @see RegexHelper::REGEX_ALIAS
-    */
+    /**
+     * Sets the variable to be an alias, as defined by the
+     * {@link RegexHelper::REGEX_ALIAS} regular expression.
+     * 
+     * @return Request_Param
+     * @see RegexHelper::REGEX_ALIAS
+     */
     public function setAlias()
     {
         return $this->setRegex(RegexHelper::REGEX_ALIAS);
@@ -326,12 +326,12 @@ 
         return $this->setValidation(self::VALIDATION_TYPE_ALPHA);
     }
     
-   /**
-    * Sets the parameter value as a string containing lowercase
-    * and/or uppercase letters, as well as numbers.
-    * 
-    * @return Request_Param
-    */
+    /**
+     * Sets the parameter value as a string containing lowercase
+     * and/or uppercase letters, as well as numbers.
+     * 
+     * @return Request_Param
+     */
     public function setAlnum()
     {
         return $this->setValidation(self::VALIDATION_TYPE_ALNUM);   
@@ -359,17 +359,17 @@ 
         return $this->setValidation(self::VALIDATION_TYPE_ENUM, $args);
     }
     
-   /**
-    * Only available for array values: the parameter must be
-    * an array value, and the array may only contain values 
-    * specified in the values array.
-    * 
-    * Submitted values that are not in the allowed list of
-    * values are stripped from the value.
-    *  
-    * @param array $values List of allowed values
-    * @return \AppUtils\Request_Param
-    */
+    /**
+     * Only available for array values: the parameter must be
+     * an array value, and the array may only contain values 
+     * specified in the values array.
+     * 
+     * Submitted values that are not in the allowed list of
+     * values are stripped from the value.
+     *  
+     * @param array $values List of allowed values
+     * @return \AppUtils\Request_Param
+     */
     public function setValuesList(array $values)
     {
         $this->setArray();
@@ -382,39 +382,39 @@ 
         return $this->setValidation(self::VALIDATION_TYPE_ARRAY);
     }
     
-   /**
-    * Specifies that a JSON-encoded string is expected.
-    * 
-    * NOTE: Numbers or quoted strings are technically valid
-    * JSON, but are not accepted, because it is assumed
-    * at least an array or object are expected.
-    * 
-    * @return \AppUtils\Request_Param
-    */
+    /**
+     * Specifies that a JSON-encoded string is expected.
+     * 
+     * NOTE: Numbers or quoted strings are technically valid
+     * JSON, but are not accepted, because it is assumed
+     * at least an array or object are expected.
+     * 
+     * @return \AppUtils\Request_Param
+     */
     public function setJSON() : Request_Param
     {
         return $this->setValidation(self::VALIDATION_TYPE_JSON, array('arrays' => true));
     }
     
-   /**
-    * Like {@link Request_Param::setJSON()}, but accepts
-    * only JSON objects. Arrays will not be accepted.
-    * 
-    * @return \AppUtils\Request_Param
-    */
+    /**
+     * Like {@link Request_Param::setJSON()}, but accepts
+     * only JSON objects. Arrays will not be accepted.
+     * 
+     * @return \AppUtils\Request_Param
+     */
     public function setJSONObject() : Request_Param
     {
         return $this->setValidation(self::VALIDATION_TYPE_JSON, array('arrays' => false));
     }
     
-   /**
-    * The parameter is a string boolean representation. This means
-    * it can be any of the following: "yes", "true", "no", "false".
-    * The value is automatically converted to a boolean when retrieving
-    * the parameter.
-    * 
-    * @return Request_Param
-    */
+    /**
+     * The parameter is a string boolean representation. This means
+     * it can be any of the following: "yes", "true", "no", "false".
+     * The value is automatically converted to a boolean when retrieving
+     * the parameter.
+     * 
+     * @return Request_Param
+     */
     public function setBoolean() : Request_Param
     {
         $this->addCallbackFilter(array($this, 'applyFilter_boolean'));
@@ -478,15 +478,15 @@ 
         return $keep;
     }
     
-   /**
-    * Validates the request parameter as an MD5 string,
-    * so that only values resembling md5 values are accepted.
-    * 
-    * NOTE: This can only guarantee the format, not whether
-    * it is an actual valid hash of something.
-    * 
-    * @return \AppUtils\Request_Param
-    */
+    /**
+     * Validates the request parameter as an MD5 string,
+     * so that only values resembling md5 values are accepted.
+     * 
+     * NOTE: This can only guarantee the format, not whether
+     * it is an actual valid hash of something.
+     * 
+     * @return \AppUtils\Request_Param
+     */
     public function setMD5() : Request_Param
     {
         return $this->setRegex(RegexHelper::REGEX_MD5);
@@ -528,14 +528,14 @@ 
         return $this;
     }
     
-   /**
-    * Retrieves the value of the request parameter,
-    * applying all filters (if any) and validation
-    * (if any).
-    * 
-    * @param mixed $default
-    * @return mixed
-    */
+    /**
+     * Retrieves the value of the request parameter,
+     * applying all filters (if any) and validation
+     * (if any).
+     * 
+     * @param mixed $default
+     * @return mixed
+     */
     public function get($default=null)
     {
         $value = $this->request->getParam($this->paramName);
@@ -565,12 +565,12 @@ 
         return null;
     }
     
-   /**
-    * Validates the syntax of an URL, but not its actual validity. 
-    * 
-    * @param mixed $value
-    * @return string
-    */
+    /**
+     * Validates the syntax of an URL, but not its actual validity. 
+     * 
+     * @param mixed $value
+     * @return string
+     */
     protected function validate_url($value) : string
     {
         if(!is_string($value)) {
@@ -710,10 +710,10 @@ 
         return null;
     }
     
-   /**
-    * Makes sure that the value is a JSON-encoded string.
-    * @param mixed $value
-    */
+    /**
+     * Makes sure that the value is a JSON-encoded string.
+     * @param mixed $value
+     */
     protected function validate_json($value) : string
     {
         if(!is_string($value)) {
@@ -730,7 +730,7 @@ 
         if($this->validationParams['arrays'] === false) 
         {
             if(is_object(json_decode($value))) {
-               return $value; 
+                return $value; 
             }
         } 
         else 
@@ -810,12 +810,12 @@ 
         return $this;
     }
     
-   /**
-    * Adds a filter that trims whitespace from the request
-    * parameter using the PHP <code>trim</code> function.
-    * 
-    * @return \AppUtils\Request_Param
-    */
+    /**
+     * Adds a filter that trims whitespace from the request
+     * parameter using the PHP <code>trim</code> function.
+     * 
+     * @return \AppUtils\Request_Param
+     */
     public function addFilterTrim() : Request_Param
     {
         // to guarantee we only work with strings
@@ -824,13 +824,13 @@ 
         return $this->addCallbackFilter('trim');
     }
 
-   /**
-    * Converts the value to a string, even if it is not
-    * a string value. Complex types like arrays and objects
-    * are converted to an empty string.
-    * 
-    * @return \AppUtils\Request_Param
-    */
+    /**
+     * Converts the value to a string, even if it is not
+     * a string value. Complex types like arrays and objects
+     * are converted to an empty string.
+     * 
+     * @return \AppUtils\Request_Param
+     */
     public function addStringFilter() : Request_Param
     {
         return $this->addCallbackFilter(array($this, 'applyFilter_string'));
@@ -880,12 +880,12 @@ 
         return $this->addCallbackFilter('strip_tags', array($allowedTags));
     }
     
-   /**
-    * Adds a filter that strips all whitespace from the
-    * request parameter, from spaces to tabs and newlines.
-    * 
-    * @return \AppUtils\Request_Param
-    */
+    /**
+     * Adds a filter that strips all whitespace from the
+     * request parameter, from spaces to tabs and newlines.
+     * 
+     * @return \AppUtils\Request_Param
+     */
     public function addStripWhitespaceFilter() : Request_Param
     {
         // to ensure we only work with strings.
@@ -894,14 +894,14 @@ 
         return $this->addCallbackFilter(array($this, 'applyFilter_stripWhitespace'));
     }   
     
-   /**
-    * Adds a filter that transforms comma separated values
-    * into an array of values.
-    * 
-    * @param bool $trimEntries Trim whitespace from each entry?
-    * @param bool $stripEmptyEntries Remove empty entries from the array?
-    * @return \AppUtils\Request_Param
-    */
+    /**
+     * Adds a filter that transforms comma separated values
+     * into an array of values.
+     * 
+     * @param bool $trimEntries Trim whitespace from each entry?
+     * @param bool $stripEmptyEntries Remove empty entries from the array?
+     * @return \AppUtils\Request_Param
+     */
     public function addCommaSeparatedFilter(bool $trimEntries=true, bool $stripEmptyEntries=true) : Request_Param
     {
         $this->setArray();
@@ -915,12 +915,12 @@ 
         );
     }
     
-   /**
-    * Adds a filter that encodes all HTML special characters
-    * using the PHP <code>htmlspecialchars</code> function.
-    * 
-    * @return \AppUtils\Request_Param
-    */
+    /**
+     * Adds a filter that encodes all HTML special characters
+     * using the PHP <code>htmlspecialchars</code> function.
+     * 
+     * @return \AppUtils\Request_Param
+     */
     public function addHTMLSpecialcharsFilter() : Request_Param
     {
         return $this->addCallbackFilter('htmlspecialchars', array(ENT_QUOTES, 'UTF-8'));
@@ -933,14 +933,14 @@ 
     
     protected $required = false;
     
-   /**
-    * Marks this request parameter as required. To use this feature,
-    * you have to call the request's {@link Request::validate()}
-    * method.
-    * 
-    * @return Request_Param
-    * @see Request::validate()
-    */
+    /**
+     * Marks this request parameter as required. To use this feature,
+     * you have to call the request's {@link Request::validate()}
+     * method.
+     * 
+     * @return Request_Param
+     * @see Request::validate()
+     */
     public function makeRequired() : Request_Param
     {
         $this->required = true;

src/URLInfo.php

Indentation +158 added lines, -158 removed lines

@@ -36,40 +36,40 @@ 
     const TYPE_PHONE = 'phone';
     const TYPE_URL = 'url';
     
-   /**
-    * The original URL that was passed to the constructor.
-    * @var string
-    */
+    /**
+     * The original URL that was passed to the constructor.
+     * @var string
+     */
     protected $rawURL;
 
-   /**
-    * @var array
-    */
+    /**
+     * @var array
+     */
     protected $info;
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected $isEmail = false;
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected $isFragment = false;
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected $isValid = true;
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected $isPhone = false;
     
-   /**
-    * @var array
-    */
+    /**
+     * @var array
+     */
     protected $knownSchemes = array(
         'ftp',
         'http',
@@ -80,41 +80,41 @@ 
         'file'
     );
 
-   /**
-    * @var array
-    */
+    /**
+     * @var array
+     */
     protected $error;
     
-   /**
-    * @var array
-    */
+    /**
+     * @var array
+     */
     protected $params = array();
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected $excludedParams = array();
     
-   /**
-    * @var bool
-    * @see URLInfo::setParamExclusion()
-    */
+    /**
+     * @var bool
+     * @see URLInfo::setParamExclusion()
+     */
     protected $paramExclusion = false;
     
-   /**
-    * @var array
-    * @see URLInfo::getTypeLabel()
-    */
+    /**
+     * @var array
+     * @see URLInfo::getTypeLabel()
+     */
     protected static $typeLabels;
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected $highlightExcluded = false;
     
-   /**
-    * @var array
-    */
+    /**
+     * @var array
+     */
     protected $infoKeys = array(
         'scheme',
         'host',
@@ -126,9 +126,9 @@ 
         'fragment'
     );
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $url;
     
     public function __construct(string $url)
@@ -214,13 +214,13 @@ 
         $this->isValid = true;
     }
     
-   /**
-    * Filters an URL: removes control characters and the
-    * like to have a clean URL to work with.
-    * 
-    * @param string $url
-    * @return string
-    */
+    /**
+     * Filters an 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)
     {
         // fix ampersands if it comes from HTML
@@ -243,11 +243,11 @@ 
         return $url;
     }
     
-   /**
-    * 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()
     {
         foreach($this->info as $key => $val)
@@ -331,12 +331,12 @@ 
         return $this->isPhone;
     }
     
-   /**
-    * 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();
@@ -348,20 +348,20 @@ 
         return $this->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');
@@ -377,10 +377,10 @@ 
         return $this->getInfoKey('scheme');
     }
     
-   /**
-    * Retrieves the port specified in the URL, or -1 if none is preseent.
-    * @return int
-    */
+    /**
+     * Retrieves the port specified in the URL, or -1 if none is preseent.
+     * @return int
+     */
     public function getPort() : int
     {
         $port = $this->getInfoKey('port');
@@ -391,13 +391,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');
@@ -413,20 +413,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();
@@ -507,25 +507,25 @@ 
         return $normalized;
     }
     
-   /**
-    * 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()
     {
         return \AppUtils\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) {
@@ -709,15 +709,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
-    */
+    /**
+     * 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
+     */
     public function getParams() : array
     {
         if(!$this->paramExclusion || empty($this->excludedParams)) {
@@ -734,26 +734,26 @@ 
         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);
     }
     
-   /**
-    * Excludes an 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 an 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]))
@@ -818,25 +818,25 @@ 
         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;
         return $this;
     }
     
-   /**
-    * Returns an array with all relevant URL information.
-    * 
-    * @return array
-    */
+    /**
+     * Returns an array with all relevant URL information.
+     * 
+     * @return array
+     */
     public function toArray() : array
     {
         return array(
@@ -880,24 +880,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)) {

src/BaseException.php

Indentation +35 added lines, -35 removed lines

@@ -20,17 +20,17 @@ 
  */
 class BaseException extends \Exception
 {
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $details;
     
-   /**
-    * @param string $message
-    * @param string $details
-    * @param int $code
-    * @param \Exception $previous
-    */
+    /**
+     * @param string $message
+     * @param string $details
+     * @param int $code
+     * @param \Exception $previous
+     */
     public function __construct(string $message, $details=null, $code=null, $previous=null)
     {
         parent::__construct($message, $code, $previous);
@@ -38,10 +38,10 @@ 
         $this->details = $details;
     }
     
-   /**
-    * Retrieves the detailed error description, if any.
-    * @return string
-    */
+    /**
+     * Retrieves the detailed error description, if any.
+     * @return string
+     */
     public function getDetails() : string
     {
         if($this->details !== null) {
@@ -51,9 +51,9 @@ 
         return '';
     }
     
-   /**
-    * Displays pertinent information on the exception.
-    */
+    /**
+     * Displays pertinent information on the exception.
+     */
     public function display()
     {
         if(!headers_sent()) {
@@ -63,20 +63,20 @@ 
         echo $this->getInfo();
     }
     
-   /**
-    * Retrieves information on the exception that can be
-    * easily accessed.
-    * 
-    * @return ConvertHelper_ThrowableInfo
-    */
+    /**
+     * Retrieves information on the exception that can be
+     * easily accessed.
+     * 
+     * @return ConvertHelper_ThrowableInfo
+     */
     public function getInfo() : ConvertHelper_ThrowableInfo
     {
         return ConvertHelper::throwable2info($this);
     }
     
-   /**
-    * Dumps a current PHP function trace, as a textonly string.
-    */
+    /**
+     * Dumps a current PHP function trace, as a textonly string.
+     */
     public static function dumpTraceAsString()
     {
         try
@@ -89,9 +89,9 @@ 
         }
     }
 
-   /**
-    * Dumps a current PHP function trace, with HTML styling.
-    */
+    /**
+     * Dumps a current PHP function trace, with HTML styling.
+     */
     public static function dumpTraceAsHTML()
     {
         try
@@ -106,13 +106,13 @@ 
         }
     }
     
-   /**
-    * Creates an exception info instance from a throwable instance.
-    * 
-    * @param \Throwable $e
-    * @return ConvertHelper_ThrowableInfo
-    * @see ConvertHelper::throwable2info()
-    */
+    /**
+     * Creates an exception info instance from a throwable instance.
+     * 
+     * @param \Throwable $e
+     * @return ConvertHelper_ThrowableInfo
+     * @see ConvertHelper::throwable2info()
+     */
     public static function createInfo(\Throwable $e) : ConvertHelper_ThrowableInfo
     {
         return ConvertHelper::throwable2info($e);

src/Traits/Optionable.php

Indentation +102 added lines, -102 removed lines

@@ -26,19 +26,19 @@ 
  */
 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 $default
-    * @return Interface_Optionable
-    */
+    /**
+     * Sets an option to the specified value. This can be any
+     * kind of variable type, including objects, as needed.
+     * 
+     * @param string $name
+     * @param mixed $default
+     * @return Interface_Optionable
+     */
     public function setOption(string $name, $value)
     {
         if(!isset($this->options)) {
@@ -49,13 +49,13 @@ 
         return $this;
     }
     
-   /**
-    * Sets a collection of options at once, from an
-    * associative array.
-    * 
-    * @param array $options
-    * @return Interface_Optionable
-    */
+    /**
+     * Sets a collection of options at once, from an
+     * associative array.
+     * 
+     * @param array $options
+     * @return Interface_Optionable
+     */
     public function setOptions(array $options)
     {
         foreach($options as $name => $value) {
@@ -65,16 +65,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)) {
@@ -88,16 +88,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);
@@ -109,15 +109,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) {
@@ -127,15 +127,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);
@@ -146,14 +146,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);
@@ -164,13 +164,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)) {
@@ -180,10 +180,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)) {
@@ -193,24 +193,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;
 }
 
@@ -228,24 +228,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/ImageHelper.php

Indentation +394 added lines, -394 removed lines

@@ -66,54 +66,54 @@ 
     
     const ERROR_GD_LIBRARY_NOT_INSTALLED = 513024;
 
-   /**
-    * @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(
@@ -201,17 +201,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);
@@ -226,18 +226,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);
@@ -245,29 +245,29 @@ 
         return new ImageHelper(null, $resource, $type);
     }
     
-   /**
-    * Factory method: creates an image helper from an
-    * image file on disk.
-    *
-    * @param string $path
-    * @return ImageHelper
-    */
+    /**
+     * Factory method: creates an image helper from an
+     * image file on disk.
+     *
+     * @param string $path
+     * @return ImageHelper
+     */
     public static function createFromFile($file)
     {
         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])) {
@@ -275,22 +275,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);
@@ -302,12 +302,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));
@@ -495,13 +495,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);
@@ -511,12 +511,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);
@@ -524,13 +524,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()) {
@@ -595,12 +595,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);
@@ -715,12 +715,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']) {
@@ -760,27 +760,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()) {
@@ -920,31 +920,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);
@@ -962,14 +962,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()) {
@@ -1057,12 +1057,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);
@@ -1072,12 +1072,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)) {
@@ -1094,14 +1094,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);
@@ -1120,54 +1120,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();
 
@@ -1188,9 +1188,9 @@ 
         return $this;
     }
     
-   /**
-    * @return resource
-    */
+    /**
+     * @return resource
+     */
     public function getImage()
     {
         return $this->newImage;
@@ -1208,27 +1208,27 @@ 
         return $this;
     }
     
-   /**
-    * Retrieves the size of the image.
-    * 
-    * @param bool $exception Whether to trigger an exception when the image does not exist
-    * @return ImageHelper_Size
-    * @throws ImageHelper_Exception
-    * @see ImageHelper::ERROR_CANNOT_GET_IMAGE_SIZE
-    */
-	public function getSize() : ImageHelper_Size
+    /**
+     * Retrieves the size of the image.
+     * 
+     * @param bool $exception Whether to trigger an exception when the image does not exist
+     * @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;
@@ -1300,63 +1300,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',
@@ -1366,96 +1366,96 @@ 
             ),
             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']);
-	    $viewBox = explode(',', $viewBox);
-	    if(count($viewBox) != 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
+        $viewBox = str_replace(' ', ',', $data['@attributes']['viewBox']);
+        $viewBox = explode(',', $viewBox);
+        if(count($viewBox) != 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 = $viewBox[2];
-	    $boxHeight = $viewBox[3];
+        $boxWidth = $viewBox[2];
+        $boxHeight = $viewBox[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);
@@ -1477,14 +1477,14 @@ 
         return $this->newHeight;
     }
 
-   /**
-    * Calculates the average color value used in 
-    * the image. Returns an associative array
-    * with the red, green, blue and alpha components.
-    * 
-    * @param int $format The format in which to return the color value.
-    * @return array|string
-    */
+    /**
+     * Calculates the average color value used in 
+     * the image. Returns an associative array
+     * with the red, green, blue and alpha components.
+     * 
+     * @param int $format The format in which to return the color value.
+     * @return array|string
+     */
     public function calcAverageColor(int $format=self::COLORFORMAT_RGB)
     {
         $image = $this->duplicate();
@@ -1507,18 +1507,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()) 
@@ -1546,21 +1546,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($rgb)
     {
         return (($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->calcAverageColor());
@@ -1568,15 +1568,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/ConvertHelper/DurationConverter.php

Indentation +32 added lines, -32 removed lines

@@ -26,31 +26,31 @@ 
     const ERROR_NO_DATE_FROM_SET = 43401;
     
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $dateFrom;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $dateTo;
     
     public function __construct()
     {
     }
     
-   /**
-    * Sets the origin date to calculate from.
-    * 
-    * NOTE: if this is further in the future than
-    * the to: date, it will be considered as a 
-    * calculation for something to come, i.e. 
-    * "In two days".
-    *  
-    * @param \DateTime $date
-    * @return ConvertHelper_DurationConverter
-    */
+    /**
+     * Sets the origin date to calculate from.
+     * 
+     * NOTE: if this is further in the future than
+     * the to: date, it will be considered as a 
+     * calculation for something to come, i.e. 
+     * "In two days".
+     *  
+     * @param \DateTime $date
+     * @return ConvertHelper_DurationConverter
+     */
     public function setDateFrom(\DateTime $date) : ConvertHelper_DurationConverter
     {
         $this->dateFrom = ConvertHelper::date2timestamp($date);
@@ -58,13 +58,13 @@ 
         return $this;
     }
     
-   /**
-    * Sets the date to calculate to. Defaults to 
-    * the current time if not set.
-    * 
-    * @param \DateTime $date
-    * @return ConvertHelper_DurationConverter
-    */
+    /**
+     * Sets the date to calculate to. Defaults to 
+     * the current time if not set.
+     * 
+     * @param \DateTime $date
+     * @return ConvertHelper_DurationConverter
+     */
     public function setDateTo(\DateTime $date) : ConvertHelper_DurationConverter
     {
         $this->dateTo = ConvertHelper::date2timestamp($date);
@@ -72,14 +72,14 @@ 
         return $this;
     }
     
-   /**
-    * Converts the specified dates to a human readable string.
-    * 
-    * @throws ConvertHelper_Exception
-    * @return string
-    * 
-    * @see ConvertHelper_DurationConverter::ERROR_NO_DATE_FROM_SET
-    */
+    /**
+     * Converts the specified dates to a human readable string.
+     * 
+     * @throws ConvertHelper_Exception
+     * @return string
+     * 
+     * @see ConvertHelper_DurationConverter::ERROR_NO_DATE_FROM_SET
+     */
     public function convert() : string
     {
         if(!isset($this->dateFrom)) 

src/ConvertHelper.php

Indentation +406 added lines, -406 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($dateto instanceof \DateTime)
-         {
-             $converter->setDateTo($dateto);
-         }
-         else if($dateto > 0)
-         {
-             $converter->setDateTo(self::timestamp2date($dateto));
-         }
-
-         return $converter->convert();
+            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));
+            }
+
+            return $converter->convert();
     }
 
     /**
@@ -269,16 +269,16 @@ 
         return $bytes . ' ' . t('B');
     }
 
-   /**
-    * 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);
@@ -348,27 +348,27 @@ 
         return self::$booleanStrings[$string];
     }
     
-   /**
-    * 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);
@@ -470,13 +470,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');
@@ -512,13 +512,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();
@@ -531,12 +531,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();
@@ -593,20 +593,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);
@@ -729,25 +729,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();
@@ -766,14 +766,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'));
@@ -784,15 +784,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)) {
@@ -806,12 +806,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();
@@ -822,23 +822,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();
@@ -846,50 +846,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|NULL $options JSON encode options.
-    * @param int|NULL $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|NULL $options JSON encode options.
+     * @param int|NULL $depth 
+     * @throws ConvertHelper_Exception
+     * @return string
+     */
     public static function var2json($variable, int $options=0, int $depth=512) : string
     {
         $result = json_encode($variable, $options, $depth);
@@ -910,12 +910,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();
@@ -930,13 +930,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)) {
@@ -946,15 +946,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) {
@@ -979,22 +979,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(
@@ -1078,60 +1078,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 = $interval->format('%a');
@@ -1171,13 +1171,13 @@ 
         'Sunday'
     );
     
-   /**
-    * Converts a date to the corresponding day name.
-    * 
-    * @param \DateTime $date
-    * @param string $short
-    * @return string|NULL
-    */
+    /**
+     * Converts a date to the corresponding day name.
+     * 
+     * @param \DateTime $date
+     * @param string $short
+     * @return string|NULL
+     */
     public static function date2dayName(\DateTime $date, $short=false)
     {
         $day = $date->format('l');
@@ -1192,21 +1192,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 string $short
-    * @return string[]
-    */
+    /**
+     * Retrieves the day names list for the current locale.
+     * 
+     * @param string $short
+     * @return string[]
+     */
     public static function getDayNames($short=false)
     {
         if($short) {
@@ -1266,16 +1266,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);
@@ -1286,12 +1286,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)) {
@@ -1306,18 +1306,18 @@ 
         return false;
     }
     
-   /**
-    * UTF8-safe wordwrap method: works like the regular wordwrap
-    * PHP function but compatible with UTF8. Otherwise the lengths
-    * are no calculated correctly.
-    * 
-    * @param string $str
-    * @param int $width
-    * @param string $break
-    * @param bool $cut
-    * @return string
-    * @see https://stackoverflow.com/a/4988494/2298192
-    */
+    /**
+     * UTF8-safe wordwrap method: works like the regular wordwrap
+     * PHP function but compatible with UTF8. Otherwise the lengths
+     * are no calculated correctly.
+     * 
+     * @param string $str
+     * @param int $width
+     * @param string $break
+     * @param bool $cut
+     * @return string
+     * @see https://stackoverflow.com/a/4988494/2298192
+     */
     public static function wordwrap($str, $width = 75, $break = "\n", $cut = false) 
     {
         $lines = explode($break, $str);
@@ -1363,27 +1363,27 @@ 
         return implode($break, $lines);
     }
     
-   /**
-    * 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);
@@ -1409,23 +1409,23 @@ 
         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 https://www.php.net/manual/en/function.parse-str.php
-    */
+    /**
+     * 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 https://www.php.net/manual/en/function.parse-str.php
+     */
     public static function parseQueryString(string $queryString) : array
     {
         // allow HTML entities notation
@@ -1465,16 +1465,16 @@ 
             $placeholders = array();
             foreach($paramNames as $paramName)
             {
-                 // create a unique placeholder name
-                 $placeholder = '__PLACEHOLDER'.$counter.'__';
+                    // create a unique placeholder name
+                    $placeholder = '__PLACEHOLDER'.$counter.'__';
                  
-                 // store the placeholder name to replace later
-                 $table[$placeholder] = $paramName;
+                    // store the placeholder name to replace later
+                    $table[$placeholder] = $paramName;
                  
-                 // add the placeholder to replace in the query string before parsing
-                 $placeholders[$paramName.'='] = $placeholder.'=';
+                    // add the placeholder to replace in the query string before parsing
+                    $placeholders[$paramName.'='] = $placeholder.'=';
                  
-                 $counter++;
+                    $counter++;
             }
             
             // next challenge: replacing the parameter names by placeholders
@@ -1501,23 +1501,23 @@ 
         
         foreach($parsed as $name => $value)
         {
-             $keep[$table[$name]] = $value;
+                $keep[$table[$name]] = $value;
         }
         
         return $keep;
     }
 
-   /**
-    * 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 === '') {
@@ -1543,14 +1543,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)) {
@@ -1572,12 +1572,12 @@ 
     
     protected static $eolChars;
 
-   /**
-    * Detects the most used end-of-line character in the subject string.
-    * 
-    * @param string $str 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 $str 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)) {
@@ -1589,27 +1589,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'),
+                ),
             );
         }
         
@@ -1637,13 +1637,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) 
@@ -1654,13 +1654,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)) {
@@ -1680,15 +1680,15 @@ 
         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
     {
         // The DateInterval::format() method does not recalculate carry 

src/FileHelper.php

Indentation +387 added lines, -387 removed lines

@@ -80,32 +80,32 @@ 
     
     const ERROR_CANNOT_OPEN_FILE_TO_DETECT_BOM = 340032;
     
-   /**
-    * Opens a serialized file and returns the unserialized data.
-    * 
-    * @param string $file
-    * @throws FileHelper_Exception
-    * @return array
-    * @deprecated Use parseSerializedFile() instead.
-    * @see FileHelper::parseSerializedFile()
-    */
+    /**
+     * Opens a serialized file and returns the unserialized data.
+     * 
+     * @param string $file
+     * @throws FileHelper_Exception
+     * @return array
+     * @deprecated Use parseSerializedFile() instead.
+     * @see FileHelper::parseSerializedFile()
+     */
     public static function openUnserialized(string $file) : array
     {
         return self::parseSerializedFile($file);
     }
 
-   /**
-    * Opens a serialized file and returns the unserialized data.
-    *
-    * @param string $file
-    * @throws FileHelper_Exception
-    * @return array
-    * @see FileHelper::parseSerializedFile()
-    * 
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
-    * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ
-    * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED
-    */
+    /**
+     * Opens a serialized file and returns the unserialized data.
+     *
+     * @param string $file
+     * @throws FileHelper_Exception
+     * @return array
+     * @see FileHelper::parseSerializedFile()
+     * 
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
+     * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ
+     * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED
+     */
     public static function parseSerializedFile(string $file)
     {
         self::requireFileExists($file);
@@ -174,13 +174,13 @@ 
         return rmdir($rootFolder);
     }
     
-   /**
-    * Create a folder, if it does not exist yet.
-    *  
-    * @param string $path
-    * @throws FileHelper_Exception
-    * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
-    */
+    /**
+     * Create a folder, if it does not exist yet.
+     *  
+     * @param string $path
+     * @throws FileHelper_Exception
+     * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
+     */
     public static function createFolder($path)
     {
         if(is_dir($path) || mkdir($path, 0777, true)) {
@@ -227,22 +227,22 @@ 
         }
     }
     
-   /**
-    * Copies a file to the target location. Includes checks
-    * for most error sources, like the source file not being
-    * readable. Automatically creates the target folder if it
-    * does not exist yet.
-    * 
-    * @param string $sourcePath
-    * @param string $targetPath
-    * @throws FileHelper_Exception
-    * 
-    * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
-    * @see FileHelper::ERROR_SOURCE_FILE_NOT_FOUND
-    * @see FileHelper::ERROR_SOURCE_FILE_NOT_READABLE
-    * @see FileHelper::ERROR_TARGET_COPY_FOLDER_NOT_WRITABLE
-    * @see FileHelper::ERROR_CANNOT_COPY_FILE
-    */
+    /**
+     * Copies a file to the target location. Includes checks
+     * for most error sources, like the source file not being
+     * readable. Automatically creates the target folder if it
+     * does not exist yet.
+     * 
+     * @param string $sourcePath
+     * @param string $targetPath
+     * @throws FileHelper_Exception
+     * 
+     * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
+     * @see FileHelper::ERROR_SOURCE_FILE_NOT_FOUND
+     * @see FileHelper::ERROR_SOURCE_FILE_NOT_READABLE
+     * @see FileHelper::ERROR_TARGET_COPY_FOLDER_NOT_WRITABLE
+     * @see FileHelper::ERROR_CANNOT_COPY_FILE
+     */
     public static function copyFile($sourcePath, $targetPath)
     {
         self::requireFileExists($sourcePath, self::ERROR_SOURCE_FILE_NOT_FOUND);
@@ -293,15 +293,15 @@ 
         );
     }
     
-   /**
-    * Deletes the target file. Ignored if it cannot be found,
-    * and throws an exception if it fails.
-    * 
-    * @param string $filePath
-    * @throws FileHelper_Exception
-    * 
-    * @see FileHelper::ERROR_CANNOT_DELETE_FILE
-    */
+    /**
+     * Deletes the target file. Ignored if it cannot be found,
+     * and throws an exception if it fails.
+     * 
+     * @param string $filePath
+     * @throws FileHelper_Exception
+     * 
+     * @see FileHelper::ERROR_CANNOT_DELETE_FILE
+     */
     public static function deleteFile(string $filePath) : void
     {
         if(!file_exists($filePath)) {
@@ -323,15 +323,15 @@ 
     }
 
     /**
-    * Creates a new CSV parser instance and returns it.
-    * 
-    * @param string $delimiter
-    * @param string $enclosure
-    * @param string $escape
-    * @param bool $heading
-    * @return \parseCSV
-    * @todo Move this to the CSV helper.
-    */
+     * Creates a new CSV parser instance and returns it.
+     * 
+     * @param string $delimiter
+     * @param string $enclosure
+     * @param string $escape
+     * @param bool $heading
+     * @return \parseCSV
+     * @todo Move this to the CSV helper.
+     */
     public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : \parseCSV
     {
         if($delimiter==='') { $delimiter = ';'; }
@@ -346,23 +346,23 @@ 
         return $parser;
     }
 
-   /**
-    * Parses all lines in the specified string and returns an
-    * indexed array with all csv values in each line.
-    *
-    * @param string $csv
-    * @param string $delimiter
-    * @param string $enclosure
-    * @param string $escape
-    * @param bool $heading
-    * @return array
-    * @throws FileHelper_Exception
-    * 
-    * @todo Move this to the CSVHelper.
-    *
-    * @see parseCSVFile()
-    * @see FileHelper::ERROR_PARSING_CSV
-    */
+    /**
+     * Parses all lines in the specified string and returns an
+     * indexed array with all csv values in each line.
+     *
+     * @param string $csv
+     * @param string $delimiter
+     * @param string $enclosure
+     * @param string $escape
+     * @param bool $heading
+     * @return array
+     * @throws FileHelper_Exception
+     * 
+     * @todo Move this to the CSVHelper.
+     *
+     * @see parseCSVFile()
+     * @see FileHelper::ERROR_PARSING_CSV
+     */
     public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array
     {
         $parser = self::createCSVParser($delimiter, $enclosure, $escape, $heading);
@@ -541,31 +541,31 @@ 
         );
     }
     
-   /**
-    * Verifies whether the target file is a PHP file. The path
-    * to the file can be a path to a file as a string, or a 
-    * DirectoryIterator object instance.
-    * 
-    * @param string|\DirectoryIterator $pathOrDirIterator
-    * @return boolean
-    */
+    /**
+     * Verifies whether the target file is a PHP file. The path
+     * to the file can be a path to a file as a string, or a 
+     * DirectoryIterator object instance.
+     * 
+     * @param string|\DirectoryIterator $pathOrDirIterator
+     * @return boolean
+     */
     public static function isPHPFile($pathOrDirIterator)
     {
-    	if(self::getExtension($pathOrDirIterator) == 'php') {
-    		return true;
-    	}
+        if(self::getExtension($pathOrDirIterator) == 'php') {
+            return true;
+        }
     	
-    	return false;
+        return false;
     }
     
-   /**
-    * Retrieves the extension of the specified file. Can be a path
-    * to a file as a string, or a DirectoryIterator object instance.
-    * 
-    * @param string|\DirectoryIterator $pathOrDirIterator
-    * @param bool $lowercase
-    * @return string
-    */
+    /**
+     * Retrieves the extension of the specified file. Can be a path
+     * to a file as a string, or a DirectoryIterator object instance.
+     * 
+     * @param string|\DirectoryIterator $pathOrDirIterator
+     * @param bool $lowercase
+     * @return string
+     */
     public static function getExtension($pathOrDirIterator, bool $lowercase = true) : string
     {
         if($pathOrDirIterator instanceof \DirectoryIterator) {
@@ -576,51 +576,51 @@ 
          
         $ext = pathinfo($filename, PATHINFO_EXTENSION);
         if($lowercase) {
-        	$ext = mb_strtolower($ext);
+            $ext = mb_strtolower($ext);
         }
         
         return $ext;
     }
     
-   /**
-    * Retrieves the file name from a path, with or without extension.
-    * The path to the file can be a string, or a DirectoryIterator object
-    * instance.
-    * 
-    * In case of folders, behaves like the pathinfo function: returns
-    * the name of the folder.
-    * 
-    * @param string|\DirectoryIterator $pathOrDirIterator
-    * @param bool $extension
-    * @return string
-    */
+    /**
+     * Retrieves the file name from a path, with or without extension.
+     * The path to the file can be a string, or a DirectoryIterator object
+     * instance.
+     * 
+     * In case of folders, behaves like the pathinfo function: returns
+     * the name of the folder.
+     * 
+     * @param string|\DirectoryIterator $pathOrDirIterator
+     * @param bool $extension
+     * @return string
+     */
     public static function getFilename($pathOrDirIterator, $extension = true)
     {
         $path = $pathOrDirIterator;
-    	if($pathOrDirIterator instanceof \DirectoryIterator) {
-    		$path = $pathOrDirIterator->getFilename();
-    	}
+        if($pathOrDirIterator instanceof \DirectoryIterator) {
+            $path = $pathOrDirIterator->getFilename();
+        }
     	
-    	$path = self::normalizePath($path);
+        $path = self::normalizePath($path);
     	
-    	if(!$extension) {
-    	    return pathinfo($path, PATHINFO_FILENAME);
-    	}
+        if(!$extension) {
+            return pathinfo($path, PATHINFO_FILENAME);
+        }
     	
-    	return pathinfo($path, PATHINFO_BASENAME); 
+        return pathinfo($path, PATHINFO_BASENAME); 
     }
    
-   /**
-    * Tries to read the contents of the target file and
-    * treat it as JSON to return the decoded JSON data.
-    * 
-    * @param string $file
-    * @throws FileHelper_Exception
-    * @return array
-    * 
-    * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE
-    * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE
-    */ 
+    /**
+     * Tries to read the contents of the target file and
+     * treat it as JSON to return the decoded JSON data.
+     * 
+     * @param string $file
+     * @throws FileHelper_Exception
+     * @return array
+     * 
+     * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE
+     * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE
+     */ 
     public static function parseJSONFile(string $file, $targetEncoding=null, $sourceEncoding=null)
     {
         self::requireFileExists($file, self::ERROR_CANNOT_FIND_JSON_FILE);
@@ -656,16 +656,16 @@ 
         return $json;
     }
     
-   /**
-    * Corrects common formatting mistakes when users enter
-    * file names, like too many spaces, dots and the like.
-    * 
-    * NOTE: if the file name contains a path, the path is
-    * stripped, leaving only the file name.
-    * 
-    * @param string $name
-    * @return string
-    */
+    /**
+     * Corrects common formatting mistakes when users enter
+     * file names, like too many spaces, dots and the like.
+     * 
+     * NOTE: if the file name contains a path, the path is
+     * stripped, leaving only the file name.
+     * 
+     * @param string $name
+     * @return string
+     */
     public static function fixFileName(string $name) : string
     {
         $name = trim($name);
@@ -695,60 +695,60 @@ 
         return $name;
     }
     
-   /**
-    * Creates an instance of the file finder, which is an easier
-    * alternative to the other manual findFile methods, since all
-    * options can be set by chaining.
-    * 
-    * @param string $path
-    * @return FileHelper_FileFinder
-    */
+    /**
+     * Creates an instance of the file finder, which is an easier
+     * alternative to the other manual findFile methods, since all
+     * options can be set by chaining.
+     * 
+     * @param string $path
+     * @return FileHelper_FileFinder
+     */
     public static function createFileFinder(string $path) : FileHelper_FileFinder
     {
         return new FileHelper_FileFinder($path);
     }
     
-   /**
-    * Searches for all HTML files in the target folder.
-    * 
-    * @param string $targetFolder
-    * @param array $options
-    * @return array An indexed array with files.
-    * @see FileHelper::createFileFinder()
-    * 
-    * @todo Convert this to use the file finder.
-    */
+    /**
+     * Searches for all HTML files in the target folder.
+     * 
+     * @param string $targetFolder
+     * @param array $options
+     * @return array An indexed array with files.
+     * @see FileHelper::createFileFinder()
+     * 
+     * @todo Convert this to use the file finder.
+     */
     public static function findHTMLFiles(string $targetFolder, array $options=array()) : array
     {
         return self::findFiles($targetFolder, array('html'), $options);
     }
 
-   /**
-    * Searches for all PHP files in the target folder.
-    * 
-    * @param string $targetFolder
-    * @param array $options
-    * @return array An indexed array of PHP files.
-    * @see FileHelper::createFileFinder()
-    * 
-    * @todo Convert this to use the file finder.
-    */
+    /**
+     * Searches for all PHP files in the target folder.
+     * 
+     * @param string $targetFolder
+     * @param array $options
+     * @return array An indexed array of PHP files.
+     * @see FileHelper::createFileFinder()
+     * 
+     * @todo Convert this to use the file finder.
+     */
     public static function findPHPFiles(string $targetFolder, array $options=array()) : array
     {
         return self::findFiles($targetFolder, array('php'), $options);
     }
     
-   /**
-    * 
-    * @param string $targetFolder
-    * @param array $extensions
-    * @param array $options
-    * @param array $files
-    * @throws FileHelper_Exception
-    * @return array
-    * @see FileHelper::createFileFinder()
-    * @todo Convert this to use the file finder. 
-    */
+    /**
+     * 
+     * @param string $targetFolder
+     * @param array $extensions
+     * @param array $options
+     * @param array $files
+     * @throws FileHelper_Exception
+     * @return array
+     * @see FileHelper::createFileFinder()
+     * @todo Convert this to use the file finder. 
+     */
     public static function findFiles(string $targetFolder, array $extensions=array(), array $options=array(), array $files=array()) : array
     {
         if(!isset($options['strip-extension'])) {
@@ -829,13 +829,13 @@ 
         return $files;
     }
 
-   /**
-    * Removes the extension from the specified path or file name,
-    * if any, and returns the name without the extension.
-    * 
-    * @param string $filename
-    * @return sTring
-    */
+    /**
+     * Removes the extension from the specified path or file name,
+     * if any, and returns the name without the extension.
+     * 
+     * @param string $filename
+     * @return sTring
+     */
     public static function removeExtension(string $filename) : string
     {
         // normalize paths to allow windows style slashes even on nix servers
@@ -844,22 +844,22 @@ 
         return pathinfo($filename, PATHINFO_FILENAME);
     }
     
-   /**
-    * Detects the UTF BOM in the target file, if any. Returns
-    * the encoding matching the BOM, which can be any of the
-    * following:
-    * 
-    * <ul>
-    * <li>UTF32-BE</li>
-    * <li>UTF32-LE</li>
-    * <li>UTF16-BE</li>
-    * <li>UTF16-LE</li>
-    * <li>UTF8</li>
-    * </ul>
-    * 
-    * @param string $filename
-    * @return string|NULL
-    */
+    /**
+     * Detects the UTF BOM in the target file, if any. Returns
+     * the encoding matching the BOM, which can be any of the
+     * following:
+     * 
+     * <ul>
+     * <li>UTF32-BE</li>
+     * <li>UTF32-LE</li>
+     * <li>UTF16-BE</li>
+     * <li>UTF16-LE</li>
+     * <li>UTF8</li>
+     * </ul>
+     * 
+     * @param string $filename
+     * @return string|NULL
+     */
     public static function detectUTFBom(string $filename) : ?string
     {
         $fp = fopen($filename, 'r');
@@ -891,13 +891,13 @@ 
     
     protected static $utfBoms;
     
-   /**
-    * Retrieves a list of all UTF byte order mark character
-    * sequences, as an assocative array with UTF encoding => bom sequence
-    * pairs.
-    * 
-    * @return array
-    */
+    /**
+     * Retrieves a list of all UTF byte order mark character
+     * sequences, as an assocative array with UTF encoding => bom sequence
+     * pairs.
+     * 
+     * @return array
+     */
     public static function getUTFBOMs()
     {
         if(!isset(self::$utfBoms)) {
@@ -913,15 +913,15 @@ 
         return self::$utfBoms;
     }
     
-   /**
-    * Checks whether the specified encoding is a valid
-    * unicode encoding, for example "UTF16-LE" or "UTF8".
-    * Also accounts for alternate way to write the, like
-    * "UTF-8", and omitting little/big endian suffixes.
-    * 
-    * @param string $encoding
-    * @return boolean
-    */
+    /**
+     * Checks whether the specified encoding is a valid
+     * unicode encoding, for example "UTF16-LE" or "UTF8".
+     * Also accounts for alternate way to write the, like
+     * "UTF-8", and omitting little/big endian suffixes.
+     * 
+     * @param string $encoding
+     * @return boolean
+     */
     public static function isValidUnicodeEncoding(string $encoding) : bool
     {
         $encodings = self::getKnownUnicodeEncodings();
@@ -940,22 +940,22 @@ 
         return in_array($encoding, $keep);
     }
     
-   /**
-    * Retrieves a list of all known unicode file encodings.
-    * @return array
-    */
+    /**
+     * Retrieves a list of all known unicode file encodings.
+     * @return array
+     */
     public static function getKnownUnicodeEncodings()
     {
         return array_keys(self::getUTFBOMs());
     }
     
-   /**
-    * Normalizes the slash style in a file or folder path,
-    * by replacing any antislashes with forward slashes.
-    * 
-    * @param string $path
-    * @return string
-    */
+    /**
+     * Normalizes the slash style in a file or folder path,
+     * by replacing any antislashes with forward slashes.
+     * 
+     * @param string $path
+     * @return string
+     */
     public static function normalizePath(string $path) : string
     {
         return str_replace(array('\\', '//'), array('/', '/'), $path);
@@ -988,18 +988,18 @@ 
         }
     }
    
-   /**
-    * Saves the specified content to the target file, creating
-    * the file and the folder as necessary.
-    * 
-    * @param string $filePath
-    * @param string $content
-    * @throws FileHelper_Exception
-    * 
-    * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE
-    * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
-    * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
-    */
+    /**
+     * Saves the specified content to the target file, creating
+     * the file and the folder as necessary.
+     * 
+     * @param string $filePath
+     * @param string $content
+     * @throws FileHelper_Exception
+     * 
+     * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE
+     * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
+     * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
+     */
     public static function saveFile(string $filePath, string $content='') : void
     {
         // target file already exists
@@ -1052,12 +1052,12 @@ 
         );
     }
     
-   /**
-    * Checks whether it is possible to run PHP command 
-    * line commands.
-    * 
-    * @return boolean
-    */
+    /**
+     * Checks whether it is possible to run PHP command 
+     * line commands.
+     * 
+     * @return boolean
+     */
     public static function canMakePHPCalls() : bool
     {
         return self::cliCommandExists('php');
@@ -1132,16 +1132,16 @@ 
         return $result;
     }
     
-   /**
-    * Validates a PHP file's syntax.
-    * 
-    * NOTE: This will fail silently if the PHP command line
-    * is not available. Use {@link FileHelper::canMakePHPCalls()}
-    * to check this beforehand as needed.
-    * 
-    * @param string $path
-    * @return boolean|array A boolean true if the file is valid, an array with validation messages otherwise.
-    */
+    /**
+     * Validates a PHP file's syntax.
+     * 
+     * NOTE: This will fail silently if the PHP command line
+     * is not available. Use {@link FileHelper::canMakePHPCalls()}
+     * to check this beforehand as needed.
+     * 
+     * @param string $path
+     * @return boolean|array A boolean true if the file is valid, an array with validation messages otherwise.
+     */
     public static function checkPHPFileSyntax($path)
     {
         if(!self::canMakePHPCalls()) {
@@ -1165,14 +1165,14 @@ 
         return $output;
     }
     
-   /**
-    * Retrieves the last modified date for the specified file or folder.
-    * 
-    * Note: If the target does not exist, returns null. 
-    * 
-    * @param string $path
-    * @return \DateTime|NULL
-    */
+    /**
+     * Retrieves the last modified date for the specified file or folder.
+     * 
+     * Note: If the target does not exist, returns null. 
+     * 
+     * @param string $path
+     * @return \DateTime|NULL
+     */
     public static function getModifiedDate($path)
     {
         $time = filemtime($path);
@@ -1185,22 +1185,22 @@ 
         return null; 
     }
     
-   /**
-    * Retrieves the names of all subfolders in the specified path.
-    * 
-    * Available options:
-    * 
-    * - recursive: true/false
-    *   Whether to search for subfolders recursively. 
-    *   
-    * - absolute-paths: true/false
-    *   Whether to return a list of absolute paths.
-    * 
-    * @param string $targetFolder
-    * @param array $options
-    * @throws FileHelper_Exception
-    * @return string[]
-    */
+    /**
+     * Retrieves the names of all subfolders in the specified path.
+     * 
+     * Available options:
+     * 
+     * - recursive: true/false
+     *   Whether to search for subfolders recursively. 
+     *   
+     * - absolute-paths: true/false
+     *   Whether to return a list of absolute paths.
+     * 
+     * @param string $targetFolder
+     * @param array $options
+     * @throws FileHelper_Exception
+     * @return string[]
+     */
     public static function getSubfolders($targetFolder, $options = array())
     {
         if(!is_dir($targetFolder)) 
@@ -1261,16 +1261,16 @@ 
         return $result;
     }
 
-   /**
-    * Retrieves the maximum allowed upload file size, in bytes.
-    * Takes into account the PHP ini settings <code>post_max_size</code>
-    * and <code>upload_max_filesize</code>. Since these cannot
-    * be modified at runtime, they are the hard limits for uploads.
-    * 
-    * NOTE: Based on binary values, where 1KB = 1024 Bytes.
-    * 
-    * @return int Will return <code>-1</code> if no limit.
-    */
+    /**
+     * Retrieves the maximum allowed upload file size, in bytes.
+     * Takes into account the PHP ini settings <code>post_max_size</code>
+     * and <code>upload_max_filesize</code>. Since these cannot
+     * be modified at runtime, they are the hard limits for uploads.
+     * 
+     * NOTE: Based on binary values, where 1KB = 1024 Bytes.
+     * 
+     * @return int Will return <code>-1</code> if no limit.
+     */
     public static function getMaxUploadFilesize() : int
     {
         static $max_size = -1;
@@ -1307,16 +1307,16 @@ 
         return round($size);
     }
    
-   /**
-    * Makes a path relative using a folder depth: will reduce the
-    * length of the path so that only the amount of folders defined
-    * in the <code>$depth</code> attribute are shown below the actual
-    * folder or file in the path.
-    *  
-    * @param string  $path The absolute or relative path
-    * @param int $depth The folder depth to reduce the path to
-    * @return string
-    */
+    /**
+     * Makes a path relative using a folder depth: will reduce the
+     * length of the path so that only the amount of folders defined
+     * in the <code>$depth</code> attribute are shown below the actual
+     * folder or file in the path.
+     *  
+     * @param string  $path The absolute or relative path
+     * @param int $depth The folder depth to reduce the path to
+     * @return string
+     */
     public static function relativizePathByDepth(string $path, int $depth=2) : string
     {
         $path = self::normalizePath($path);
@@ -1354,23 +1354,23 @@ 
         return trim(implode('/', $tokens), '/');
     }
     
-   /**
-    * Makes the specified path relative to another path,
-    * by removing one from the other if found. Also 
-    * normalizes the path to use forward slashes. 
-    * 
-    * Example:
-    * 
-    * <pre>
-    * relativizePath('c:\some\folder\to\file.txt', 'c:\some\folder');
-    * </pre>
-    * 
-    * Result: <code>to/file.txt</code>
-    * 
-    * @param string $path
-    * @param string $relativeTo
-    * @return string
-    */
+    /**
+     * Makes the specified path relative to another path,
+     * by removing one from the other if found. Also 
+     * normalizes the path to use forward slashes. 
+     * 
+     * Example:
+     * 
+     * <pre>
+     * relativizePath('c:\some\folder\to\file.txt', 'c:\some\folder');
+     * </pre>
+     * 
+     * Result: <code>to/file.txt</code>
+     * 
+     * @param string $path
+     * @param string $relativeTo
+     * @return string
+     */
     public static function relativizePath(string $path, string $relativeTo) : string
     {
         $path = self::normalizePath($path);
@@ -1382,17 +1382,17 @@ 
         return $relative;
     }
     
-   /**
-    * Checks that the target file exists, and throws an exception
-    * if it does not. 
-    * 
-    * @param string $path
-    * @param int|NULL $errorCode Optional custom error code
-    * @throws FileHelper_Exception
-    * @return string The real path to the file
-    * 
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
-    */
+    /**
+     * Checks that the target file exists, and throws an exception
+     * if it does not. 
+     * 
+     * @param string $path
+     * @param int|NULL $errorCode Optional custom error code
+     * @throws FileHelper_Exception
+     * @return string The real path to the file
+     * 
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
+     */
     public static function requireFileExists(string $path, $errorCode=null) : string
     {
         $result = realpath($path);
@@ -1411,18 +1411,18 @@ 
         );
     }
     
-   /**
-    * Reads a specific line number from the target file and returns its
-    * contents, if the file has such a line. Does so with little memory
-    * usage, as the file is not read entirely into memory.
-    * 
-    * @param string $path
-    * @param int $lineNumber Note: 1-based; the first line is number 1.
-    * @return string|NULL Will return null if the requested line does not exist.
-    * @throws FileHelper_Exception
-    * 
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
-    */
+    /**
+     * Reads a specific line number from the target file and returns its
+     * contents, if the file has such a line. Does so with little memory
+     * usage, as the file is not read entirely into memory.
+     * 
+     * @param string $path
+     * @param int $lineNumber Note: 1-based; the first line is number 1.
+     * @return string|NULL Will return null if the requested line does not exist.
+     * @throws FileHelper_Exception
+     * 
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
+     */
     public static function getLineFromFile(string $path, int $lineNumber) : ?string
     {
         self::requireFileExists($path);
@@ -1438,19 +1438,19 @@ 
         $file->seek($targetLine);
         
         if($file->key() !== $targetLine) {
-             return null;
+                return null;
         }
         
         return $file->current(); 
     }
     
-   /**
-    * Retrieves the total amount of lines in the file, without 
-    * reading the whole file into memory.
-    * 
-    * @param string $path
-    * @return int
-    */
+    /**
+     * Retrieves the total amount of lines in the file, without 
+     * reading the whole file into memory.
+     * 
+     * @param string $path
+     * @return int
+     */
     public static function countFileLines(string $path) : int
     {
         self::requireFileExists($path);
@@ -1480,26 +1480,26 @@ 
         return $number+1;
     }
     
-   /**
-    * Parses the target file to detect any PHP classes contained
-    * within, and retrieve information on them. Does not use the 
-    * PHP reflection API.
-    * 
-    * @param string $filePath
-    * @return FileHelper_PHPClassInfo
-    */
+    /**
+     * Parses the target file to detect any PHP classes contained
+     * within, and retrieve information on them. Does not use the 
+     * PHP reflection API.
+     * 
+     * @param string $filePath
+     * @return FileHelper_PHPClassInfo
+     */
     public static function findPHPClasses(string $filePath) : FileHelper_PHPClassInfo
     {
         return new FileHelper_PHPClassInfo($filePath);
     }
     
-   /**
-    * Detects the end of line style used in the target file, if any.
-    * Can be used with large files, because it only reads part of it.
-    * 
-    * @param string $filePath The path to the file.
-    * @return NULL|ConvertHelper_EOL The end of line character information, or NULL if none is found.
-    */
+    /**
+     * Detects the end of line style used in the target file, if any.
+     * Can be used with large files, because it only reads part of it.
+     * 
+     * @param string $filePath The path to the file.
+     * @return NULL|ConvertHelper_EOL The end of line character information, or NULL if none is found.
+     */
     public static function detectEOLCharacter(string $filePath) : ?ConvertHelper_EOL
     {
         // 20 lines is enough to get a good picture of the newline style in the file.
@@ -1512,18 +1512,18 @@ 
         return ConvertHelper::detectEOLCharacter($string);
     }
     
-   /**
-    * Reads the specified amount of lines from the target file.
-    * Unicode BOM compatible: any byte order marker is stripped
-    * from the resulting lines.
-    * 
-    * @param string $filePath
-    * @param int $amount Set to 0 to read all lines.
-    * @return array
-    * 
-    * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
-    */
+    /**
+     * Reads the specified amount of lines from the target file.
+     * Unicode BOM compatible: any byte order marker is stripped
+     * from the resulting lines.
+     * 
+     * @param string $filePath
+     * @param int $amount Set to 0 to read all lines.
+     * @return array
+     * 
+     * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
+     */
     public static function readLines(string $filePath, int $amount=0) : array
     {
         self::requireFileExists($filePath);
@@ -1574,16 +1574,16 @@ 
         return $result;
     }
     
-   /**
-    * Reads all content from a file.
-    * 
-    * @param string $filePath
-    * @throws FileHelper_Exception
-    * @return string
-    * 
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
-    * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS
-    */
+    /**
+     * Reads all content from a file.
+     * 
+     * @param string $filePath
+     * @throws FileHelper_Exception
+     * @return string
+     * 
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
+     * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS
+     */
     public static function readContents(string $filePath) : string
     {
         self::requireFileExists($filePath);