Mistralys / application-utils

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/Traits/Optionable.php

Indentation +72 added lines, -72 removed lines

@@ -26,9 +26,9 @@ 
  */
 trait Traits_Optionable
 {
-   /**
-    * @var array|NULL
-    */
+    /**
+     * @var array|NULL
+     */
     protected $options = null;
 
     /**
@@ -49,13 +49,13 @@ 
         return $this;
     }
     
-   /**
-    * Sets a collection of options at once, from an
-    * associative array.
-    * 
-    * @param array<string,mixed> $options
-    * @return $this
-    */
+    /**
+     * Sets a collection of options at once, from an
+     * associative array.
+     * 
+     * @param array<string,mixed> $options
+     * @return $this
+     */
     public function setOptions(array $options)
     {
         foreach($options as $name => $value) {
@@ -65,16 +65,16 @@ 
         return $this;
     }
     
-   /**
-    * Retrieves an option's value.
-    * 
-    * NOTE: Use the specialized type getters to ensure an option
-    * contains the expected type (for ex. getArrayOption()). 
-    * 
-    * @param string $name
-    * @param mixed $default The default value to return if the option does not exist.
-    * @return mixed
-    */
+    /**
+     * Retrieves an option's value.
+     * 
+     * NOTE: Use the specialized type getters to ensure an option
+     * contains the expected type (for ex. getArrayOption()). 
+     * 
+     * @param string $name
+     * @param mixed $default The default value to return if the option does not exist.
+     * @return mixed
+     */
     public function getOption(string $name, $default=null)
     {
         if(!isset($this->options)) {
@@ -88,16 +88,16 @@ 
         return $default;
     }
     
-   /**
-    * Enforces that the option value is a string. Numbers are converted
-    * to string, strings are passed through, and all other types will 
-    * return the default value. The default value is also returned if
-    * the string is empty.
-    * 
-    * @param string $name
-    * @param string $default Used if the option does not exist, is invalid, or empty.
-    * @return string
-    */
+    /**
+     * Enforces that the option value is a string. Numbers are converted
+     * to string, strings are passed through, and all other types will 
+     * return the default value. The default value is also returned if
+     * the string is empty.
+     * 
+     * @param string $name
+     * @param string $default Used if the option does not exist, is invalid, or empty.
+     * @return string
+     */
     public function getStringOption(string $name, string $default='') : string
     {
         $value = $this->getOption($name, false);
@@ -128,15 +128,15 @@ 
         return $default;
     }
     
-   /**
-    * Treats the option value as an integer value: will return
-    * valid integer values (also from integer strings), or the
-    * default value otherwise.
-    * 
-    * @param string $name
-    * @param int $default
-    * @return int
-    */
+    /**
+     * Treats the option value as an integer value: will return
+     * valid integer values (also from integer strings), or the
+     * default value otherwise.
+     * 
+     * @param string $name
+     * @param int $default
+     * @return int
+     */
     public function getIntOption(string $name, int $default=0) : int
     {
         $value = $this->getOption($name);
@@ -147,14 +147,14 @@ 
         return $default;
     }
     
-   /**
-    * Treats an option as an array, and returns its value
-    * only if it contains an array - otherwise, an empty
-    * array is returned.
-    * 
-    * @param string $name
-    * @return array
-    */
+    /**
+     * Treats an option as an array, and returns its value
+     * only if it contains an array - otherwise, an empty
+     * array is returned.
+     * 
+     * @param string $name
+     * @return array
+     */
     public function getArrayOption(string $name) : array
     {
         $val = $this->getOption($name);
@@ -165,13 +165,13 @@ 
         return array();
     }
     
-   /**
-    * Checks whether the specified option exists - even
-    * if it has a NULL value.
-    * 
-    * @param string $name
-    * @return bool
-    */
+    /**
+     * Checks whether the specified option exists - even
+     * if it has a NULL value.
+     * 
+     * @param string $name
+     * @return bool
+     */
     public function hasOption(string $name) : bool
     {
         if(!isset($this->options)) {
@@ -181,11 +181,11 @@ 
         return array_key_exists($name, $this->options);
     }
     
-   /**
-    * Returns all options in one associative array.
-    *
-    * @return array<string,mixed>
-    */
+    /**
+     * Returns all options in one associative array.
+     *
+     * @return array<string,mixed>
+     */
     public function getOptions() : array
     {
         if(!isset($this->options)) {
@@ -195,23 +195,23 @@ 
         return $this->options;
     }
     
-   /**
-    * Checks whether the option's value is the one specified.
-    * 
-    * @param string $name
-    * @param mixed $value
-    * @return bool
-    */
+    /**
+     * Checks whether the option's value is the one specified.
+     * 
+     * @param string $name
+     * @param mixed $value
+     * @return bool
+     */
     public function isOption(string $name, $value) : bool
     {
         return $this->getOption($name) === $value;
     }
     
-   /**
-    * Retrieves the default available options as an
-    * associative array with option name => value pairs.
-    *
-    * @return array<string,mixed>
-    */
+    /**
+     * Retrieves the default available options as an
+     * associative array with option name => value pairs.
+     *
+     * @return array<string,mixed>
+     */
     abstract public function getDefaultOptions() : array;
 }

src/Traits/Classable.php

Indentation +17 added lines, -17 removed lines

@@ -25,9 +25,9 @@ 
  */
 trait Traits_Classable
 {
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected $classes = array();
 
     public function hasClasses() : bool
@@ -70,30 +70,30 @@ 
         return $this;
     }
     
-   /**
-    * Retrieves a list of all classes, if any.
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves a list of all classes, if any.
+     * 
+     * @return string[]
+     */
     public function getClasses() : array
     {
         return $this->classes;
     }
     
-   /**
-    * Renders the class names list as space-separated string for use in an HTML tag.
-    * 
-    * @return string
-    */
+    /**
+     * Renders the class names list as space-separated string for use in an HTML tag.
+     * 
+     * @return string
+     */
     public function classesToString() : string
     {
         return implode(' ', $this->classes);
     }
     
-   /**
-    * Renders the "class" attribute string for inserting into an HTML tag.
-    * @return string
-    */
+    /**
+     * Renders the "class" attribute string for inserting into an HTML tag.
+     * @return string
+     */
     public function classesToAttribute() : string
     {
         if(!empty($this->classes))

src/JSHelper.php

Indentation +99 added lines, -99 removed lines

@@ -26,48 +26,48 @@ 
  */
 class JSHelper
 {
-   /**
-    * Quote style using single quotes.
-    * @var integer
-    */
+    /**
+     * Quote style using single quotes.
+     * @var integer
+     */
     public const QUOTE_STYLE_SINGLE = 1;
     
-   /**
-    * Quote style using double quotes.
-    * @var integer
-    */
+    /**
+     * Quote style using double quotes.
+     * @var integer
+     */
     public const QUOTE_STYLE_DOUBLE = 2;
 
-   /**
-    * @var array
-    */
+    /**
+     * @var array
+     */
     protected static $variableCache = array();
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     protected static $elementCounter = 0;
 
-   /**
-    * @var string
-    */    
+    /**
+     * @var string
+     */    
     protected static $idPrefix = 'E';
     
-   /**
-    * Builds a javascript statement. The first parameter is the
-    * javascript function to call, any additional parameters are
-    * used as arguments for the javascript function call. Variable
-    * types are automagically converted to the javascript equivalents.
-    *
-    * Examples:
-    *
-    * // add an alert(); statement:
-    * JSHelper::buildStatement('alert');
-    *
-    * // add an alert('Alert text'); statement
-    * JSHelper::buildStatement('alert', 'Alert text');
-    *
-    */
+    /**
+     * Builds a javascript statement. The first parameter is the
+     * javascript function to call, any additional parameters are
+     * used as arguments for the javascript function call. Variable
+     * types are automagically converted to the javascript equivalents.
+     *
+     * Examples:
+     *
+     * // add an alert(); statement:
+     * JSHelper::buildStatement('alert');
+     *
+     * // add an alert('Alert text'); statement
+     * JSHelper::buildStatement('alert', 'Alert text');
+     *
+     */
     public static function buildStatement() : string
     {
         $args = func_get_args();
@@ -75,13 +75,13 @@ 
         return call_user_func_array(array(self::class, 'buildStatementQuoteStyle'), $args);
     }
     
-   /**
-    * Like {@link JSHelper::buildStatement()}, but using single quotes
-    * to make it possible to use the statement in an HTML tag attribute.
-    * 
-    * @return string
-    * @see JSHelper::buildStatement()
-    */
+    /**
+     * Like {@link JSHelper::buildStatement()}, but using single quotes
+     * to make it possible to use the statement in an HTML tag attribute.
+     * 
+     * @return string
+     * @see JSHelper::buildStatement()
+     */
     public static function buildStatementAttribute() : string
     {
         $args = func_get_args();
@@ -111,39 +111,39 @@ 
         return $call . ');';
     }
 
-   /**
-    * Builds a set variable statement. The variable value is
-    * automatically converted to the javascript equivalent.
-    *
-    * Examples:
-    *
-    * // foo = 'bar';
-    * JSHelper::buildVariable('foo', 'bar');
-    *
-    * // foo = 42;
-    * JSHelper::buildVariable('foo', 42);
-    *
-    * // foo = true;
-    * JSHelper::buildVariable('foo', true);
-    *
-    * @param string $varName
-    * @param mixed $varValue
-    * @return string
-    */
+    /**
+     * Builds a set variable statement. The variable value is
+     * automatically converted to the javascript equivalent.
+     *
+     * Examples:
+     *
+     * // foo = 'bar';
+     * JSHelper::buildVariable('foo', 'bar');
+     *
+     * // foo = 42;
+     * JSHelper::buildVariable('foo', 42);
+     *
+     * // foo = true;
+     * JSHelper::buildVariable('foo', true);
+     *
+     * @param string $varName
+     * @param mixed $varValue
+     * @return string
+     */
     public static function buildVariable(string $varName, $varValue) : string
     {
         return $varName . "=" . self::phpVariable2JS($varValue) . ';';
     }
     
-   /**
-    * Converts a PHP variable to its javascript equivalent. Note that
-    * if a variable cannot be converted (like a PHP resource), this will
-    * return a javascript "null".
-    *
-    * @param mixed $variable
-    * @param int $quoteStyle The quote style to use for strings
-    * @return string
-    */
+    /**
+     * Converts a PHP variable to its javascript equivalent. Note that
+     * if a variable cannot be converted (like a PHP resource), this will
+     * return a javascript "null".
+     *
+     * @param mixed $variable
+     * @param int $quoteStyle The quote style to use for strings
+     * @return string
+     */
     public static function phpVariable2JS($variable, int $quoteStyle=self::QUOTE_STYLE_DOUBLE) : string
     {
         // after much profiling, this variant of the method offers
@@ -221,26 +221,26 @@ 
         return $result;
     }
     
-   /**
-    * Converts a variable to a JS string that can be 
-    * used in an HTML attribute: it uses single quotes
-    * instead of the default double quotes.
-    * 
-    * @param mixed $variable
-    * @return string
-    */
+    /**
+     * Converts a variable to a JS string that can be 
+     * used in an HTML attribute: it uses single quotes
+     * instead of the default double quotes.
+     * 
+     * @param mixed $variable
+     * @return string
+     */
     public static function phpVariable2AttributeJS($variable) : string
     {
         return self::phpVariable2JS($variable, self::QUOTE_STYLE_SINGLE);
     }
 
-   /**
-    * Generates a dynamic element ID to be used with dynamically generated
-    * HTML code to tie in with clientside javascript when compact but unique
-    * IDs are needed in a  request.
-    *
-    * @return string
-    */
+    /**
+     * Generates a dynamic element ID to be used with dynamically generated
+     * HTML code to tie in with clientside javascript when compact but unique
+     * IDs are needed in a  request.
+     *
+     * @return string
+     */
     public static function nextElementID() : string
     {
         self::$elementCounter++;
@@ -248,33 +248,33 @@ 
         return self::$idPrefix . self::$elementCounter;
     }
     
-   /**
-    * Retrieves the ID prefix currently used.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the ID prefix currently used.
+     * 
+     * @return string
+     */
     public static function getIDPrefix() : string
     {
         return self::$idPrefix;
     }
     
-   /**
-    * Retrieves the value of the internal elements counter.
-    * 
-    * @return integer
-    */
+    /**
+     * Retrieves the value of the internal elements counter.
+     * 
+     * @return integer
+     */
     public static function getElementCounter() : int
     {
         return self::$elementCounter;
     }
     
-   /**
-    * Sets the prefix that is added in front of all IDs
-    * retrieved using the {@link nextElementID()} method.
-    * 
-    * @param string $prefix
-    * @see JSHelper::nextElementID()
-    */
+    /**
+     * Sets the prefix that is added in front of all IDs
+     * retrieved using the {@link nextElementID()} method.
+     * 
+     * @param string $prefix
+     * @see JSHelper::nextElementID()
+     */
     public static function setIDPrefix(string $prefix)
     {
         self::$idPrefix = $prefix;

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(

src/XMLHelper/HTMLLoader.php

Indentation +66 added lines, -66 removed lines

@@ -36,19 +36,19 @@ 
 {
     public const ERROR_STRING_ALREADY_HAS_BODY_TAG = 57001;
     
-   /**
-    * @var \DOMElement
-    */
+    /**
+     * @var \DOMElement
+     */
     private $bodyNode;
     
-   /**
-    * @var XMLHelper_DOMErrors
-    */
+    /**
+     * @var XMLHelper_DOMErrors
+     */
     private $errors;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private static $htmlTemplate = 
     '<!DOCTYPE html>'.
     '<html>'.
@@ -60,9 +60,9 @@ 
         '</body>'.
     '</html>';
     
-   /**
-    * @var \DOMDocument
-    */
+    /**
+     * @var \DOMDocument
+     */
     private $dom;
 
     private function __construct(string $html)
@@ -70,13 +70,13 @@ 
         $this->load($html);
     }
     
-   /**
-    * Creates an HTML loader from an HTML fragment (without
-    * doctype, head and body elements).
-    * 
-    * @param string $fragment
-    * @return XMLHelper_HTMLLoader
-    */
+    /**
+     * Creates an HTML loader from an HTML fragment (without
+     * doctype, head and body elements).
+     * 
+     * @param string $fragment
+     * @return XMLHelper_HTMLLoader
+     */
     public static function loadFragment(string $fragment) : XMLHelper_HTMLLoader
     {
         self::checkFragment($fragment);
@@ -87,24 +87,24 @@ 
         return new XMLHelper_HTMLLoader($pseudoHTML);
     }
     
-   /**
-    * Creates an HTML loader from a full HTML document (including
-    * doctype, head and body elements).
-    * 
-    * @param string $html
-    * @return XMLHelper_HTMLLoader
-    */
+    /**
+     * Creates an HTML loader from a full HTML document (including
+     * doctype, head and body elements).
+     * 
+     * @param string $html
+     * @return XMLHelper_HTMLLoader
+     */
     public static function loadHTML(string $html) : XMLHelper_HTMLLoader
     {
         return  new XMLHelper_HTMLLoader($html);
     }
 
-   /**
-    * Verifies that the fragment does not already contain a body element or doctype.
-    * 
-    * @param string $fragment
-    * @throws XMLHelper_Exception
-    */
+    /**
+     * Verifies that the fragment does not already contain a body element or doctype.
+     * 
+     * @param string $fragment
+     * @throws XMLHelper_Exception
+     */
     private static function checkFragment(string $fragment) : void
     {
         if(!stristr($fragment, '<body') && !stristr($fragment, 'doctype'))
@@ -142,65 +142,65 @@ 
         return $this->bodyNode;
     }
     
-   /**
-    * Retrieves the document's `<body>` tag node.
-    * 
-    * @return \DOMDocument
-    */
+    /**
+     * Retrieves the document's `<body>` tag node.
+     * 
+     * @return \DOMDocument
+     */
     public function getDOM() : \DOMDocument
     {
         return $this->dom;
     }
     
-   /**
-    * Retrieves all nodes from the HTML fragment (= child nodes
-    * of the `<body>` element).
-    * 
-    * @return \DOMNodeList
-    */
+    /**
+     * Retrieves all nodes from the HTML fragment (= child nodes
+     * of the `<body>` element).
+     * 
+     * @return \DOMNodeList
+     */
     public function getFragmentNodes() : \DOMNodeList
     {
         return $this->bodyNode->childNodes;
     }
     
-   /**
-    * Retrieves the LibXML HTML parsing errors collection, which
-    * can be used to review any errors that occurred while loading
-    * the HTML document.
-    * 
-    * @return XMLHelper_DOMErrors
-    */
+    /**
+     * Retrieves the LibXML HTML parsing errors collection, which
+     * can be used to review any errors that occurred while loading
+     * the HTML document.
+     * 
+     * @return XMLHelper_DOMErrors
+     */
     public function getErrors() : XMLHelper_DOMErrors
     {
         return $this->errors;
     }
     
-   /**
-    * Returns a valid HTML string.
-    * 
-    * @return string
-    */
+    /**
+     * Returns a valid HTML string.
+     * 
+     * @return string
+     */
     public function toHTML() : string
     {
         return $this->dom->saveHTML();
     }
     
-   /**
-    * Returns a valid XML string.
-    * 
-    * @return string
-    */
+    /**
+     * Returns a valid XML string.
+     * 
+     * @return string
+     */
     public function toXML() : string
     {
         return $this->dom->saveXML();
     }
     
-   /**
-    * Converts the HTML fragment to valid XML (= all
-    * child nodes of the `<body>` element).
-    * 
-    * @return string
-    */
+    /**
+     * Converts the HTML fragment to valid XML (= all
+     * child nodes of the `<body>` element).
+     * 
+     * @return string
+     */
     public function fragmentToXML() : string
     {
         $nodes = $this->getFragmentNodes();