Mistralys / application-utils

src/ConvertHelper.php

Indentation +471 added lines, -471 removed lines

@@ -66,13 +66,13 @@ 
         return ConvertHelper_String::tabs2spaces($string, $tabSize);
     }
     
-   /**
-    * 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 ConvertHelper_String::spaces2tabs($string, $tabSize);
@@ -90,14 +90,14 @@ 
         return ConvertHelper_String::hidden2visible($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) : string
     {
         $converter = new ConvertHelper_TimeConverter($seconds);
@@ -121,85 +121,85 @@ 
      */
     public static function duration2string($datefrom, $dateto = -1) : string
     {
-         return ConvertHelper_DurationConverter::toString($datefrom, $dateto);
+            return ConvertHelper_DurationConverter::toString($datefrom, $dateto);
     }
 
-   /**
-    * Adds HTML syntax highlighting to the specified SQL string.
-    * 
-    * @param string $sql
-    * @return string
-    * @deprecated Use the Highlighter class directly instead.
-    * @see Highlighter::sql()
-    */
+    /**
+     * Adds HTML syntax highlighting to the specified SQL string.
+     * 
+     * @param string $sql
+     * @return string
+     * @deprecated Use the Highlighter class directly instead.
+     * @see Highlighter::sql()
+     */
     public static function highlight_sql(string $sql) : string
     {
         return Highlighter::sql($sql);
     }
 
-   /**
-    * Adds HTML syntax highlighting to the specified XML code.
-    * 
-    * @param string $xml The XML to highlight.
-    * @param bool $formatSource Whether to format the source with indentation to make it readable.
-    * @return string
-    * @deprecated Use the Highlighter class directly instead.
-    * @see Highlighter::xml()
-    */
+    /**
+     * Adds HTML syntax highlighting to the specified XML code.
+     * 
+     * @param string $xml The XML to highlight.
+     * @param bool $formatSource Whether to format the source with indentation to make it readable.
+     * @return string
+     * @deprecated Use the Highlighter class directly instead.
+     * @see Highlighter::xml()
+     */
     public static function highlight_xml(string $xml, bool $formatSource=false) : string
     {
         return Highlighter::xml($xml, $formatSource);
     }
 
-   /**
-    * @param string $phpCode
-    * @return string
-    * @deprecated Use the Highlighter class directly instead.
-    * @see Highlighter::php()
-    */
+    /**
+     * @param string $phpCode
+     * @return string
+     * @deprecated Use the Highlighter class directly instead.
+     * @see Highlighter::php()
+     */
     public static function highlight_php(string $phpCode) : string
     {
         return Highlighter::php($phpCode);
     }
     
-   /**
-    * 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
     {
         return ConvertHelper_String::cutText($text, $targetLength, $append);
@@ -223,14 +223,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();
@@ -251,29 +251,29 @@ 
         return $result;
     }
     
-   /**
-    * 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
     {
         return ConvertHelper_Bool::fromString($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);
@@ -343,36 +343,36 @@ 
         return ConvertHelper_String::transliterate($string, $spaceChar, $lowercase);
     }
     
-   /**
-    * 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() : array
     {
         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() : array
     {
         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() : array
     {
         return self::createControlCharacters()->getCharsAsJSON();
@@ -393,31 +393,31 @@ 
         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 PHP notation.
-    * 
-    * Example:
-    * 
-    * <pre>unicodeChar2php('"\u0000"')</pre>
-    * 
-    * Returns
-    * 
-    * <pre>\x0</pre>
-    * 
-    * @param string $unicodeChar
-    * @return string
-    */
+    /**
+     * Converts a unicode character to the PHP 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);
@@ -531,25 +531,25 @@ 
         return ConvertHelper_Bool::toStringStrict($boolean, $yesNo);
     }
 
-   /**
-    * 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<string,mixed> $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<string,mixed> $array
+     * @return string
+     */
     public static function array2attributeString(array $array) : string
     {
         return ConvertHelper_Array::toAttributeString($array);
@@ -569,116 +569,116 @@ 
         return self::var2json($array);
     }
     
