Mistralys / application-utils

src/ConvertHelper/ThrowableInfo/Call.php

Indentation +56 added lines, -56 removed lines

@@ -10,45 +10,45 @@ 
     public const TYPE_METHOD_CALL = 'method';
     public const TYPE_SCRIPT_START = 'start';
     
-   /**
-    * @var ConvertHelper_ThrowableInfo
-    */
+    /**
+     * @var ConvertHelper_ThrowableInfo
+     */
     protected $info;
     
-   /**
-    * @var VariableInfo[]
-    */
+    /**
+     * @var VariableInfo[]
+     */
     protected $args = array();
     
-   /**
-    * The source file, if any
-    * @var string
-    */
+    /**
+     * The source file, if any
+     * @var string
+     */
     protected $file = '';
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $class = '';
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     protected $line = 0;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $position = 1;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $function = '';
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $type = self::TYPE_SCRIPT_START;
 
     /**
@@ -79,10 +79,10 @@ 
         }
     }
     
-   /**
-    * 1-based position of the call in the calls list.
-    * @return int
-    */
+    /**
+     * 1-based position of the call in the calls list.
+     * @return int
+     */
     public function getPosition() : int
     {
         return $this->position;
@@ -93,18 +93,18 @@ 
         return $this->line;
     }
     
-   /**
-    * Whether the call had any arguments.
-    * @return bool
-    */
+    /**
+     * Whether the call had any arguments.
+     * @return bool
+     */
     public function hasArguments() : bool
     {
         return !empty($this->args);
     }
     
-   /**
-    * @return VariableInfo[]
-    */
+    /**
+     * @return VariableInfo[]
+     */
     public function getArguments()
     {
         return $this->args;
@@ -244,31 +244,31 @@ 
         return implode(', ', $tokens); 
     }
     
-   /**
-    * Retrieves the type of call: typically a function
-    * call, or a method call of an object. Note that the
-    * first call in a script does not have either.
-    * 
-    * @return string
-    * 
-    * @see ConvertHelper_ThrowableInfo_Call::TYPE_FUNCTION_CALL
-    * @see ConvertHelper_ThrowableInfo_Call::TYPE_METHOD_CALL
-    * @see ConvertHelper_ThrowableInfo_Call::TYPE_SCRIPT_START
-    * @see ConvertHelper_ThrowableInfo_Call::hasFunction()
-    * @see ConvertHelper_ThrowableInfo_Call::hasClass()
-    */
+    /**
+     * Retrieves the type of call: typically a function
+     * call, or a method call of an object. Note that the
+     * first call in a script does not have either.
+     * 
+     * @return string
+     * 
+     * @see ConvertHelper_ThrowableInfo_Call::TYPE_FUNCTION_CALL
+     * @see ConvertHelper_ThrowableInfo_Call::TYPE_METHOD_CALL
+     * @see ConvertHelper_ThrowableInfo_Call::TYPE_SCRIPT_START
+     * @see ConvertHelper_ThrowableInfo_Call::hasFunction()
+     * @see ConvertHelper_ThrowableInfo_Call::hasClass()
+     */
     public function getType() : string
     {
         return $this->type;
     }
      
