Mistralys / application-utils

src/ConvertHelper/QueryParser.php

Indentation +10 added lines, -10 removed lines

@@ -27,16 +27,16 @@
         
     }
     
-   /**
-    * We parse the query string ourselves, because the PHP implementation
-    * of parse_str has limitations that do not apply to query strings. This
-    * is due to the fact that parse_str has to create PHP-compatible variable
-    * names from the parameters. URL parameters simply allow way more things
-    * than PHP variable names.
-    * 
-    * @param string $queryString
-    * @return array
-    */
+    /**
+     * We parse the query string ourselves, because the PHP implementation
+     * of parse_str has limitations that do not apply to query strings. This
+     * is due to the fact that parse_str has to create PHP-compatible variable
+     * names from the parameters. URL parameters simply allow way more things
+     * than PHP variable names.
+     * 
+     * @param string $queryString
+     * @return array
+     */
     public function parse(string $queryString) : array
     {
         // allow HTML entities notation

src/URLInfo.php

Indentation +177 added lines, -177 removed lines

@@ -39,42 +39,42 @@ 
     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 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',
@@ -86,24 +86,24 @@ 
         'fragment'
     );
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $url;
     
-   /**
-    * @var URLInfo_Parser
-    */
+    /**
+     * @var URLInfo_Parser
+     */
     protected $parser;
     
-   /**
-    * @var URLInfo_Normalizer
-    */
+    /**
+     * @var URLInfo_Normalizer
+     */
     protected $normalizer;
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected $encodeUTFChars = false;
     
     public function __construct(string $url)
@@ -120,14 +120,14 @@ 
         $this->info = $this->parser->getInfo();
     }
     
-   /**
-    * Whether to URL encode any non-encoded UTF8 characters in the URL.
-    * Default is to leave them as-is for better readability, since 
-    * browsers handle this well.
-    * 
-    * @param bool $enabled
-    * @return URLInfo
-    */
+    /**
+     * Whether to URL encode any non-encoded UTF8 characters in the URL.
+     * Default is to leave them as-is for better readability, since 
+     * browsers handle this well.
+     * 
+     * @param bool $enabled
+     * @return URLInfo
+     */
     public function setUTFEncoding(bool $enabled=true) : URLInfo
     {
         if($this->encodeUTFChars !== $enabled)
@@ -144,13 +144,13 @@ 
         return $this->encodeUTFChars;
     }
     
-   /**
-    * 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)
     {
         return URLInfo_Filter::filter($url);
@@ -180,12 +180,12 @@ 
         return $this->info['type'] === self::TYPE_PHONE;
     }
     
-   /**
-    * Whether the URL is a regular URL, not one of the 
-    * other types like a phone number or email address.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether the URL is a regular URL, not one of the 
+     * other types like a phone number or email address.
+     * 
+     * @return bool
+     */
     public function isURL() : bool
     {
         $host = $this->getHost();
@@ -197,20 +197,20 @@ 
         return $this->parser->isValid();
     }
     
-   /**
-    * Retrieves the host name, or an empty string if none is present.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the host name, or an empty string if none is present.
+     * 
+     * @return string
+     */
     public function getHost() : string
     {
         return $this->getInfoKey('host');
     }
     
-   /**
-    * Retrieves the path, or an empty string if none is present.
-    * @return string
-    */
+    /**
+     * Retrieves the path, or an empty string if none is present.
+     * @return string
+     */
     public function getPath() : string
     {
         return $this->getInfoKey('path');
@@ -226,10 +226,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');
@@ -241,13 +241,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');
@@ -263,20 +263,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();
@@ -321,23 +321,23 @@ 
         return '';
     }
 
-   /**
-    * Retrieves a normalized URL: this ensures that all parameters
-    * in the URL are always in the same order.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves a normalized URL: this ensures that all parameters
+     * in the URL are always in the same order.
+     * 
+     * @return string
+     */
     public function getNormalized() : string
     {
         return $this->normalize(true);
     }
     
-   /**
-    * Like getNormalized(), but if a username and password are present
-    * in the URL, returns the URL without them.
-    * 
-    * @return string
-    */
+    /**
+     * Like getNormalized(), but if a username and password are present
+     * in the URL, returns the URL without them.
+     * 
+     * @return string
+     */
     public function getNormalizedWithoutAuth() : string
     {
         return $this->normalize(false);
@@ -358,25 +358,25 @@ 
         return $this->normalizer->normalize();
     }
     
-   /**
-    * Creates a hash of the URL, which can be used for comparisons.
-    * Since any parameters in the URL's query are sorted alphabetically,
-    * the same links with a different parameter order will have the 
-    * same hash.
-    * 
-    * @return string
-    */
+    /**
+     * Creates a hash of the URL, which can be used for comparisons.
+     * Since any parameters in the URL's query are sorted alphabetically,
+     * the same links with a different parameter order will have the 
+     * same hash.
+     * 
+     * @return string
+     */
     public function getHash()
     {
         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()) {
@@ -410,15 +410,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)) {
@@ -436,22 +436,22 @@ 
         return $keep;
     }
     
-   /**
-    * Retrieves the names of all parameters present in the URL, if any.
-    * @return string[]
-    */
+    /**
+     * Retrieves the names of all parameters present in the URL, if any.
+     * @return string[]
+     */
     public function getParamNames() : array
     {
         $params = $this->getParams();
         return array_keys($params);
     }
     
