Mistralys / application-utils

src/ConvertHelper.php

Indentation +469 added lines, -469 removed lines

@@ -60,13 +60,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);
@@ -84,14 +84,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);
@@ -115,85 +115,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);
@@ -217,14 +217,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();
@@ -245,29 +245,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);
@@ -337,36 +337,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();
@@ -387,31 +387,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);
@@ -525,138 +525,138 @@ 
         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);
     }
     
-   /**
-    * 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 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 
-    * @return string
-    *
-    * @throws ConvertHelper_Exception
-    * @see ConvertHelper::ERROR_JSON_ENCODE_FAILED
-    */
+    /**
+     * 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 
+     * @return string
+     *
+     * @throws ConvertHelper_Exception
+     * @see ConvertHelper::ERROR_JSON_ENCODE_FAILED
+     */
     public static function var2json($variable, int $options=0, int $depth=512) : string
     {
         $result = json_encode($variable, $options, $depth);
@@ -691,12 +691,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::getUTFBOMs();
@@ -715,69 +715,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())
@@ -785,109 +785,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);
@@ -906,68 +906,68 @@ 
         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);
     }
     
-   /**
-    * 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);
@@ -1013,88 +1013,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)) {
@@ -1114,52 +1114,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);

Spacing +24 added lines, -24 removed lines

@@ -55,7 +55,7 @@ 
      * @param int $tabSize The amount of spaces per tab.
      * @return string
      */
-    public static function tabs2spaces(string $string, int $tabSize=4) : string
+    public static function tabs2spaces(string $string, int $tabSize = 4) : string
     {
         return ConvertHelper_String::tabs2spaces($string, $tabSize);
     }
@@ -67,7 +67,7 @@ 
     * @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
+    public static function spaces2tabs(string $string, int $tabSize = 4) : string
     {
         return ConvertHelper_String::spaces2tabs($string, $tabSize);
     }
@@ -140,7 +140,7 @@ 
     * @deprecated Use the Highlighter class directly instead.
     * @see Highlighter::xml()
     */
-    public static function highlight_xml(string $xml, bool $formatSource=false) : string
+    public static function highlight_xml(string $xml, bool $formatSource = false) : string
     {
         return Highlighter::xml($xml, $formatSource);
     }
@@ -206,11 +206,11 @@ 
      * @param bool $html
      * @return string
      */