-   /**
-    * Serializes the call to an array, with all
-    * necessary information. Can be used to restore
-    * the call later using {@link ConvertHelper_ThrowableInfo_Call::fromSerialized()}.
-    * 
-    * @return array<string,mixed>
-    */
+    /**
+     * Serializes the call to an array, with all
+     * necessary information. Can be used to restore
+     * the call later using {@link ConvertHelper_ThrowableInfo_Call::fromSerialized()}.
+     * 
+     * @return array<string,mixed>
+     */
     public function serialize() : array
     {
         $result = array(

src/ConvertHelper/DurationConverter.php

Indentation +47 added lines, -47 removed lines

@@ -34,39 +34,39 @@ 
     public const SECONDS_PER_MONTH_APPROX = 2505600; // imprecise - for 29 days, only for approximations. 
     public const SECONDS_PER_YEAR = 31536000;
     
-   /**
-    * @var int|NULL
-    */
+    /**
+     * @var int|NULL
+     */
     protected $dateFrom;
     
-   /**
-    * @var int|NULL
-    */
+    /**
+     * @var int|NULL
+     */
     protected $dateTo;
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected $future = false;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $interval = '';
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $difference = 0;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $dateDiff = 0;
     
-   /**
-    * @var array<string,array<string,string>>|NULL
-    */
+    /**
+     * @var array<string,array<string,string>>|NULL
+     */
     protected static $texts = null;
     
     public function __construct()
@@ -86,17 +86,17 @@ 
         self::$texts = null;
     }
     
-   /**
-    * Sets the origin date to calculate from.
-    * 
-    * NOTE: if this is further in the future than
-    * the to: date, it will be considered as a 
-    * calculation for something to come, i.e. 
-    * "In two days".
-    *  
-    * @param DateTime $date
-    * @return ConvertHelper_DurationConverter
-    */
+    /**
+     * Sets the origin date to calculate from.
+     * 
+     * NOTE: if this is further in the future than
+     * the to: date, it will be considered as a 
+     * calculation for something to come, i.e. 
+     * "In two days".
+     *  
+     * @param DateTime $date
+     * @return ConvertHelper_DurationConverter
+     */
     public function setDateFrom(DateTime $date) : ConvertHelper_DurationConverter
     {
         $this->dateFrom = ConvertHelper::date2timestamp($date);
@@ -104,13 +104,13 @@ 
         return $this;
     }
     
-   /**
-    * Sets the date to calculate to. Defaults to 
-    * the current time if not set.
-    * 
-    * @param DateTime $date
-    * @return ConvertHelper_DurationConverter
-    */
+    /**
+     * Sets the date to calculate to. Defaults to 
+     * the current time if not set.
+     * 
+     * @param DateTime $date
+     * @return ConvertHelper_DurationConverter
+     */
     public function setDateTo(DateTime $date) : ConvertHelper_DurationConverter
     {
         $this->dateTo = ConvertHelper::date2timestamp($date);
@@ -118,14 +118,14 @@ 
         return $this;
     }
     
-   /**
-    * Converts the specified dates to a human-readable string.
-    * 
-    * @throws ConvertHelper_Exception
-    * @return string
-    * 
-    * @see ConvertHelper_DurationConverter::ERROR_NO_DATE_FROM_SET
-    */
+    /**
+     * Converts the specified dates to a human-readable string.
+     * 
+     * @throws ConvertHelper_Exception
+     * @return string
+     * 
+     * @see ConvertHelper_DurationConverter::ERROR_NO_DATE_FROM_SET
+     */
     public function convert() : string
     {
         $this->initTexts();

src/ConvertHelper/SizeNotation.php

Indentation +89 added lines, -89 removed lines

@@ -31,9 +31,9 @@ 
     
     public const VALIDATION_ERROR_NEGATIVE_VALUE = 43803;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $sizeString;
 
     /**
@@ -41,44 +41,44 @@ 
      */
     protected $sizeDefinition;
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     protected $bytes = 0;
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected $valid = true;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $units = null;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $number = '';
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $errorMessage = '';
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $errorCode = 0;
     
-   /**
-    * Create a new instance for the specified size string.
-    * 
-    * @param string $sizeString A size notation in the format "50 MB", or a number of bytes without units. Spaces are ignored, so "50MB" = "50 MB" = "  50   MB   ". Floating point values are accepted, both with dot and comma notation ("50.5" = "50,5"). To use Base 2 values, ose appropriate units, e.g. "50 MiB", "1.5 GiB". The units are case-insensitive, so "50 MB" = "50 mb".
-    *
-    * @throws ConvertHelper_Exception
-    * @see ConvertHelper_StorageSizeEnum::ERROR_UNKNOWN_UNIT_NAME
-    */
+    /**
+     * Create a new instance for the specified size string.
+     * 
+     * @param string $sizeString A size notation in the format "50 MB", or a number of bytes without units. Spaces are ignored, so "50MB" = "50 MB" = "  50   MB   ". Floating point values are accepted, both with dot and comma notation ("50.5" = "50,5"). To use Base 2 values, ose appropriate units, e.g. "50 MiB", "1.5 GiB". The units are case-insensitive, so "50 MB" = "50 mb".
+     *
+     * @throws ConvertHelper_Exception
+     * @see ConvertHelper_StorageSizeEnum::ERROR_UNKNOWN_UNIT_NAME
+     */
     public function __construct(string $sizeString)
     {
         $this->sizeString = $this->cleanString($sizeString);
@@ -86,31 +86,31 @@ 
         $this->convert();
     }
     
-   /**
-    * Gets the amount of bytes contained in the size notation.
-    * @return int
-    */
+    /**
+     * Gets the amount of bytes contained in the size notation.
+     * @return int
+     */
     public function toBytes() : int
     {
         return $this->bytes;
     }
     
-   /**
-    * Converts the size notation to a human-readable string, e.g. "50 MB".
-    * 
-    * @param int $precision
-    * @return string
-    * @see ConvertHelper::bytes2readable()
-    */
+    /**
+     * Converts the size notation to a human-readable string, e.g. "50 MB".
+     * 
+     * @param int $precision
+     * @return string
+     * @see ConvertHelper::bytes2readable()
+     */
     public function toString(int $precision=1) : string
     {
         return ConvertHelper::bytes2readable($this->bytes, $precision, $this->getBase());
     }
     
-   /**
-    * Retrieves the detected number's base.
-    * @return int The base number (1000 for Base 10, or 1024 for Base 2), or 0 if it is not valid.
-    */
+    /**
+     * Retrieves the detected number's base.
+     * @return int The base number (1000 for Base 10, or 1024 for Base 2), or 0 if it is not valid.
+     */
     public function getBase() : int
     {
         if($this->isValid()) {
@@ -120,13 +120,13 @@ 
         return 0;
     }
     
-   /**
-    * Retrieves the detected storage size instance, if 
-    * the size string is valid.
-    * 
-    * @return ConvertHelper_StorageSizeEnum_Size|NULL
-    * @see ConvertHelper_StorageSizeEnum_Size
-    */
+    /**
+     * Retrieves the detected storage size instance, if 
+     * the size string is valid.
+     * 
+     * @return ConvertHelper_StorageSizeEnum_Size|NULL
+     * @see ConvertHelper_StorageSizeEnum_Size
+     */
     public function getSizeDefinition() : ?ConvertHelper_StorageSizeEnum_Size
     {
         if($this->isValid()) {
@@ -136,27 +136,27 @@ 
         return null;
     }
     
-   /**
-    * Checks whether the size notation was valid and could be parsed
-    * into a meaningful byte value. If this returns `false`, it is 
-    * possible to use the `getErrorXXX` methods to retrieve information
-    * on what went wrong. 
-    * 
-    * @return bool
-    * @see ConvertHelper_SizeNotation::getErrorMessage()
-    * @see ConvertHelper_SizeNotation::getErrorCode()
-    */
+    /**
+     * Checks whether the size notation was valid and could be parsed
+     * into a meaningful byte value. If this returns `false`, it is 
+     * possible to use the `getErrorXXX` methods to retrieve information
+     * on what went wrong. 
+     * 
+     * @return bool
+     * @see ConvertHelper_SizeNotation::getErrorMessage()
+     * @see ConvertHelper_SizeNotation::getErrorCode()
+     */
     public function isValid() : bool
     {
         return $this->valid;
     }
     
-   /**
-    * Retrieves the error message if the size notation validation failed.
-    * 
-    * @return string
-    * @see ConvertHelper_SizeNotation::getErrorCode()
-    */
+    /**
+     * Retrieves the error message if the size notation validation failed.
+     * 
+     * @return string
+     * @see ConvertHelper_SizeNotation::getErrorCode()
+     */
     public function getErrorMessage() : string
     {
         return $this->errorMessage;
@@ -201,12 +201,12 @@ 
         );
     }
     
-   /**
-    * Detects the units and the number in the size notation string.
-    * Populates the `units` and `number` properties.
-    * 
-    * @return bool Whether the string could be parsed successfully.
-    */
+    /**
+     * Detects the units and the number in the size notation string.
+     * Populates the `units` and `number` properties.
+     * 
+     * @return bool Whether the string could be parsed successfully.
+     */
     protected function detectParts() : bool
     {
         $units = ConvertHelper_StorageSizeEnum::getSizeNames();
@@ -242,16 +242,16 @@ 
         return true;
     }
     
-   /**
-    * If the validation fails, this is used to store the reason for retrieval later.
-    *  
-    * @param string $message
-    * @param int $code
-    * 
-    * @see ConvertHelper_SizeNotation::isValid()
-    * @see ConvertHelper_SizeNotation::getErrorMessage()
-    * @see ConvertHelper_SizeNotation::getErrorCode()
-    */
+    /**
+     * If the validation fails, this is used to store the reason for retrieval later.
+     *  
+     * @param string $message
+     * @param int $code
+     * 
+     * @see ConvertHelper_SizeNotation::isValid()
+     * @see ConvertHelper_SizeNotation::getErrorMessage()
+     * @see ConvertHelper_SizeNotation::getErrorCode()
+     */
     protected function setError(string $message, int $code) : void
     {
         $this->valid = false;
@@ -259,12 +259,12 @@ 
         $this->errorCode = $code;
     }
     
-   /**
-    * Retrieves the error code, if the size notation validation failed.
-    * 
-    * @return int
-    * @see ConvertHelper_SizeNotation::getErrorMessage()
-    */
+    /**
+     * Retrieves the error code, if the size notation validation failed.
+     * 
+     * @return int
+     * @see ConvertHelper_SizeNotation::getErrorMessage()
+     */
     public function getErrorCode() : int
     {
         return $this->errorCode;

src/ConvertHelper/IntervalConverter.php

Indentation +38 added lines, -39 removed lines

@@ -17,21 +17,20 @@ 
  * @package Application Utils
  * @subpackage ConvertHelper
  * @author Sebastian Mordziol <s.mordziol@mistralys.eu>
-
  * @see ConvertHelper::interval2string()
  */
 class ConvertHelper_IntervalConverter
 {
     public const ERROR_MISSING_TRANSLATION = 43501;
     
-   /**
-    * @var array<string,string>|NULL
-    */
+    /**
+     * @var array<string,string>|NULL
+     */
     protected static $texts = null;
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected $tokens = array('y', 'm', 'd', 'h', 'i', 's');
     
     public function __construct()
@@ -41,25 +40,25 @@ 
         }
     }
     
-   /**
-    * Called whenever the application locale has changed,
-    * to reset the internal translation cache.
-    */
+    /**
+     * Called whenever the application locale has changed,
+     * to reset the internal translation cache.
+     */
     public function handle_localeChanged() : void
     {
         self::$texts = null;
     }
     
-   /**
-    * Converts the specified interval to a human-readable
-    * string, e.g. "2 hours and 4 minutes".
-    * 
-    * @param \DateInterval $interval
-    * @return string
-    * @throws ConvertHelper_Exception
-    * 
-    * @see ConvertHelper_IntervalConverter::ERROR_MISSING_TRANSLATION
-    */
+    /**
+     * Converts the specified interval to a human-readable
+     * string, e.g. "2 hours and 4 minutes".
+     * 
+     * @param \DateInterval $interval
+     * @return string
+     * @throws ConvertHelper_Exception
+     * 
+     * @see ConvertHelper_IntervalConverter::ERROR_MISSING_TRANSLATION
+     */
     public function toString(\DateInterval $interval) : string
     {
         $this->initTexts();
@@ -88,14 +87,14 @@ 
         return t('%1$s and %2$s', implode(', ', $parts), $last);
     }
     
-   /**
-    * Translates the selected time token, e.g. "y" (for year).
-    * 
-    * @param string $token
-    * @param ConvertHelper_DateInterval $interval
-    * @throws ConvertHelper_Exception
-    * @return string
-    */
+    /**
+     * Translates the selected time token, e.g. "y" (for year).
+     * 
+     * @param string $token
+     * @param ConvertHelper_DateInterval $interval
+     * @throws ConvertHelper_Exception
+     * @return string
+     */
     protected function translateToken(string $token, ConvertHelper_DateInterval $interval) : string
     {
         $value = $interval->getToken($token);
@@ -123,13 +122,13 @@ 
         );
     }
     
-   /**
-    * Resolves all time tokens that need to be translated in
-    * the subject interval, depending on its length.
-    * 
-    * @param ConvertHelper_DateInterval $interval
-    * @return string[]
-    */
+    /**
+     * Resolves all time tokens that need to be translated in
+     * the subject interval, depending on its length.
+     * 
+     * @param ConvertHelper_DateInterval $interval
+     * @return string[]
+     */
     protected function resolveTokens(ConvertHelper_DateInterval $interval) : array
     {
         $offset = 0;
@@ -147,9 +146,9 @@ 
         return array();
     }
     
-   /**
-    * Initializes the translateable strings.
-    */
+    /**
+     * Initializes the translateable strings.
+     */
     protected function initTexts() : void
     {
         if(isset(self::$texts)) {

src/ConvertHelper/StorageSizeEnum.php

Indentation +54 added lines, -54 removed lines

@@ -30,17 +30,17 @@ 
     public const BASE_10 = 1000;
     public const BASE_2 = 1024;
     
-   /**
-    * @var array<string,ConvertHelper_StorageSizeEnum_Size>
-    */
+    /**
+     * @var array<string,ConvertHelper_StorageSizeEnum_Size>
+     */
     protected static $sizes = array();
     
-   /**
-    * Initializes the supported unit notations, and
-    * how they are supposed to be calculated.
-    *
-    * @see ConvertHelper_SizeNotation::parseSize()
-    */
+    /**
+     * Initializes the supported unit notations, and
+     * how they are supposed to be calculated.
+     *
+     * @see ConvertHelper_SizeNotation::parseSize()
+     */
     protected static function init() : void
     {
         if(!empty(self::$sizes)) {
@@ -67,28 +67,28 @@ 
         }
     }
     
-   /**
-    * Called whenever the application locale is changed,
-    * to reset the size definitions so the labels get 
-    * translated to the new locale.
-    */
+    /**
+     * Called whenever the application locale is changed,
+     * to reset the size definitions so the labels get 
+     * translated to the new locale.
+     */
     public static function handle_localeChanged() : void
     {
         self::$sizes = array();
     }
     
-   /**
-    * Adds a storage size to the internal collection.
-    * 
-    * @param string $name The lowercase size name, e.g. "kb", "mib"
-    * @param int $base This defines how many bytes there are in a kilobyte, to differentiate with the two common way to calculate sizes: base 10 or base 2. See the Wikipedia link for more details.
-    * @param int $exponent The multiplier of the base to get the byte value
-    * @param string $suffix The localized short suffix, e.g. "KB", "MiB"
-    * @param string $singular The localized singular label of the size, e.g. "Kilobyte".
-    * @param string $plural The localized plural label of the size, e.g. "Kilobytes".
-    * 
-    * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions
-    */
+    /**
+     * Adds a storage size to the internal collection.
+     * 
+     * @param string $name The lowercase size name, e.g. "kb", "mib"
+     * @param int $base This defines how many bytes there are in a kilobyte, to differentiate with the two common way to calculate sizes: base 10 or base 2. See the Wikipedia link for more details.
+     * @param int $exponent The multiplier of the base to get the byte value
+     * @param string $suffix The localized short suffix, e.g. "KB", "MiB"
+     * @param string $singular The localized singular label of the size, e.g. "Kilobyte".
+     * @param string $plural The localized plural label of the size, e.g. "Kilobytes".
+     * 
+     * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions
+     */
     protected static function addSize(string $name, int $base, int $exponent, string $suffix, string $singular, string $plural) : void
     {
         self::$sizes[$name] = new ConvertHelper_StorageSizeEnum_Size(
@@ -101,11 +101,11 @@ 
         );
     }
     
-   /**
-    * Retrieves all known sizes.
-    * 
-    * @return ConvertHelper_StorageSizeEnum_Size[]
-    */
+    /**
+     * Retrieves all known sizes.
+     * 
+     * @return ConvertHelper_StorageSizeEnum_Size[]
+     */
     public static function getSizes() : array
     {
         self::init();
@@ -113,15 +113,15 @@ 
         return array_values(self::$sizes);
     }
     
-   /**
-    * Retrieves a size definition instance by its name.
-    * 
-    * @param string $name Case-insensitive. For example "kb", "MiB"...
-    * @throws ConvertHelper_Exception
-    * @return ConvertHelper_StorageSizeEnum_Size
-    * 
-    * @see ConvertHelper_StorageSizeEnum::ERROR_UNKNOWN_UNIT_NAME
-    */
+    /**
+     * Retrieves a size definition instance by its name.
+     * 
+     * @param string $name Case-insensitive. For example "kb", "MiB"...
+     * @throws ConvertHelper_Exception
+     * @return ConvertHelper_StorageSizeEnum_Size
+     * 
+     * @see ConvertHelper_StorageSizeEnum::ERROR_UNKNOWN_UNIT_NAME
+     */
     public static function getSizeByName(string $name) : ConvertHelper_StorageSizeEnum_Size
     {
         self::init();
@@ -143,10 +143,10 @@ 
         );
     }
     
-   /**
-    * Retrieves a list of all size names, e.g. "mb", "kib" (lowercase).
-    * @return string[]
-    */
+    /**
+     * Retrieves a list of all size names, e.g. "mb", "kib" (lowercase).
+     * @return string[]
+     */
     public static function getSizeNames() : array
     {
         self::init();
@@ -154,16 +154,16 @@ 
         return array_keys(self::$sizes);
     }
    
-   /**
-    * Retrieves all available storage sizes for the specified
-    * base value.
-    * 
-    * @param int $base
-    * @return ConvertHelper_StorageSizeEnum_Size[]
-    * 
-    * @see ConvertHelper_StorageSizeEnum::BASE_10
-    * @see ConvertHelper_StorageSizeEnum::BASE_2
-    */
+    /**
+     * Retrieves all available storage sizes for the specified
+     * base value.
+     * 
+     * @param int $base
+     * @return ConvertHelper_StorageSizeEnum_Size[]
+     * 
+     * @see ConvertHelper_StorageSizeEnum::BASE_10
+     * @see ConvertHelper_StorageSizeEnum::BASE_2
+     */
     public static function getSizesByBase(int $base) : array
     {
         self::init();

src/ConvertHelper/ControlCharacters.php

Indentation +43 added lines, -43 removed lines

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

src/XMLHelper/Converter.php

Indentation +29 added lines, -29 removed lines

@@ -46,14 +46,14 @@ 
 {
     public const ERROR_FAILED_CONVERTING_TO_JSON = 37901;
     
-   /**
-    * @var SimpleXMLElement
-    */
+    /**
+     * @var SimpleXMLElement
+     */
     protected $xml;
     
-   /**
-    * @var string|NULL
-    */
+    /**
+     * @var string|NULL
+     */
     protected $json;
     
     protected function __construct(SimpleXMLElement $element)
@@ -86,34 +86,34 @@ 
         return self::fromElement(new SimpleXMLElement($xmlString));
     }
     
-   /**
-    * 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|JsonException
-    */
+    /**
+     * Converts the XML to JSON.
+     * 
+     * @return string
+     * @throws XMLHelper_Exception|JsonException
+     */
     public function toJSON() : string
     {
         if (isset($this->json))
@@ -146,11 +146,11 @@ 
         }
     }
 
-   /**
-    * Converts the XML to an associative array.
-    * @return array
-    * @throws XMLHelper_Exception|JsonException
-    */
+    /**
+     * Converts the XML to an associative array.
+     * @return array
+     * @throws XMLHelper_Exception|JsonException
+     */
     public function toArray() : array 
     {
         $json = $this->toJSON();

src/XMLHelper/DOMErrors.php

Indentation +50 added lines, -50 removed lines

@@ -23,14 +23,14 @@ 
 {
     public const SERIALIZE_SEPARATOR = '__SERSEP__';
     
-   /**
-    * @var XMLHelper_DOMErrors_Error[]
-    */
+    /**
+     * @var XMLHelper_DOMErrors_Error[]
+     */
     private $errors;
     
-   /**
-    * @param \LibXMLError[]|XMLHelper_DOMErrors_Error[] $libxmlErrors
-    */
+    /**
+     * @param \LibXMLError[]|XMLHelper_DOMErrors_Error[] $libxmlErrors
+     */
     public function __construct(array $libxmlErrors)
     {
         foreach($libxmlErrors as $error)
@@ -56,11 +56,11 @@ 
         return $this->errors;
     }
     
-   /**
-    * Retrieves all warnings, if any.
-    * 
-    * @return XMLHelper_DOMErrors_Error[]
-    */
+    /**
+     * Retrieves all warnings, if any.
+     * 
+     * @return XMLHelper_DOMErrors_Error[]
+     */
     public function getWarnings()
     {
         return $this->getByLevel(LIBXML_ERR_WARNING);
@@ -107,12 +107,12 @@ 
     }
     
     
-   /**
-    * Retrieves all errors by the specified libxml error level.
-    * 
-    * @param int $level
-    * @return \AppUtils\XMLHelper_DOMErrors_Error[]
-    */
+    /**
+     * Retrieves all errors by the specified libxml error level.
+     * 
+     * @param int $level
+     * @return \AppUtils\XMLHelper_DOMErrors_Error[]
+     */
     public function getByLevel(int $level)
     {
         $result = array();
@@ -128,12 +128,12 @@ 
         return $result;
     }
     
-   /**
-    * Retrieves all errors by the specified libxml error code.
-    * 
-    * @param int $code
-    * @return \AppUtils\XMLHelper_DOMErrors_Error[]
-    */
+    /**
+     * Retrieves all errors by the specified libxml error code.
+     * 
+     * @param int $code
+     * @return \AppUtils\XMLHelper_DOMErrors_Error[]
+     */
     public function getByCode(int $code)
     {
         $result = array();
@@ -149,12 +149,12 @@ 
         return $result;
     }
     
-   /**
-    * Checks whether there are errors matching the libxml error level.
-    * 
-    * @param int $level
-    * @return bool
-    */
+    /**
+     * Checks whether there are errors matching the libxml error level.
+     * 
+     * @param int $level
+     * @return bool
+     */
     public function hasErrorsByLevel(int $level) : bool
     {
         foreach($this->errors as $error)
@@ -168,12 +168,12 @@ 
         return false;
     }
     
-   /**
-    * Checks whether there are any errors matching the libxml error code.
-    * 
-    * @param int $code
-    * @return bool
-    */
+    /**
+     * Checks whether there are any errors matching the libxml error code.
+     * 
+     * @param int $code
+     * @return bool
+     */
     public function hasErrorsByCode(int $code) : bool
     {
         foreach($this->errors as $error)
@@ -199,13 +199,13 @@ 
         return $result;
     }
     
-   /**
-    * Serializes the errors collection, so it can be stored and
-    * restored as needed, using the `fromSerialized()` method.
-    * 
-    * @return string
-    * @see XMLHelper_DOMErrors::fromSerialized()
-    */
+    /**
+     * Serializes the errors collection, so it can be stored and
+     * restored as needed, using the `fromSerialized()` method.
+     * 
+     * @return string
+     * @see XMLHelper_DOMErrors::fromSerialized()
+     */
     public function serialize() : string
     {
         $data = array();
@@ -218,14 +218,14 @@ 
         return implode(self::SERIALIZE_SEPARATOR, $data);
     }
     
-   /**
-    * Restores the errors collection from a previously serialized
-    * collection, using `serialize()`. 
-    * 
-    * @param string $serialized
-    * @return XMLHelper_DOMErrors
-    * @see XMLHelper_DOMErrors::serialize()
-    */
+    /**
+     * Restores the errors collection from a previously serialized
+     * collection, using `serialize()`. 
+     * 
+     * @param string $serialized
+     * @return XMLHelper_DOMErrors
+     * @see XMLHelper_DOMErrors::serialize()
+     */
     public static function fromSerialized(string $serialized) : XMLHelper_DOMErrors
     {
         $parts = explode(self::SERIALIZE_SEPARATOR, $serialized);

src/XMLHelper/DOMErrors/Error.php

Indentation +3 added lines, -3 removed lines

@@ -24,9 +24,9 @@
     public const ERROR_CANNOT_UNSERIALIZE_ERROR_DATA = 57201;
     public const ERROR_ERROR_DATA_KEY_MISSING = 57202;
     
-   /**
-    * @var \LibXMLError
-    */
+    /**
+     * @var \LibXMLError
+     */
     private $error;
     
     private static $requiredKeys = array(