-   /**
-    * Retrieves a specific parameter value from the URL.
-    * 
-    * @param string $name
-    * @return string The parameter value, or an empty string if it does not exist.
-    */
+    /**
+     * Retrieves a specific parameter value from the URL.
+     * 
+     * @param string $name
+     * @return string The parameter value, or an empty string if it does not exist.
+     */
     public function getParam(string $name) : string
     {
         if(isset($this->info['params'][$name])) {
@@ -461,16 +461,16 @@ 
         return '';
     }
     
-   /**
-    * 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]))
@@ -523,25 +523,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(
@@ -585,24 +585,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)) {
@@ -670,16 +670,16 @@ 
         return $this->highlightExcluded;
     }
     
-   /**
-    * Checks if the URL exists, i.e. can be connected to. Will return
-    * true if the returned HTTP status code is `200` or `302`.
-    * 
-    * NOTE: If the target URL requires HTTP authentication, the username
-    * and password should be integrated into the URL.
-    * 
-    * @return bool
-    * @throws BaseException
-    */
+    /**
+     * Checks if the URL exists, i.e. can be connected to. Will return
+     * true if the returned HTTP status code is `200` or `302`.
+     * 
+     * NOTE: If the target URL requires HTTP authentication, the username
+     * and password should be integrated into the URL.
+     * 
+     * @return bool
+     * @throws BaseException
+     */
     public function tryConnect(bool $verifySSL=true) : bool
     {
         requireCURL();

src/URLInfo/Parser.php

Indentation +73 added lines, -73 removed lines

@@ -23,24 +23,24 @@ 
  */
 class URLInfo_Parser
 {
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $url;
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected $isValid = false;
     
-   /**
-    * @var array
-    */
+    /**
+     * @var array
+     */
     protected $info;
     
-   /**
-    * @var array|NULL
-    */
+    /**
+     * @var array|NULL
+     */
     protected $error;
     
     /**
@@ -56,25 +56,25 @@ 
         'file'
     );
     
-   /**
-    * Stores a list of all unicode characters in the URL
-    * that have been filtered out before parsing it with
-    * parse_url.
-    * 
-    * @var string[]string
-    */
+    /**
+     * Stores a list of all unicode characters in the URL
+     * that have been filtered out before parsing it with
+     * parse_url.
+     * 
+     * @var string[]string
+     */
     protected $unicodeChars = array();
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected $encodeUTF = false;
     
-   /**
-    * 
-    * @param string $url The target URL.
-    * @param bool $encodeUTF Whether to URL encode any plain text unicode characters.
-    */
+    /**
+     * 
+     * @param string $url The target URL.
+     * @param bool $encodeUTF Whether to URL encode any plain text unicode characters.
+     */
     public function __construct(string $url, bool $encodeUTF)
     {
         $this->url = $url;
@@ -87,12 +87,12 @@ 
         }
     }
 
-   /**
-    * Retrieves the array as parsed by PHP's parse_url,
-    * filtered and adjusted as necessary.
-    * 
-    * @return array
-    */
+    /**
+     * Retrieves the array as parsed by PHP's parse_url,
+     * filtered and adjusted as necessary.
+     * 
+     * @return array
+     */
     public function getInfo() : array
     {
         return $this->info;
@@ -114,11 +114,11 @@ 
         }
     }
     
-   /**
-    * Finds any non-url encoded unicode characters in 
-    * the URL, and encodes them before the URL is 
-    * passed to parse_url.
-    */
+    /**
+     * Finds any non-url encoded unicode characters in 
+     * the URL, and encodes them before the URL is 
+     * passed to parse_url.
+     */
     protected function filterUnicodeChars() : void
     {
         $chars = \AppUtils\ConvertHelper::string2array($this->url);
@@ -236,11 +236,11 @@ 
         return false;
     }
 
-   /**
-    * 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()
     {
         $this->info['params'] = array();
@@ -269,13 +269,13 @@ 
         }
     }
     
-   /**
-    * Recursively goes through the array, and converts all previously
-    * URL encoded characters with their unicode character counterparts.
-    * 
-    * @param array $subject
-    * @return array
-    */
+    /**
+     * Recursively goes through the array, and converts all previously
+     * URL encoded characters with their unicode character counterparts.
+     * 
+     * @param array $subject
+     * @return array
+     */
     protected function restoreUnicodeChars(array $subject) : array
     {
         $result = array();
@@ -299,13 +299,13 @@ 
         return $result;
     }
     
-   /**
-    * Replaces all URL encoded unicode characters
-    * in the string with the unicode character.
-    * 
-    * @param string $string
-    * @return string
-    */
+    /**
+     * Replaces all URL encoded unicode characters
+     * in the string with the unicode character.
+     * 
+     * @param string $string
+     * @return string
+     */
     protected function restoreUnicodeChar(string $string) : string
     {
         if(strstr($string, '%'))
@@ -363,21 +363,21 @@ 
         );
     }
    
-   /**
-    * Checks whether the URL that was parsed is valid.
-    * @return bool
-    */
+    /**
+     * Checks whether the URL that was parsed is valid.
+     * @return bool
+     */
     public function isValid() : bool
     {
         return $this->isValid;
     }
 