-    public static function var_dump($var, bool $html=true) : string
+    public static function var_dump($var, bool $html = true) : string
     {
         $info = parseVariable($var);
         
-        if($html) {
+        if ($html) {
             return $info->toHTML();
         }
         
@@ -225,11 +225,11 @@ 
     * @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
+    public static function print_r($var, bool $return = false, bool $html = true) : string
     {
         $result = parseVariable($var)->enableType()->toString();
         
-        if($html) 
+        if ($html) 
         {
             $result = 
             '<pre style="background:#fff;color:#333;padding:16px;border:solid 1px #bbb;border-radius:4px">'.
@@ -237,7 +237,7 @@ 
             '</pre>';
         }
         
-        if(!$return) 
+        if (!$return) 
         {
             echo $result;
         }
@@ -419,12 +419,12 @@ 
         $output = '';
         $split = str_split($unicodeChar);
         
-        foreach($split as $octet) 
+        foreach ($split as $octet) 
         {
             $ordInt = ord($octet);
             // Convert from int (base 10) to hex (base 16), for PHP \x syntax
             $ordHex = base_convert((string)$ordInt, 10, 16);
-            $output .= '\x' . $ordHex;
+            $output .= '\x'.$ordHex;
         }
         
         return $output;
@@ -638,7 +638,7 @@ 
     * 
     * @see JSHelper::buildRegexStatement()
     */
-    public static function regex2js(string $regex, string $statementType=JSHelper::JS_REGEX_OBJECT) : string
+    public static function regex2js(string $regex, string $statementType = JSHelper::JS_REGEX_OBJECT) : string
     {
         return JSHelper::buildRegexStatement($regex, $statementType);
     }
@@ -657,11 +657,11 @@ 
     * @throws ConvertHelper_Exception
     * @see ConvertHelper::ERROR_JSON_ENCODE_FAILED
     */
-    public static function var2json($variable, int $options=0, int $depth=512) : string
+    public static function var2json($variable, int $options = 0, int $depth = 512) : string
     {
         $result = json_encode($variable, $options, $depth);
         
-        if($result !== false) {
+        if ($result !== false) {
             return $result;
         }
         
@@ -701,12 +701,12 @@ 
     {
         $boms = FileHelper::getUTFBOMs();
 
-        foreach($boms as $bomChars)
+        foreach ($boms as $bomChars)
         {
             $length = mb_strlen($bomChars);
             $text = mb_substr($string, 0, $length);
 
-            if($text===$bomChars)
+            if ($text === $bomChars)
             {
                 return mb_substr($string, $length);
             }
@@ -778,7 +778,7 @@ 
     * @see ConvertHelper_TextComparer::OPTION_MAX_LEVENSHTEIN_DISTANCE
     * @see ConvertHelper_TextComparer::OPTION_PRECISION
     */
-    public static function matchString(string $source, string $target, array $options=array()) : float
+    public static function matchString(string $source, string $target, array $options = array()) : float
     {
         return (new ConvertHelper_TextComparer())
             ->setOptions($options)
@@ -856,7 +856,7 @@ 
     * @see ConvertHelper::INTERVAL_HOURS
     * @see ConvertHelper::INTERVAL_DAYS
     */
-    public static function interval2total(DateInterval $interval, string $unit=self::INTERVAL_SECONDS) : int
+    public static function interval2total(DateInterval $interval, string $unit = self::INTERVAL_SECONDS) : int
     {
         return ConvertHelper_DateInterval::toTotal($interval, $unit);
     }
@@ -868,7 +868,7 @@ 
     * @param bool $short
     * @return string|NULL
     */
-    public static function date2dayName(DateTime $date, bool $short=false) : ?string
+    public static function date2dayName(DateTime $date, bool $short = false) : ?string
     {
         return ConvertHelper_Date::toDayName($date, $short);
     }
@@ -888,7 +888,7 @@ 
     * @param bool $short
     * @return string[]
     */
-    public static function getDayNames(bool $short=false) : array
+    public static function getDayNames(bool $short = false) : array
     {
         return ConvertHelper_Date::getDayNames($short);
     }
@@ -1047,7 +1047,7 @@ 
     * @param bool $caseInsensitive
     * @return ConvertHelper_StringMatch[]
     */
-    public static function findString(string $needle, string $haystack, bool $caseInsensitive=false): array
+    public static function findString(string $needle, string $haystack, bool $caseInsensitive = false): array
     {
         return ConvertHelper_String::findString($needle, $haystack, $caseInsensitive);
     }
@@ -1097,17 +1097,17 @@ 
     */
     public static function isInteger($value) : bool
     {
-        if(is_int($value)) {
+        if (is_int($value)) {
             return true;
         }
         
         // booleans get converted to numbers, so they would
         // actually match the regex.
-        if(is_bool($value)) {
+        if (is_bool($value)) {
             return false;
         }
         
-        if(is_string($value) && $value !== '') {
+        if (is_string($value) && $value !== '') {
             return preg_match('/\A-?\d+\z/', $value) === 1;
         }
         
@@ -1173,7 +1173,7 @@ 
      * @param bool $keepKeys
      * @return array<number|string,mixed>
      */
-    public static function arrayRemoveValues(array $sourceArray, array $values, bool $keepKeys=false) : array
+    public static function arrayRemoveValues(array $sourceArray, array $values, bool $keepKeys = false) : array
     {
         return ConvertHelper_Array::removeValues($sourceArray, $values, $keepKeys);
     }

src/ConvertHelper/TextComparer.php

Spacing +2 added lines, -2 removed lines

@@ -87,14 +87,14 @@
     public function match(string $source, string $target) : float
     {
         // avoid doing this via levenshtein
-        if($source === $target) {
+        if ($source === $target) {
             return 100;
         }
 
         $maxL = $this->getMaxDistance();
 
         $diff = levenshtein($source, $target);
-        if($diff > $maxL) {
+        if ($diff > $maxL) {
             return 0;
         }
 

src/ConvertHelper/Comparator.php

Spacing +4 added lines, -4 removed lines

@@ -49,19 +49,19 @@
      */
     protected static function convertScalarForComparison($scalar) : ?string
     {
-        if($scalar === '' || is_null($scalar)) {
+        if ($scalar === '' || is_null($scalar)) {
             return null;
         }
 
-        if(is_bool($scalar)) {
+        if (is_bool($scalar)) {
             return ConvertHelper_Bool::toStringStrict($scalar);
         }
 
-        if(is_array($scalar)) {
+        if (is_array($scalar)) {
             $scalar = md5(serialize($scalar));
         }
 
-        if($scalar !== null && !is_scalar($scalar)) {
+        if ($scalar !== null && !is_scalar($scalar)) {
             throw new ConvertHelper_Exception(
                 'Not a scalar value in comparison',
                 null,

src/ConvertHelper/String.php

Spacing +16 added lines, -16 removed lines

@@ -33,14 +33,14 @@ 
      * @param bool $caseInsensitive
      * @return ConvertHelper_StringMatch[]
      */
-    public static function findString(string $needle, string $haystack, bool $caseInsensitive=false): array
+    public static function findString(string $needle, string $haystack, bool $caseInsensitive = false): array
     {
-        if($needle === '') {
+        if ($needle === '') {
             return array();
         }
 
         $function = 'mb_strpos';
-        if($caseInsensitive) {
+        if ($caseInsensitive) {
             $function = 'mb_stripos';
         }
 
@@ -48,7 +48,7 @@ 
         $positions = array();
         $length = mb_strlen($needle);
 
-        while( ($pos = $function($haystack, $needle, $pos)) !== false)
+        while (($pos = $function($haystack, $needle, $pos)) !== false)
         {
             $match = mb_substr($haystack, $pos, $length);
             $positions[] = new ConvertHelper_StringMatch($pos, $match);
@@ -71,7 +71,7 @@ 
     public static function toArray(string $string) : array
     {
         $result = preg_split('//u', $string, 0, PREG_SPLIT_NO_EMPTY);
-        if($result !== false) {
+        if ($result !== false) {
             return $result;
         }
 
@@ -124,7 +124,7 @@ 
      */
     public static function toUtf8(string $string) : string
     {
-        if(!self::isASCII($string)) {
+        if (!self::isASCII($string)) {
             return Encoding::toUTF8($string);
         }
 
@@ -142,11 +142,11 @@ 
      */
     public static function isASCII($string) : bool
     {
-        if($string === '' || $string === NULL) {
+        if ($string === '' || $string === NULL) {
             return true;
         }
 
-        if(!is_string($string)) {
+        if (!is_string($string)) {
             return false;
         }
 
@@ -161,12 +161,12 @@ 
      */
     public static function isHTML(string $string) : bool
     {
-        if(preg_match('%<[a-z/][\s\S]*>%siU', $string)) {
+        if (preg_match('%<[a-z/][\s\S]*>%siU', $string)) {
             return true;
         }
 
         $decoded = html_entity_decode($string);
-        if($decoded !== $string) {
+        if ($decoded !== $string) {
             return true;
         }
 
@@ -198,7 +198,7 @@ 
      * @param int $tabSize The amount of spaces per tab.
      * @return string
      */
-    public static function tabs2spaces(string $string, int $tabSize=4) : string
+    public static function tabs2spaces(string $string, int $tabSize = 4) : string
     {
         return str_replace("\t", str_repeat(' ', $tabSize), $string);
     }
@@ -210,7 +210,7 @@ 
      * @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
+    public static function spaces2tabs(string $string, int $tabSize = 4) : string
     {
         return str_replace(str_repeat(' ', $tabSize), "\t", $string);
     }
@@ -289,7 +289,7 @@ 
             return $text;
         }
 
-        return trim(mb_substr($text, 0, $targetLength)) . $append;
+        return trim(mb_substr($text, 0, $targetLength)).$append;
     }
 
     /**
@@ -302,7 +302,7 @@ 
      */
     public static function explodeTrim(string $delimiter, string $string) : array
     {
-        if(empty($string) || empty($delimiter)) {
+        if (empty($string) || empty($delimiter)) {
             return array();
         }
 
@@ -310,8 +310,8 @@ 
         $tokens = array_map('trim', $tokens);
 
         $keep = array();
-        foreach($tokens as $token) {
-            if($token !== '') {
+        foreach ($tokens as $token) {
+            if ($token !== '') {
                 $keep[] = $token;
             }
         }

src/RequestHelper/Exception.php

Indentation +8 added lines, -8 removed lines

@@ -22,9 +22,9 @@ 
  */
 class RequestHelper_Exception extends BaseException
 {
-   /**
-    * @var RequestHelper_Response|NULL
-    */
+    /**
+     * @var RequestHelper_Response|NULL
+     */
     protected $response = null;
 
     /**
@@ -37,11 +37,11 @@ 
         return $this;
     }
     
-   /**
-    * Retrieves the related response instance, if available.
-    * 
-    * @return RequestHelper_Response|NULL
-    */
+    /**
+     * Retrieves the related response instance, if available.
+     * 
+     * @return RequestHelper_Response|NULL
+     */
     public function getResponse() : ?RequestHelper_Response
     {
         return $this->response;

src/NumberInfo/Comparer.php

Spacing +7 added lines, -7 removed lines

@@ -55,12 +55,12 @@ 
      */
     private function validate() : bool
     {
-        if($this->a->getUnits() !== $this->b->getUnits())
+        if ($this->a->getUnits() !== $this->b->getUnits())
         {
             return false;
         }
 
-        if($this->a->isEmpty() || $this->b->isEmpty())
+        if ($this->a->isEmpty() || $this->b->isEmpty())
         {
             return false;
         }
@@ -70,7 +70,7 @@ 
 
     public function isBiggerThan() : bool
     {
-        if($this->valid === false)
+        if ($this->valid === false)
         {
             return false;
         }
@@ -80,7 +80,7 @@ 
 
     public function isBiggerEqual() : bool
     {
-        if($this->valid === false)
+        if ($this->valid === false)
         {
             return false;
         }
@@ -90,7 +90,7 @@ 
 
     public function isSmallerThan() : bool
     {
-        if($this->valid === false)
+        if ($this->valid === false)
         {
             return false;
         }
@@ -100,7 +100,7 @@ 
 
     public function isSmallerEqual() : bool
     {
-        if($this->valid === false)
+        if ($this->valid === false)
         {
             return false;
         }
@@ -110,7 +110,7 @@ 
 
     public function isEqual() : bool
     {
-        if($this->valid === false)
+        if ($this->valid === false)
         {
             return false;
         }

src/NumberInfo/Immutable.php

Spacing +8 added lines, -8 removed lines

@@ -14,7 +14,7 @@ 
     {
         $number = parseNumber($value, true);
 
-        if($number->getNumber() === $this->getNumber() && $number->hasUnits() === $this->hasUnits())
+        if ($number->getNumber() === $this->getNumber() && $number->hasUnits() === $this->hasUnits())
         {
             return $this;
         }
@@ -30,7 +30,7 @@ 
     {
         $number = parseNumber($number, true);
 
-        if($number->getNumber() === $this->getNumber() && $number->getUnits() === $this->getUnits())
+        if ($number->getNumber() === $this->getNumber() && $number->getUnits() === $this->getUnits())
         {
             return $this;
         }
@@ -47,7 +47,7 @@ 
         $number = parseNumber($this, true);
         $number->add($value);
 
-        if($number->getNumber() === $this->getNumber())
+        if ($number->getNumber() === $this->getNumber())
         {
             return $this;
         }
@@ -64,7 +64,7 @@ 
         $number = parseNumber($this, true);
         $number->subtract($value);
 
-        if($number->getNumber() === $this->getNumber())
+        if ($number->getNumber() === $this->getNumber())
         {
             return $this;
         }
@@ -81,7 +81,7 @@ 
         $number = parseNumber($this, true);
         $number->subtractPercent($percent);
 
-        if($number->getNumber() === $this->getNumber())
+        if ($number->getNumber() === $this->getNumber())
         {
             return $this;
         }
@@ -98,7 +98,7 @@ 
         $number = parseNumber($this, true);
         $number->addPercent($percent);
 
-        if($number->getNumber() === $this->getNumber())
+        if ($number->getNumber() === $this->getNumber())
         {
             return $this;
         }
@@ -114,7 +114,7 @@ 
         $number = parseNumber($this, true);
         $number->floorEven();
 
-        if($number->getNumber() === $this->getNumber())
+        if ($number->getNumber() === $this->getNumber())
         {
             return $this;
         }
@@ -130,7 +130,7 @@ 
         $number = parseNumber($this, true);
         $number->ceilEven();
 
-        if($number->getNumber() === $this->getNumber())
+        if ($number->getNumber() === $this->getNumber())
         {
             return $this;
         }

src/NumberInfo.php

Indentation +77 added lines, -77 removed lines

@@ -40,19 +40,19 @@ 
  */
 class NumberInfo
 {
-   /**
-    * @var string|int|float|null
-    */
+    /**
+     * @var string|int|float|null
+     */
     protected $rawValue;
     
-   /**
-    * @var array<string,mixed>
-    */
+    /**
+     * @var array<string,mixed>
+     */
     protected $info;
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected $empty = false;
 
     /**
@@ -62,8 +62,8 @@ 
 
     /**
      * Units and whether they allow decimal values.
-    * @var array<string,bool>
-    */
+     * @var array<string,bool>
+     */
     protected $knownUnits = array(
         '%' => true,
         'rem' => true,
@@ -141,21 +141,21 @@ 
         return $this;
     }
     
-   /**
-    * Retrieves the raw, internal information array resulting
-    * from the parsing of the number.
-    *  
-    * @return array<string,mixed>
-    */
+    /**
+     * Retrieves the raw, internal information array resulting
+     * from the parsing of the number.
+     *  
+     * @return array<string,mixed>
+     */
     public function getRawInfo() : array
     {
         return $this->info;
     }
     
-   /**
-    * Whether the number was empty (null or empty string).
-    * @return boolean
-    */
+    /**
+     * Whether the number was empty (null or empty string).
+     * @return boolean
+     */
     public function isEmpty() : bool
     {
         return $this->empty;
@@ -729,12 +729,12 @@ 
         return $cache[$key];
     }
     
-   /**
-    * Parses a string number notation with units included, e.g. 14px, 50%...
-    * 
-    * @param string $test
-    * @return array<string,mixed>
-    */
+    /**
+     * Parses a string number notation with units included, e.g. 14px, 50%...
+     * 
+     * @param string $test
+     * @return array<string,mixed>
+     */
     private function parseStringValue(string $test) : array
     {
         $number = null;
@@ -785,13 +785,13 @@ 
         return $this->filterInfo($result);
     }
     
-   /**
-    * Attempts to determine what kind of units are specified
-    * in the string. Returns NULL if none could be matched.
-    * 
-    * @param string $value
-    * @return array<string,mixed>|NULL
-    */
+    /**
+     * Attempts to determine what kind of units are specified
+     * in the string. Returns NULL if none could be matched.
+     * 
+     * @param string $value
+     * @return array<string,mixed>|NULL
+     */
     private function findUnits(string $value) : ?array
     {
         $vlength = strlen($value);
@@ -819,12 +819,12 @@ 
         return null;
     }
     
-   /**
-    * Creates the cache key for the specified value.
-    * 
-    * @param mixed $value
-    * @return string
-    */
+    /**
+     * Creates the cache key for the specified value.
+     * 
+     * @param mixed $value
+     * @return string
+     */
     private function createValueKey($value) : string
     {
         if(!is_string($value) && !is_numeric($value))
@@ -835,59 +835,59 @@ 
         return (string)$value;
     }
 
-   /**
-    * Called if explicitly enabled: allows filtering the 
-    * number after the detection process has completed.
-    * 
-    * @param string|NULL $number The adjusted number
-    * @param string $originalString The original value before it was parsed
-    * @return string|null
-    */
+    /**
+     * Called if explicitly enabled: allows filtering the 
+     * number after the detection process has completed.
+     * 
+     * @param string|NULL $number The adjusted number
+     * @param string $originalString The original value before it was parsed
+     * @return string|null
+     */
     protected function postProcess(?string $number, /** @scrutinizer ignore-unused */ string $originalString)
     {
         return $number;
     }
     
-   /**
-    * Filters the value before it is parsed, but only if it is a string.
-    * 
-    * NOTE: This may be overwritten in a subclass, to allow custom filtering
-    * the values. An example of a use case would be a preprocessor for
-    * variables in a templating system.
-    * 
-    * @param string $trimmedString The trimmed value.
-    * @param array<string,mixed> $cache The internal values cache array.
-    * @param string $originalValue The original value that the NumberInfo was created for.
-    * @return string
-    * 
-    * @see NumberInfo::enablePostProcess()
-    */
+    /**
+     * Filters the value before it is parsed, but only if it is a string.
+     * 
+     * NOTE: This may be overwritten in a subclass, to allow custom filtering
+     * the values. An example of a use case would be a preprocessor for
+     * variables in a templating system.
+     * 
+     * @param string $trimmedString The trimmed value.
+     * @param array<string,mixed> $cache The internal values cache array.
+     * @param string $originalValue The original value that the NumberInfo was created for.
+     * @return string
+     * 
+     * @see NumberInfo::enablePostProcess()
+     */
     protected function preProcess(string $trimmedString, /** @scrutinizer ignore-unused */ array &$cache, /** @scrutinizer ignore-unused */ string $originalValue) : string
     {
         return str_replace(',', '.', $trimmedString);
     }
     
-   /**
-    * Enables the post-processing so the postProcess method gets called.
-    * This should be called in the {@link NumberInfo::preProcess()}
-    * method as needed.
-    * 
-    * @return $this
-    * @see NumberInfo::postProcess()
-    */
+    /**
+     * Enables the post-processing so the postProcess method gets called.
+     * This should be called in the {@link NumberInfo::preProcess()}
+     * method as needed.
+     * 
+     * @return $this
+     * @see NumberInfo::postProcess()
+     */
     protected function enablePostProcess() : NumberInfo
     {
         $this->postProcess = true;
         return $this;
     }
     
-   /**
-    * Filters the number info array to adjust the units
-    * and number according to the required rules.
-    * 
-    * @param array<string,mixed> $info
-    * @return array<string,mixed>
-    */
+    /**
+     * Filters the number info array to adjust the units
+     * and number according to the required rules.
+     * 
+     * @param array<string,mixed> $info
+     * @return array<string,mixed>
+     */
     protected function filterInfo(array $info) : array
     {
         $useUnits = 'px';

Spacing +48 added lines, -48 removed lines

@@ -130,7 +130,7 @@ 
      */
     protected function _setValue($value)
     {
-        if($value instanceof NumberInfo) {
+        if ($value instanceof NumberInfo) {
             $value = $value->getValue();
         }
 
@@ -170,7 +170,7 @@ 
      */
     public function isPositive() : bool
     {
-        if($this->isEmpty())
+        if ($this->isEmpty())
         {
             return false;
         }
@@ -185,7 +185,7 @@ 
      */
     public function isZero() : bool
     {
-        if($this->isEmpty())
+        if ($this->isEmpty())
         {
             return false;
         }
@@ -231,23 +231,23 @@ 
     {
         // Append the units if the value is a number,
         // so they can be inherited.
-        if($this->hasUnits() && is_numeric($number))
+        if ($this->hasUnits() && is_numeric($number))
         {
             $number .= $this->getUnits();
         }
 
         $new = parseNumber($number);
 
-        if($new->isEmpty())
+        if ($new->isEmpty())
         {
             return $this;
         }
 
-        if($new->getUnits() === $this->getUnits())
+        if ($new->getUnits() === $this->getUnits())
         {
             $value = $new->getNumber();
 
-            if($this->hasUnits()) {
+            if ($this->hasUnits()) {
                 $value .= $this->getUnits();
             }
 
@@ -289,7 +289,7 @@ 
     {
         $number = (float)$this->info['number'];
 
-        if($this->hasDecimals())
+        if ($this->hasDecimals())
         {
             return $number;
         }
@@ -325,11 +325,11 @@ 
      */
     public function getUnits() : string
     {
-        if($this->isEmpty()) {
+        if ($this->isEmpty()) {
             return '';
         }
 
-        if(!$this->hasUnits()) {
+        if (!$this->hasUnits()) {
             return 'px';
         }
         
@@ -363,15 +363,15 @@ 
      */
     public function toAttribute() : string
     {
-        if($this->isEmpty()) {
+        if ($this->isEmpty()) {
             return '';
         }
         
-        if($this->isZero()) {
+        if ($this->isZero()) {
             return '0';
         }
         
-        if($this->isPercent()) {
+        if ($this->isPercent()) {
             return $this->getNumber().$this->getUnits();
         }
         
@@ -384,11 +384,11 @@ 
      */
     public function toCSS() : string
     {
-        if($this->isEmpty()) {
+        if ($this->isEmpty()) {
             return '';
         }
         
-        if($this->isZero()) {
+        if ($this->isZero()) {
             return '0';
         }
         
@@ -397,7 +397,7 @@ 
     
     public function __toString()
     {
-        if($this->isEmpty()) {
+        if ($this->isEmpty()) {
             return '';
         }
         
@@ -503,7 +503,7 @@ 
      */
     public function add($value)
     {
-        if($this->isEmpty())
+        if ($this->isEmpty())
         {
             $this->setValue($value);
             return $this;
@@ -511,11 +511,11 @@ 
         
         $number = parseNumber($value);
         
-        if($number->getUnits() === $this->getUnits() || !$number->hasUnits())
+        if ($number->getUnits() === $this->getUnits() || !$number->hasUnits())
         {
             $new = $this->getNumber() + $number->getNumber();
 
-            if($this->hasUnits())
+            if ($this->hasUnits())
             {
                 $new .= $this->getUnits();
             }
@@ -536,7 +536,7 @@ 
      */
     public function subtract($value)
     {
-        if($this->isEmpty())
+        if ($this->isEmpty())
         {
             $this->setValue($value);
             return $this;
@@ -544,11 +544,11 @@ 
         
         $number = parseNumber($value);
         
-        if($number->getUnits() == $this->getUnits() || !$number->hasUnits())
+        if ($number->getUnits() == $this->getUnits() || !$number->hasUnits())
         {
             $new = $this->getNumber() - $number->getNumber();
 
-            if($this->hasUnits())
+            if ($this->hasUnits())
             {
                 $new .= $this->getUnits();
             }
@@ -588,13 +588,13 @@ 
      */
     protected function percentOperation(string $operation, $percent)
     {
-        if($this->isZeroOrEmpty()) {
+        if ($this->isZeroOrEmpty()) {
             return $this;
         }
         
         $percent = parseNumber($percent);
 
-        if($percent->hasUnits() && !$percent->isPercent())
+        if ($percent->hasUnits() && !$percent->isPercent())
         {
             return $this;
         }
@@ -602,18 +602,18 @@ 
         $number = $this->getNumber();
         $value = $number * $percent->getNumber() / 100;
         
-        if($operation == '-') {
+        if ($operation == '-') {
             $number = $number - $value;
         } else {
             $number = $number + $value;
         }
         
-        if($this->isUnitInteger())
+        if ($this->isUnitInteger())
         {
             $number = intval($number);
         }
 
-        if($this->hasUnits())
+        if ($this->hasUnits())
         {
             $number .= $this->getUnits();
         }
@@ -627,7 +627,7 @@ 
     {
         $units = $this->getUnits();
 
-        if(isset($this->knownUnits[$units]))
+        if (isset($this->knownUnits[$units]))
         {
             return !$this->knownUnits[$units];
         }
@@ -639,7 +639,7 @@ 
     {
         $units = $this->getUnits();
 
-        if(isset($this->knownUnits[$units]))
+        if (isset($this->knownUnits[$units]))
         {
             return $this->knownUnits[$units];
         }
@@ -678,7 +678,7 @@ 
         
         $key = $this->createValueKey($value);
 
-        if(array_key_exists($key, $cache)) {
+        if (array_key_exists($key, $cache)) {
             return $cache[$key];
         }
         
@@ -688,13 +688,13 @@ 
             'number' => null
         );
         
-        if($key === '_EMPTY_') 
+        if ($key === '_EMPTY_') 
         {
             $cache[$key]['empty'] = true;
             return $cache[$key];
         }
         
-        if($value === 0 || $value === '0') 
+        if ($value === 0 || $value === '0') 
         {
             $cache[$key]['number'] = 0;
             $cache[$key] = $this->filterInfo($cache[$key]);
@@ -703,20 +703,20 @@ 
         
         $test = trim((string)$value);
         
-        if($test === '') 
+        if ($test === '') 
         {
             $cache[$key]['empty'] = true;
             return $cache[$key];
         }
         
         // replace comma notation (which is only possible if it's a string)
-        if(is_string($value))
+        if (is_string($value))
         {
             $test = $this->preProcess($test, $cache, $value);
         }
         
         // convert to a number if it's numeric
-        if(is_numeric($test)) 
+        if (is_numeric($test)) 
         {
             $cache[$key]['number'] = (float)$test * 1;
             $cache[$key] = $this->filterInfo($cache[$key]);
@@ -742,19 +742,19 @@ 
         $empty = false;
         
         $found = $this->findUnits($test);
-        if($found !== null) 
+        if ($found !== null) 
         {
             $number = $found['number'];
             $units = $found['units'];
         }
         
         // the filters have to restore the value
-        if($this->postProcess)
+        if ($this->postProcess)
         {
             $number = $this->postProcess($number, $test);
         }
         // empty number
-        else if($number === '' || $number === null || is_bool($number))
+        else if ($number === '' || $number === null || is_bool($number))
         {
             $number = null;
             $empty = true;
@@ -765,7 +765,7 @@ 
             $number = trim($number);
             
             // may be an arbitrary string in some cases
-            if(!is_numeric($number))
+            if (!is_numeric($number))
             {
                 $number = null;
                 $empty = true;
@@ -797,17 +797,17 @@ 
         $vlength = strlen($value);
         $names = array_keys($this->knownUnits);
         
-        foreach($names as $unit)
+        foreach ($names as $unit)
         {
             $ulength = strlen($unit);
-            $start = $vlength-$ulength;
-            if($start < 0) {
+            $start = $vlength - $ulength;
+            if ($start < 0) {
                 continue;
             }
             
             $search = substr($value, $start, $ulength);
             
-            if($search==$unit) 
+            if ($search == $unit) 
             {
                 return array(
                     'units' => $unit,
@@ -827,7 +827,7 @@ 
     */
     private function createValueKey($value) : string
     {
-        if(!is_string($value) && !is_numeric($value))
+        if (!is_string($value) && !is_numeric($value))
         {
             return '_EMPTY_';
         }
@@ -891,12 +891,12 @@ 
     protected function filterInfo(array $info) : array
     {
         $useUnits = 'px';
-        if($info['units'] !== null) {
+        if ($info['units'] !== null) {
             $useUnits = $info['units'];
         }
         
         // the units are non-decimal: convert decimal values
-        if($this->knownUnits[$useUnits] === false && !$info['empty'] && is_numeric($info['number']))
+        if ($this->knownUnits[$useUnits] === false && !$info['empty'] && is_numeric($info['number']))
         {
             $info['number'] = intval($info['number']);
         }
@@ -922,7 +922,7 @@ 
     {
         $number = floor($this->getNumber());
 
-        if($number % 2 == 1) $number--;
+        if ($number % 2 == 1) $number--;
 
         return $this->setNumber($number);
     }
@@ -938,7 +938,7 @@ 
     {
         $number = ceil($this->getNumber());
 
-        if($number % 2 == 1) $number++;
+        if ($number % 2 == 1) $number++;
 
         return $this->setNumber($number);
     }

Braces +7 added lines, -4 removed lines

@@ -769,8 +769,7 @@ 
             {
                 $number = null;
                 $empty = true;
-            }
-            else
+            } else
             {
                 $number = (float)$number * 1;
             }
@@ -922,7 +921,9 @@ 
     {
         $number = floor($this->getNumber());
 
-        if($number % 2 == 1) $number--;
+        if($number % 2 == 1) {
+            $number--;
+        }
 
         return $this->setNumber($number);
     }
@@ -938,7 +939,9 @@ 
     {
         $number = ceil($this->getNumber());
 
-        if($number % 2 == 1) $number++;
+        if($number % 2 == 1) {
+            $number++;
+        }
 
         return $this->setNumber($number);
     }