-   /**
-    * 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
-    * @deprecated Use the JSHelper class instead.
-    * @see JSHelper::phpVariable2AttributeJS()
-    */
+    /**
+     * 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
+     * @deprecated Use the JSHelper class instead.
+     * @see JSHelper::phpVariable2AttributeJS()
+     */
     public static function string2attributeJS(string $string) : string
     {
         return JSHelper::phpVariable2AttributeJS($string);
     }
     
-   /**
-    * 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
     {
         return ConvertHelper_Bool::isBoolean($value);
     }
     
-   /**
-    * Converts an associative array to an HTML style attribute value string.
-    * 
-    * @param array<string,mixed> $subject
-    * @return string
-    */
+    /**
+     * Converts an associative array to an HTML style attribute value string.
+     * 
+     * @param array<string,mixed> $subject
+     * @return string
+     */
     public static function array2styleString(array $subject) : string
     {
         return ConvertHelper_Array::toStyleString($subject);
     }
     
-   /**
-    * 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 ConvertHelper_Date::toTimestamp($date);
     }
     
-   /**
-    * 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
     {
         return ConvertHelper_Date::fromTimestamp($timestamp);
     }
     
-   /**
-    * 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 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 string Depending on the specified return type.
+     * 
+     * @see JSHelper::buildRegexStatement()
+     */
     public static function regex2js(string $regex, string $statementType=JSHelper::JS_REGEX_OBJECT) : string
     {
         return JSHelper::buildRegexStatement($regex, $statementType);
     }
     
-   /**
-    * Converts the specified variable to a JSON string.
-    *
-    * 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 
-    * @return string
-    *
-    * @throws JSONConverterException
-    * @see ConvertHelper::ERROR_JSON_ENCODE_FAILED
-    */
+    /**
+     * Converts the specified variable to a JSON string.
+     *
+     * 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 
+     * @return string
+     *
+     * @throws JSONConverterException
+     * @see ConvertHelper::ERROR_JSON_ENCODE_FAILED
+     */
     public static function var2json($variable, int $options=0, int $depth=512) : string
     {
         return JSONConverter::var2json($variable, $options, $depth);
@@ -726,12 +726,12 @@ 
             ->toString();
     }
     
-   /**
-    * 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 $string) : string
     {
         $boms = FileHelper::createUnicodeHandling()->getUTFBOMs();
@@ -750,69 +750,69 @@ 
         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 $string) : string
     {
         return ConvertHelper_String::toUtf8($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 string|float|int|NULL $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 string|float|int|NULL $string
+     * @return boolean
+     */
     public static function isStringASCII($string) : bool
     {
         return ConvertHelper_String::isASCII(strval($string));
     }
     