-   /**
-    * If the validation failed, retrieves the validation
-    * error message.
-    * 
-    * @return string
-    */
+    /**
+     * If the validation failed, retrieves the validation
+     * error message.
+     * 
+     * @return string
+     */
     public function getErrorMessage() : string
     {
         if(isset($this->error)) {
@@ -387,12 +387,12 @@ 
         return '';
     }
     
-   /**
-    * If the validation failed, retrieves the validation
-    * error code.
-    * 
-    * @return int
-    */
+    /**
+     * If the validation failed, retrieves the validation
+     * error code.
+     * 
+     * @return int
+     */
     public function getErrorCode() : int
     {
         if(isset($this->error)) {

src/ConvertHelper/ControlCharacters.php

Indentation +43 added lines, -43 removed lines

@@ -22,9 +22,9 @@ 
 {
     const ERROR_MALFORMATTED_STRING = 53801;
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected static $controlChars =  array(
         '0000-0008', // control chars
         '000E-000F', // control chars
@@ -32,19 +32,19 @@ 
         '2000-200F', // non-breaking space and co
     );
     
-   /**
-    * @var string|NULL
-    */
+    /**
+     * @var string|NULL
+     */
     protected static $controlCharsRegex;
 
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected static $hexAlphabet = array('0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F');
     
-   /**
-    * @var string[]|NULL
-    */
+    /**
+     * @var string[]|NULL
+     */
     protected static $charsAsHex;
     
     public function __construct()
@@ -67,13 +67,13 @@ 
         }
     }
     
-   /**
-    * 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 function getCharsAsHex() : array
     {
         if (isset(self::$charsAsHex))
@@ -120,13 +120,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 function getCharsAsUTF8() : array
     {
         $chars = $this->getCharsAsHex();
@@ -139,12 +139,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 function getCharsAsJSON() : array
     {
         $chars = $this->getCharsAsHex();
@@ -157,17 +157,17 @@ 
         return $result;
     }
     
-   /**
-    * Removes all control characters from the specified string
-    * that can cause problems in some cases, like creating
-    * valid XML documents. This includes invisible non-breaking
-    * spaces.
-    *
-    * @param string $string
-    * @return string
-    * @see https://stackoverflow.com/a/8171868/2298192
-    * @see https://unicode-table.com/en
-    */
+    /**
+     * Removes all control characters from the specified string
+     * that can cause problems in some cases, like creating
+     * valid XML documents. This includes invisible non-breaking
+     * spaces.
+     *
+     * @param string $string
+     * @return string
+     * @see https://stackoverflow.com/a/8171868/2298192
+     * @see https://unicode-table.com/en
+     */
     public function stripControlCharacters(string $string) : string
     {
         if(empty($string)) 

src/ConvertHelper.php

Indentation +483 added lines, -483 removed lines

@@ -58,13 +58,13 @@ 
         return str_replace("\t", str_repeat(' ', $tabSize), $string);
     }
     
-   /**
-    * Converts spaces to tabs in the specified string.
-    * 
-    * @param string $string
-    * @param int $tabSize The amount of spaces per tab in the source string.
-    * @return string
-    */
+    /**
+     * Converts spaces to tabs in the specified string.
+     * 
+     * @param string $string
+     * @param int $tabSize The amount of spaces per tab in the source string.
+     * @return string
+     */
     public static function spaces2tabs(string $string, int $tabSize=4) : string
     {
         return str_replace(str_repeat(' ', $tabSize), "\t", $string);
@@ -77,14 +77,14 @@ 
         return $converter->convert($string);
     }
     
-   /**
-    * Converts the specified amount of seconds into
-    * a human readable string split in months, weeks,
-    * days, hours, minutes and seconds.
-    *
-    * @param float $seconds
-    * @return string
-    */
+    /**
+     * Converts the specified amount of seconds into
+     * a human readable string split in months, weeks,
+     * days, hours, minutes and seconds.
+     *
+     * @param float $seconds
+     * @return string
+     */
     public static function time2string($seconds)
     {
         static $units = null;
@@ -156,41 +156,41 @@ 
         return implode(', ', $tokens) . ' ' . t('and') . ' ' . $last;
     }
 
-   /**
-    * Converts a timestamp into an easily understandable
-    * format, e.g. "2 hours", "1 day", "3 months"
-    *
-    * If you set the date to parameter, the difference
-    * will be calculated between the two dates and not
-    * the current time.
-    *
-    * @param integer|\DateTime $datefrom
-    * @param integer|\DateTime $dateto
-    * @return string
-    */
+    /**
+     * Converts a timestamp into an easily understandable
+     * format, e.g. "2 hours", "1 day", "3 months"
+     *
+     * If you set the date to parameter, the difference
+     * will be calculated between the two dates and not
+     * the current time.
+     *
+     * @param integer|\DateTime $datefrom
+     * @param integer|\DateTime $dateto
+     * @return string
+     */
     public static function duration2string($datefrom, $dateto = -1) : string
     {
-         $converter = new ConvertHelper_DurationConverter();
+            $converter = new ConvertHelper_DurationConverter();
          
-         if($datefrom instanceof \DateTime)
-         {
-             $converter->setDateFrom($datefrom);
-         }
-         else
-         {
-             $converter->setDateFrom(self::timestamp2date($datefrom)); 
-         }
+            if($datefrom instanceof \DateTime)
+            {
+                $converter->setDateFrom($datefrom);
+            }
+            else
+            {
+                $converter->setDateFrom(self::timestamp2date($datefrom)); 
+            }
 
-         if($dateto instanceof \DateTime)
-         {
-             $converter->setDateTo($dateto);
-         }
-         else if($dateto > 0)
-         {
-             $converter->setDateTo(self::timestamp2date($dateto));
-         }
+            if($dateto instanceof \DateTime)
+            {
+                $converter->setDateTo($dateto);
+            }
+            else if($dateto > 0)
+            {
+                $converter->setDateTo(self::timestamp2date($dateto));
+            }
 
-         return $converter->convert();
+            return $converter->convert();
     }
 
     /**
@@ -229,44 +229,44 @@ 
         return $geshi->parse_code();
     }
     
-   /**
-    * Converts a number of bytes to a human readable form,
-    * e.g. xx Kb / xx Mb / xx Gb
-    *
-    * @param int $bytes The amount of bytes to convert.
-    * @param int $precision The amount of decimals
-    * @param int $base The base to calculate with: Base 10 is default (=1000 Bytes in a KB), Base 2 is mainly used for Windows memory (=1024 Bytes in a KB).
-    * @return string
-    * 
-    * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions
-    */
+    /**
+     * Converts a number of bytes to a human readable form,
+     * e.g. xx Kb / xx Mb / xx Gb
+     *
+     * @param int $bytes The amount of bytes to convert.
+     * @param int $precision The amount of decimals
+     * @param int $base The base to calculate with: Base 10 is default (=1000 Bytes in a KB), Base 2 is mainly used for Windows memory (=1024 Bytes in a KB).
+     * @return string
+     * 
+     * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions
+     */
     public static function bytes2readable(int $bytes, int $precision = 1, int $base = ConvertHelper_StorageSizeEnum::BASE_10) : string
     {
         return self::parseBytes($bytes)->toString($precision, $base);
     }
     
-   /**
-    * Parses a number of bytes, and creates a converter instance which
-    * allows doing common operations with it.
-    * 
-    * @param int $bytes
-    * @return ConvertHelper_ByteConverter
-    */
+    /**
+     * Parses a number of bytes, and creates a converter instance which
+     * allows doing common operations with it.
+     * 
+     * @param int $bytes
+     * @return ConvertHelper_ByteConverter
+     */
     public static function parseBytes(int $bytes) : ConvertHelper_ByteConverter
     {
         return new ConvertHelper_ByteConverter($bytes);
     }
 
-   /**
-    * Cuts a text to the specified length if it is longer than the
-    * target length. Appends a text to signify it has been cut at 
-    * the end of the string.
-    * 
-    * @param string $text
-    * @param int $targetLength
-    * @param string $append
-    * @return string
-    */
+    /**
+     * Cuts a text to the specified length if it is longer than the
+     * target length. Appends a text to signify it has been cut at 
+     * the end of the string.
+     * 
+     * @param string $text
+     * @param int $targetLength
+     * @param string $append
+     * @return string
+     */
     public static function text_cut(string $text, int $targetLength, string $append = '...') : string
     {
         $length = mb_strlen($text);
@@ -290,14 +290,14 @@ 
         return $info->toString();
     }
     
-   /**
-    * Pretty print_r.
-    * 
-    * @param mixed $var The variable to dump.
-    * @param bool $return Whether to return the dumped code.
-    * @param bool $html Whether to style the dump as HTML.
-    * @return string
-    */
+    /**
+     * Pretty print_r.
+     * 
+     * @param mixed $var The variable to dump.
+     * @param bool $return Whether to return the dumped code.
+     * @param bool $html Whether to style the dump as HTML.
+     * @return string
+     */
     public static function print_r($var, bool $return=false, bool $html=true) : string
     {
         $result = parseVariable($var)->enableType()->toString();
@@ -327,15 +327,15 @@ 
         'no' => false
     );
 
-   /**
-    * Converts a string, number or boolean value to a boolean value.
-    * 
-    * @param mixed $string
-    * @throws ConvertHelper_Exception
-    * @return bool
-    * 
-    * @see ConvertHelper::ERROR_INVALID_BOOLEAN_STRING
-    */
+    /**
+     * Converts a string, number or boolean value to a boolean value.
+     * 
+     * @param mixed $string
+     * @throws ConvertHelper_Exception
+     * @return bool
+     * 
+     * @see ConvertHelper::ERROR_INVALID_BOOLEAN_STRING
+     */
     public static function string2bool($string) : bool
     {
         if($string === '' || $string === null || !is_scalar($string)) 
@@ -363,27 +363,27 @@ 
         );
     }
     
-   /**
-    * Whether the specified string is a boolean string or boolean value.
-    * Alias for {@link ConvertHelper::isBoolean()}.
-    * 
-    * @param mixed $string
-    * @return bool
-    * @deprecated
-    * @see ConvertHelper::isBoolean()
-    */
+    /**
+     * Whether the specified string is a boolean string or boolean value.
+     * Alias for {@link ConvertHelper::isBoolean()}.
+     * 
+     * @param mixed $string
+     * @return bool
+     * @deprecated
+     * @see ConvertHelper::isBoolean()
+     */
     public static function isBooleanString($string) : bool
     {
         return self::isBoolean($string);
     }
 
-   /**
-    * Alias for the {@\AppUtils\XMLHelper::string2xml()} method.
-    * 
-    * @param string $text
-    * @return string
-    * @deprecated
-    */
+    /**
+     * Alias for the {@\AppUtils\XMLHelper::string2xml()} method.
+     * 
+     * @param string $text
+     * @return string
+     * @deprecated
+     */
     public static function text_makeXMLCompliant($text)
     {
         return XMLHelper::string2xml($text);
@@ -485,80 +485,80 @@ 
         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()
     {
         return self::createControlCharacters()->getCharsAsHex();
     }
     
-   /**
-    * 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()
     {
         return self::createControlCharacters()->getCharsAsUTF8();
     }
     
-   /**
-    * 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()
     {
         return self::createControlCharacters()->getCharsAsJSON();
     }
     
-   /**
-    * Removes all control characters from the specified string
-    * that can cause problems in some cases, like creating
-    * valid XML documents. This includes invisible non-breaking
-    * spaces.
-    *
-    * @param string $string
-    * @return string
-    */
+    /**
+     * Removes all control characters from the specified string
+     * that can cause problems in some cases, like creating
+     * valid XML documents. This includes invisible non-breaking
+     * spaces.
+     *
+     * @param string $string
+     * @return string
+     */
     public static function stripControlCharacters(string $string) : string
     {
         return self::createControlCharacters()->stripControlCharacters($string);
     }
     
-   /**
-    * Creates the control characters class, used to 
-    * work with control characters in strings.
-    * 
-    * @return ConvertHelper_ControlCharacters
-    */
+    /**
+     * Creates the control characters class, used to 
+     * work with control characters in strings.
+     * 
+     * @return ConvertHelper_ControlCharacters
+     */
     public static function createControlCharacters() : ConvertHelper_ControlCharacters
     {
         return new ConvertHelper_ControlCharacters();
     }
 
-   /**
-    * 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(string $unicodeChar) : string 
     {
         $unicodeChar = json_decode($unicodeChar);
@@ -684,25 +684,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();
@@ -721,14 +721,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'));
@@ -739,15 +739,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)) {
@@ -761,12 +761,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();
@@ -777,23 +777,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();
@@ -801,50 +801,50 @@ 
         return $date;
     }
     
-   /**
-    * Strips an absolute path to a file within the application
-    * to make the path relative to the application root path.
-    * 
-    * @param string $path
-    * @return string
-    * 
-    * @see FileHelper::relativizePath()
-    * @see FileHelper::relativizePathByDepth()
-    */
+    /**
+     * Strips an absolute path to a file within the application
+     * to make the path relative to the application root path.
+     * 
+     * @param string $path
+     * @return string
+     * 
+     * @see FileHelper::relativizePath()
+     * @see FileHelper::relativizePathByDepth()
+     */
     public static function fileRelativize(string $path) : string
     {
         return FileHelper::relativizePathByDepth($path);
     }
     
     /**
-    * Converts a PHP regex to a javascript RegExp object statement.
-    * 
-    * NOTE: This is an alias for the JSHelper's `convertRegex` method. 
-    * More details are available on its usage there.
-    *
-    * @param string $regex A PHP preg regex
-    * @param string $statementType The type of statement to return: Defaults to a statement to create a RegExp object.
-    * @return array|string Depending on the specified return type.
-    * 
-    * @see JSHelper::buildRegexStatement()
-    */
+     * Converts a PHP regex to a javascript RegExp object statement.
+     * 
+     * NOTE: This is an alias for the JSHelper's `convertRegex` method. 
+     * More details are available on its usage there.
+     *
+     * @param string $regex A PHP preg regex
+     * @param string $statementType The type of statement to return: Defaults to a statement to create a RegExp object.
+     * @return array|string Depending on the specified return type.
+     * 
+     * @see JSHelper::buildRegexStatement()
+     */
     public static function regex2js(string $regex, string $statementType=JSHelper::JS_REGEX_OBJECT)
     {
         return JSHelper::buildRegexStatement($regex, $statementType);
     }
     
-   /**
-    * Converts the specified variable to JSON. Works just
-    * like the native `json_encode` method, except that it
-    * will trigger an exception on failure, which has the 
-    * json error details included in its developer details.
-    * 
-    * @param mixed $variable
-    * @param int $options JSON encode options.
-    * @param int $depth 
-    * @throws ConvertHelper_Exception
-    * @return string
-    */
+    /**
+     * Converts the specified variable to JSON. Works just
+     * like the native `json_encode` method, except that it
+     * will trigger an exception on failure, which has the 
+     * json error details included in its developer details.
+     * 
+     * @param mixed $variable
+     * @param int $options JSON encode options.
+     * @param int $depth 
+     * @throws ConvertHelper_Exception
+     * @return string
+     */
     public static function var2json($variable, int $options=0, int $depth=512) : string
     {
         $result = json_encode($variable, $options, $depth);
@@ -865,12 +865,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();
@@ -885,13 +885,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)) {
@@ -901,15 +901,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) {
@@ -934,22 +934,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(
@@ -973,14 +973,14 @@ 
         return round(100 - $percent, $options['precision']);
     }
     
-   /**
-    * Converts a date interval to a human readable string with
-    * all necessary time components, e.g. "1 year, 2 months and 4 days".
-    * 
-    * @param \DateInterval $interval
-    * @return string
-    * @see ConvertHelper_IntervalConverter
-    */
+    /**
+     * Converts a date interval to a human readable string with
+     * all necessary time components, e.g. "1 year, 2 months and 4 days".
+     * 
+     * @param \DateInterval $interval
+     * @return string
+     * @see ConvertHelper_IntervalConverter
+     */
     public static function interval2string(\DateInterval $interval) : string
     {
         $converter = new ConvertHelper_IntervalConverter();
@@ -995,60 +995,60 @@ 
     
     const INTERVAL_SECONDS = 'seconds';
     
-   /**
-    * Converts an interval to its total amount of days.
-    * @param \DateInterval $interval
-    * @return int
-    */
+    /**
+     * Converts an interval to its total amount of days.
+     * @param \DateInterval $interval
+     * @return int
+     */
     public static function interval2days(\DateInterval $interval) : int
     {
         return self::interval2total($interval, self::INTERVAL_DAYS);
     }
 
-   /**
-    * Converts an interval to its total amount of hours.
-    * @param \DateInterval $interval
-    * @return int
-    */
+    /**
+     * Converts an interval to its total amount of hours.
+     * @param \DateInterval $interval
+     * @return int
+     */
     public static function interval2hours(\DateInterval $interval) : int
     {
         return self::interval2total($interval, self::INTERVAL_HOURS);
     }
     
-   /**
-    * Converts an interval to its total amount of minutes. 
-    * @param \DateInterval $interval
-    * @return int
-    */
+    /**
+     * Converts an interval to its total amount of minutes. 
+     * @param \DateInterval $interval
+     * @return int
+     */
     public static function interval2minutes(\DateInterval $interval) : int
     {
         return self::interval2total($interval, self::INTERVAL_MINUTES);
     }
     
-   /**
-    * Converts an interval to its total amount of seconds.
-    * @param \DateInterval $interval
-    * @return int
-    */    
+    /**
+     * Converts an interval to its total amount of seconds.
+     * @param \DateInterval $interval
+     * @return int
+     */    
     public static function interval2seconds(\DateInterval $interval) : int
     {
         return self::interval2total($interval, self::INTERVAL_SECONDS);
     }
     
-   /**
-    * Calculates the total amount of days / hours / minutes or seconds
-    * of a date interval object (depending in the specified units), and 
-    * returns the total amount.
-    * 
-    * @param \DateInterval $interval
-    * @param string $unit What total value to calculate.
-    * @return integer
-    * 
-    * @see ConvertHelper::INTERVAL_SECONDS
-    * @see ConvertHelper::INTERVAL_MINUTES
-    * @see ConvertHelper::INTERVAL_HOURS
-    * @see ConvertHelper::INTERVAL_DAYS
-    */
+    /**
+     * Calculates the total amount of days / hours / minutes or seconds
+     * of a date interval object (depending in the specified units), and 
+     * returns the total amount.
+     * 
+     * @param \DateInterval $interval
+     * @param string $unit What total value to calculate.
+     * @return integer
+     * 
+     * @see ConvertHelper::INTERVAL_SECONDS
+     * @see ConvertHelper::INTERVAL_MINUTES
+     * @see ConvertHelper::INTERVAL_HOURS
+     * @see ConvertHelper::INTERVAL_DAYS
+     */
     public static function interval2total(\DateInterval $interval, $unit=self::INTERVAL_SECONDS) : int
     {
         $total = (int)$interval->format('%a');
@@ -1088,13 +1088,13 @@ 
         'Sunday'
     );
     
-   /**
-    * Converts a date to the corresponding day name.
-    * 
-    * @param \DateTime $date
-    * @param bool $short
-    * @return string|NULL
-    */
+    /**
+     * Converts a date to the corresponding day name.
+     * 
+     * @param \DateTime $date
+     * @param bool $short
+     * @return string|NULL
+     */
     public static function date2dayName(\DateTime $date, bool $short=false)
     {
         $day = $date->format('l');
@@ -1109,21 +1109,21 @@ 
         return null;
     }
     
-   /**
-    * Retrieves a list of english day names.
-    * @return string[]
-    */
+    /**
+     * Retrieves a list of english day names.
+     * @return string[]
+     */
     public static function getDayNamesInvariant()
     {
         return self::$daysInvariant;
     }
     
-   /**
-    * Retrieves the day names list for the current locale.
-    * 
-    * @param bool $short
-    * @return array
-    */
+    /**
+     * Retrieves the day names list for the current locale.
+     * 
+     * @param bool $short
+     * @return array
+     */
     public static function getDayNames(bool $short=false) : array
     {
         if($short) {
@@ -1183,16 +1183,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);
@@ -1203,12 +1203,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)) {
@@ -1223,17 +1223,17 @@ 
         return false;
     }
     
-   /**
-    * UTF8-safe wordwrap method: works like the regular wordwrap
-    * PHP function but compatible with UTF8. Otherwise the lengths
-    * are not calculated correctly.
-    * 
-    * @param string $str
-    * @param int $width
-    * @param string $break
-    * @param bool $cut
-    * @return string
-    */
+    /**
+     * UTF8-safe wordwrap method: works like the regular wordwrap
+     * PHP function but compatible with UTF8. Otherwise the lengths
+     * are not calculated correctly.
+     * 
+     * @param string $str
+     * @param int $width
+     * @param string $break
+     * @param bool $cut
+     * @return string
+     */
     public static function wordwrap(string $str, int $width = 75, string $break = "\n", bool $cut = false) : string 
     {
         $wrapper = new ConvertHelper_WordWrapper();
@@ -1245,27 +1245,27 @@ 
         ->wrapText($str);
     }
     
-   /**
-    * Calculates the byte length of a string, taking into 
-    * account any unicode characters.
-    * 
-    * @param string $string
-    * @return int
-    * @see https://stackoverflow.com/a/9718273/2298192
-    */
+    /**
+     * Calculates the byte length of a string, taking into 
+     * account any unicode characters.
+     * 
+     * @param string $string
+     * @return int
+     * @see https://stackoverflow.com/a/9718273/2298192
+     */
     public static function string2bytes($string)
     {
         return mb_strlen($string, '8bit');
     }
     
-   /**
-    * Creates a short, 8-character long hash for the specified string.
-    * 
-    * WARNING: Not cryptographically safe.
-    * 
-    * @param string $string
-    * @return string
-    */
+    /**
+     * Creates a short, 8-character long hash for the specified string.
+     * 
+     * WARNING: Not cryptographically safe.
+     * 
+     * @param string $string
+     * @return string
+     */
     public static function string2shortHash($string)
     {
         return hash('crc32', $string, false);
@@ -1291,40 +1291,40 @@ 
         return ConvertHelper_ThrowableInfo::fromThrowable($e);
     }
     
-   /**
-    * Parses the specified query string like the native 
-    * function <code>parse_str</code>, without the key
-    * naming limitations.
-    * 
-    * Using parse_str, dots or spaces in key names are 
-    * replaced by underscores. This method keeps all names
-    * intact.
-    * 
-    * It still uses the parse_str implementation as it 
-    * is tested and tried, but fixes the parameter names
-    * after parsing, as needed.
-    * 
-    * @param string $queryString
-    * @return array
-    * @see ConvertHelper_QueryParser
-    */
+    /**
+     * Parses the specified query string like the native 
+     * function <code>parse_str</code>, without the key
+     * naming limitations.
+     * 
+     * Using parse_str, dots or spaces in key names are 
+     * replaced by underscores. This method keeps all names
+     * intact.
+     * 
+     * It still uses the parse_str implementation as it 
+     * is tested and tried, but fixes the parameter names
+     * after parsing, as needed.
+     * 
+     * @param string $queryString
+     * @return array
+     * @see ConvertHelper_QueryParser
+     */
     public static function parseQueryString(string $queryString) : array
     {
         $parser = new ConvertHelper_QueryParser();
         return $parser->parse($queryString);
     }
 
-   /**
-    * Searches for needle in the specified string, and returns a list
-    * of all occurrences, including the matched string. The matched 
-    * string is useful when doing a case insensitive search, as it 
-    * shows the exact matched case of needle.
-    *   
-    * @param string $needle
-    * @param string $haystack
-    * @param bool $caseInsensitive
-    * @return ConvertHelper_StringMatch[]
-    */
+    /**
+     * Searches for needle in the specified string, and returns a list
+     * of all occurrences, including the matched string. The matched 
+     * string is useful when doing a case insensitive search, as it 
+     * shows the exact matched case of needle.
+     *   
+     * @param string $needle
+     * @param string $haystack
+     * @param bool $caseInsensitive
+     * @return ConvertHelper_StringMatch[]
+     */
     public static function findString(string $needle, string $haystack, bool $caseInsensitive=false)
     {
         if($needle === '') {
@@ -1350,14 +1350,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)) {
@@ -1379,12 +1379,12 @@ 
     
     protected static $eolChars;
 
-   /**
-    * Detects the most used end-of-line character in the subject string.
-    * 
-    * @param string $subjectString The string to check.
-    * @return NULL|ConvertHelper_EOL The detected EOL instance, or NULL if none has been detected.
-    */
+    /**
+     * Detects the most used end-of-line character in the subject string.
+     * 
+     * @param string $subjectString The string to check.
+     * @return NULL|ConvertHelper_EOL The detected EOL instance, or NULL if none has been detected.
+     */
     public static function detectEOLCharacter(string $subjectString) : ?ConvertHelper_EOL
     {
         if(empty($subjectString)) {
@@ -1396,27 +1396,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'),
+                ),
             );
         }
         
@@ -1444,13 +1444,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) 
@@ -1461,13 +1461,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)) {
@@ -1487,40 +1487,40 @@ 
         return false;    
     }
     
-   /**
-    * Converts an amount of seconds to a DateInterval object.
-    * 
-    * @param int $seconds
-    * @return \DateInterval
-    * @throws ConvertHelper_Exception If the date interval cannot be created.
-    * 
-    * @see ConvertHelper::ERROR_CANNOT_GET_DATE_DIFF
-    */
+    /**
+     * Converts an amount of seconds to a DateInterval object.
+     * 
+     * @param int $seconds
+     * @return \DateInterval
+     * @throws ConvertHelper_Exception If the date interval cannot be created.
+     * 
+     * @see ConvertHelper::ERROR_CANNOT_GET_DATE_DIFF
+     */
     public static function seconds2interval(int $seconds) : \DateInterval
     {
         return ConvertHelper_DateInterval::fromSeconds($seconds)->getInterval();
     }
     
-   /**
-    * Converts a size string like "50 MB" to the corresponding byte size.
-    * It is case insensitive, ignores spaces, and supports both traditional
-    * "MB" and "MiB" notations.
-    * 
-    * @param string $size
-    * @return int
-    */
+    /**
+     * Converts a size string like "50 MB" to the corresponding byte size.
+     * It is case insensitive, ignores spaces, and supports both traditional
+     * "MB" and "MiB" notations.
+     * 
+     * @param string $size
+     * @return int
+     */
     public static function size2bytes(string $size) : int
     {
         return self::parseSize($size)->toBytes();
     }
     