-   /**
-    * Adds HTML syntax highlighting to an URL.
-    * 
-    * NOTE: Includes the necessary CSS styles. When
-    * highlighting several URLs in the same page,
-    * prefer using the `parseURL` function instead.
-    * 
-    * @param string $url
-    * @return string
-    * @deprecated Use the Highlighter class directly instead.
-    * @see Highlighter
-    */
+    /**
+     * Adds HTML syntax highlighting to an URL.
+     * 
+     * NOTE: Includes the necessary CSS styles. When
+     * highlighting several URLs in the same page,
+     * prefer using the `parseURL` function instead.
+     * 
+     * @param string $url
+     * @return string
+     * @deprecated Use the Highlighter class directly instead.
+     * @see Highlighter
+     */
     public static function highlight_url(string $url) : string
     {
         return Highlighter::url($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<string,mixed> $options
-    * @return float
-    *
-    * @see ConvertHelper_TextComparer
-    * @see ConvertHelper_TextComparer::OPTION_MAX_LEVENSHTEIN_DISTANCE
-    * @see ConvertHelper_TextComparer::OPTION_PRECISION
-    */
+    /**
+     * 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<string,mixed> $options
+     * @return float
+     *
+     * @see ConvertHelper_TextComparer
+     * @see ConvertHelper_TextComparer::OPTION_MAX_LEVENSHTEIN_DISTANCE
+     * @see ConvertHelper_TextComparer::OPTION_PRECISION
+     */
     public static function matchString(string $source, string $target, array $options=array()) : float
     {
         return (new ConvertHelper_TextComparer())
@@ -820,109 +820,109 @@ 
             ->match($source, $target);
     }
     
-   /**
-    * 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
-    *
-    * @throws ConvertHelper_Exception
-    * @see ConvertHelper_IntervalConverter::ERROR_MISSING_TRANSLATION
-    */
+    /**
+     * 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
+     *
+     * @throws ConvertHelper_Exception
+     * @see ConvertHelper_IntervalConverter::ERROR_MISSING_TRANSLATION
+     */
     public static function interval2string(DateInterval $interval) : string
     {
         return (new ConvertHelper_IntervalConverter())
             ->toString($interval);
     }
     
-   /**
-    * 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 ConvertHelper_DateInterval::toDays($interval);
     }
 
-   /**
-    * 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 ConvertHelper_DateInterval::toHours($interval);
     }
     
-   /**
-    * 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 ConvertHelper_DateInterval::toMinutes($interval);
     }
     
-   /**
-    * 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 ConvertHelper_DateInterval::toSeconds($interval);
     }
     
-   /**
-    * Calculates the total amount of days / hours / minutes or seconds
-    * of a date interval object (depending on 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 on 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, string $unit=self::INTERVAL_SECONDS) : int
     {
         return ConvertHelper_DateInterval::toTotal($interval, $unit);
     }
 
-   /**
-    * 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) : ?string
     {
         return ConvertHelper_Date::toDayName($date, $short);
     }
     
-   /**
-    * Retrieves a list of english day names.
-    * @return string[]
-    */
+    /**
+     * Retrieves a list of english day names.
+     * @return string[]
+     */
     public static function getDayNamesInvariant() : array
     {
         return ConvertHelper_Date::getDayNamesInvariant();
     }
     
-   /**
-    * Retrieves the day names list for the current locale.
-    * 
-    * @param bool $short
-    * @return string[]
-    */
+    /**
+     * Retrieves the day names list for the current locale.
+     * 
+     * @param bool $short
+     * @return string[]
+     */
     public static function getDayNames(bool $short=false) : array
     {
         return ConvertHelper_Date::getDayNames($short);
@@ -941,16 +941,16 @@ 
         return ConvertHelper_Array::implodeWithAnd($list, $sep, $conjunction);
     }
     
-   /**
-    * 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 string[]
-    */
+    /**
+     * 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 string[]
+     */
     public static function string2array(string $string) : array
     {
         return ConvertHelper_String::toArray($string);
@@ -961,53 +961,53 @@ 
         return new WordSplitter($string);
     }
     
-   /**
-    * 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
     {
         return ConvertHelper_String::isHTML($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
-    */
+    /**
+     * 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 
     {
         return ConvertHelper_String::wordwrap($str, $width, $break, $cut);
     }
     
-   /**
-    * Calculates the byte length of a string, taking into 
-    * account any unicode characters.
-    * 
-    * @param string $string
-    * @return int
-    */
+    /**
+     * Calculates the byte length of a string, taking into 
+     * account any unicode characters.
+     * 
+     * @param string $string
+     * @return int
+     */
     public static function string2bytes(string $string): int
     {
         return ConvertHelper_String::toBytes($string);
     }
     
-   /**
-    * 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 $string) : string
     {
         return ConvertHelper_String::toShortHash($string);
@@ -1053,88 +1053,88 @@ 
         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<string,string>
-    * @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<string,string>
+     * @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): array
     {
         return ConvertHelper_String::findString($needle, $haystack, $caseInsensitive);
     }
     
-   /**
-    * 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
     {
         return ConvertHelper_String::explodeTrim($delimiter, $string);
     }
     
-   /**
-    * 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
     {
         return ConvertHelper_EOL::detect($subjectString);
     }
 
-   /**
-    * Removes the specified keys from the target array,
-    * if they exist.
-    * 
-    * @param array<string|int,mixed> $array
-    * @param string[] $keys
-    */
+    /**
+     * Removes the specified keys from the target array,
+     * if they exist.
+     * 
+     * @param array<string|int,mixed> $array
+     * @param string[] $keys
+     */
     public static function arrayRemoveKeys(array &$array, array $keys) : void
     {
         ConvertHelper_Array::removeKeys($array, $keys);
     }
     
-   /**
-    * 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)) {
@@ -1154,52 +1154,52 @@ 
         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);
     }
     
-   /**
-    * Creates a URL finder instance, which can be used to find
-    * URLs in a string - be it plain text, or HTML.
-    * 
-    * @param string $subject
-    * @return ConvertHelper_URLFinder
-    */
+    /**
+     * Creates a URL finder instance, which can be used to find
+     * URLs in a string - be it plain text, or HTML.
+     * 
+     * @param string $subject
+     * @return ConvertHelper_URLFinder
+     */
     public static function createURLFinder(string $subject) : ConvertHelper_URLFinder
     {
         return new ConvertHelper_URLFinder($subject);

src/Highlighter.php

Indentation +64 added lines, -64 removed lines

@@ -43,60 +43,60 @@ 
  */
 class Highlighter
 {
-   /**
-    * Creates a new GeSHi instance from a source code string.
-    * 
-    * @param string $sourceCode
-    * @param string $format
-    * @return GeSHi
-    */
+    /**
+     * Creates a new GeSHi instance from a source code string.
+     * 
+     * @param string $sourceCode
+     * @param string $format
+     * @return GeSHi
+     */
     public static function fromString(string $sourceCode, string $format) : GeSHi
     {
         return new GeSHi($sourceCode, $format);
     }
     
-   /**
-    * Creates a new GeSHi instance from the contents of a file.
-    * 
-    * @param string $path
-    * @param string $format
-    * @return GeSHi
-    */
+    /**
+     * Creates a new GeSHi instance from the contents of a file.
+     * 
+     * @param string $path
+     * @param string $format
+     * @return GeSHi
+     */
     public static function fromFile(string $path, string $format) : GeSHi
     {
         return self::fromString(FileHelper::readContents($path), $format);
     }
     
-   /**
-    * Parses and highlights the target string.
-    * 
-    * @param string $sourceCode
-    * @param string $format
-    * @return string
-    */
+    /**
+     * Parses and highlights the target string.
+     * 
+     * @param string $sourceCode
+     * @param string $format
+     * @return string
+     */
     public static function parseString(string $sourceCode, string $format) : string
     {
         return self::fromString($sourceCode, $format)->parse_code();
     }
     
-   /**
-    * Parses and highlights the contents of the target file.
-    * 
-    * @param string $path
-    * @param string $format
-    * @return string
-    */
+    /**
+     * Parses and highlights the contents of the target file.
+     * 
+     * @param string $path
+     * @param string $format
+     * @return string
+     */
     public static function parseFile(string $path, string $format) : string
     {
         return self::fromFile($path, $format)->parse_code();
     }
     
-   /**
-    * Adds HTML syntax highlighting to the specified SQL string.
-    *
-    * @param string $sql
-    * @return string
-    */
+    /**
+     * Adds HTML syntax highlighting to the specified SQL string.
+     *
+     * @param string $sql
+     * @return string
+     */
     public static function sql(string $sql) : string
     {
         return self::parseString($sql, 'sql');
@@ -122,13 +122,13 @@ 
         return self::parseString($subject, 'javascript');
     }
     
-   /**
-    * Adds HTML syntax highlighting to the specified XML code.
-    *
-    * @param string $xml The XML to highlight.
-    * @param bool $formatSource Whether to format the source with indentation to make it readable.
-    * @return string
-    */
+    /**
+     * Adds HTML syntax highlighting to the specified XML code.
+     *
+     * @param string $xml The XML to highlight.
+     * @param bool $formatSource Whether to format the source with indentation to make it readable.
+     * @return string
+     */
     public static function xml(string $xml, bool $formatSource=false) : string
     {
         if($formatSource)
@@ -145,13 +145,13 @@ 
         return self::parseString($xml, 'xml');
     }
     
-   /**
-    * Adds HTML syntax highlighting to the specified HTML code.
-    * 
-    * @param string $html
-    * @param bool $formatSource
-    * @return string
-    */
+    /**
+     * Adds HTML syntax highlighting to the specified HTML code.
+     * 
+     * @param string $html
+     * @param bool $formatSource
+     * @return string
+     */
     public static function html(string $html, bool $formatSource=false) : string
     {
         if($formatSource)
@@ -168,27 +168,27 @@ 
         return self::parseString($html, 'xml');
     }
     
-   /**
-    * Adds HTML syntax highlighting to a bit of PHP code.
-    * 
-    * @param string $phpCode
-    * @return string
-    */
+    /**
+     * Adds HTML syntax highlighting to a bit of PHP code.
+     * 
+     * @param string $phpCode
+     * @return string
+     */
     public static function php(string $phpCode) : string
     {
         return self::parseString($phpCode, 'php');
     }
     
-   /**
-    * Adds HTML syntax highlighting to an URL.
-    *
-    * NOTE: Includes the necessary CSS styles. When
-    * highlighting several URLs in the same page,
-    * prefer using the `parseURL` function instead.
-    *
-    * @param string $url
-    * @return string
-    */
+    /**
+     * Adds HTML syntax highlighting to an URL.
+     *
+     * NOTE: Includes the necessary CSS styles. When
+     * highlighting several URLs in the same page,
+     * prefer using the `parseURL` function instead.
+     *
+     * @param string $url
+     * @return string
+     */
     public static function url(string $url) : string
     {
         $info = parseURL($url);

src/XMLHelper/Converter.php

Indentation +21 added lines, -21 removed lines

@@ -51,9 +51,9 @@ 
     
     protected SimpleXMLElement $xml;
     
-   /**
-    * @var string|NULL
-    */
+    /**
+     * @var string|NULL
+     */
     protected ?string $json;
     
     protected function __construct(SimpleXMLElement $element)
@@ -98,34 +98,34 @@ 
         }
     }
     
-   /**
-    * Factory method: creates a converter from an existing SimpleXMLElement instance.
-    * 
-    * @param SimpleXMLElement $element
-    * @return XMLHelper_Converter
-    */
+    /**
+     * Factory method: creates a converter from an existing SimpleXMLElement instance.
+     * 
+     * @param SimpleXMLElement $element
+     * @return XMLHelper_Converter
+     */
     public static function fromElement(SimpleXMLElement $element) : XMLHelper_Converter
     {
         return new XMLHelper_Converter($element);
     }
 
-   /**
-    * Factory method: creates a converter from an existing SimpleXMLElement instance.
-    *
-    * @param DOMElement $element
-    * @return XMLHelper_Converter
-    */
+    /**
+     * Factory method: creates a converter from an existing SimpleXMLElement instance.
+     *
+     * @param DOMElement $element
+     * @return XMLHelper_Converter
+     */
     public static function fromDOMElement(DOMElement $element) : XMLHelper_Converter
     {
         return new XMLHelper_Converter(simplexml_import_dom($element));
     }
     
-   /**
-    * Converts the XML to JSON.
-    * 
-    * @return string
-    * @throws XMLHelper_Exception
-    */
+    /**
+     * Converts the XML to JSON.
+     * 
+     * @return string
+     * @throws XMLHelper_Exception
+     */
     public function toJSON() : string
     {
         if (isset($this->json))

src/JSHelper.php

Indentation +48 added lines, -48 removed lines

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

src/ZIPHelper.php

Indentation +29 added lines, -29 removed lines

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