-   /**
-    * Parses a size string like "50 MB" and returns a size notation instance
-    * that has utility methods to access information on it, and convert it.
-    * 
-    * @param string $size
-    * @return ConvertHelper_SizeNotation
-    */
+    /**
+     * Parses a size string like "50 MB" and returns a size notation instance
+     * that has utility methods to access information on it, and convert it.
+     * 
+     * @param string $size
+     * @return ConvertHelper_SizeNotation
+     */
     public static function parseSize(string $size) : ConvertHelper_SizeNotation
     {
         return new ConvertHelper_SizeNotation($size);

src/RequestHelper/Boundaries.php

Indentation +52 added lines, -52 removed lines

@@ -22,19 +22,19 @@ 
 {
     const ERROR_NO_BOUNDARIES_SPECIFIED = 44401;
     
-   /**
-    * @var RequestHelper
-    */
+    /**
+     * @var RequestHelper
+     */
     protected $helper;
 
-   /**
-    * @var RequestHelper_Boundaries_Boundary[]
-    */
+    /**
+     * @var RequestHelper_Boundaries_Boundary[]
+     */
     protected $boundaries = array();
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     protected $contentLength = 0;
     
     public function __construct(RequestHelper $helper)
@@ -42,31 +42,31 @@ 
         $this->helper = $helper;
     }
     
-   /**
-    * Retrieves the string that is used to separate mime boundaries in the body.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the string that is used to separate mime boundaries in the body.
+     * 
+     * @return string
+     */
     public function getMimeBoundary() : string
     {
         return $this->helper->getMimeBoundary();
     }
     
-   /**
-    * Retrieves the end of line character(s) used in the body.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the end of line character(s) used in the body.
+     * 
+     * @return string
+     */
     public function getEOL() : string
     {
         return $this->helper->getEOL();
     }
     
-   /**
-    * Retrieves the total content length of all boundary contents.
-    * 
-    * @return int
-    */
+    /**
+     * Retrieves the total content length of all boundary contents.
+     * 
+     * @return int
+     */
     public function getContentLength() : int
     {
         // this must use strlen, and not mb_strlen: the content length
@@ -75,15 +75,15 @@ 
         return strlen($this->render());
     }
     
-   /**
-    * Adds a file to be sent with the request.
-    *
-    * @param string $varName The variable name to send the file in
-    * @param string $fileName The name of the file as it should be received at the destination
-    * @param string $content The raw content of the file
-    * @param string $contentType The content type, use the constants to specify this
-    * @param string $encoding The encoding of the file, use the constants to specify this
-    */
+    /**
+     * Adds a file to be sent with the request.
+     *
+     * @param string $varName The variable name to send the file in
+     * @param string $fileName The name of the file as it should be received at the destination
+     * @param string $content The raw content of the file
+     * @param string $contentType The content type, use the constants to specify this
+     * @param string $encoding The encoding of the file, use the constants to specify this
+     */
     public function addFile(string $varName, string $fileName, string $content, string $contentType = '', string $encoding = '') : RequestHelper_Boundaries
     {
         if(empty($contentType))
@@ -107,13 +107,13 @@ 
         return $this->addBoundary($boundary);
     }
     
-   /**
-    * Adds arbitrary content.
-    *
-    * @param string $varName
-    * @param string $content
-    * @param string $contentType
-    */
+    /**
+     * Adds arbitrary content.
+     *
+     * @param string $varName
+     * @param string $content
+     * @param string $contentType
+     */
     public function addContent(string $varName, string $content, string $contentType) : RequestHelper_Boundaries
     {
         $content = ConvertHelper::string2utf8($content);
@@ -127,13 +127,13 @@ 
         return $this->addBoundary($boundary);
     }
     
-   /**
-    * Adds a variable to be sent with the request. If it
-    * already exists, its value is overwritten.
-    *
-    * @param string $name
-    * @param string $value
-    */
+    /**
+     * Adds a variable to be sent with the request. If it
+     * already exists, its value is overwritten.
+     *
+     * @param string $name
+     * @param string $value
+     */
     public function addVariable(string $name, string $value) : RequestHelper_Boundaries
     {
         $boundary = $this->createBoundary($value)
@@ -149,11 +149,11 @@ 
         return $this;
     }
     
-   /**
-    * Renders the response body with all mime boundaries.
-    * 
-    * @return string
-    */
+    /**
+     * Renders the response body with all mime boundaries.
+     * 
+     * @return string
+     */
     public function render() : string
     {
         if(empty($this->boundaries))