Mistralys / application-utils

src/StringBuilder/Interface.php

Indentation +3 added lines, -3 removed lines

@@ -25,17 +25,17 @@
      * 
      * @return string
      */
-     function render() : string;
+        function render() : string;
      
     /**
      * Converts the string builder to a string.
      * 
      * @return string
      */
-     function __toString();
+        function __toString();
      
     /**
      * Renders the string and echos it.
      */
-     function display() : void;
+        function display() : void;
 }

src/RequestHelper.php

Indentation +151 added lines, -151 removed lines

@@ -32,62 +32,62 @@ 
     const ERROR_CURL_INIT_FAILED = 17903;
     const ERROR_CANNOT_OPEN_LOGFILE = 17904;
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $eol = "\r\n";
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $mimeBoundary;
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $destination;
 
-   /**
-    * @var array<string,string>
-    */
+    /**
+     * @var array<string,string>
+     */
     protected $headers = array();
     
-   /**
-    * Whether to verify SSL certificates.
-    * @var bool
-    */
+    /**
+     * Whether to verify SSL certificates.
+     * @var bool
+     */
     protected $verifySSL = true;
     
-   /**
-    * @var RequestHelper_Boundaries
-    */
+    /**
+     * @var RequestHelper_Boundaries
+     */
     protected $boundaries;
     
-   /**
-    * @var RequestHelper_Response|NULL
-    */
+    /**
+     * @var RequestHelper_Response|NULL
+     */
     protected $response;
 
-   /**
-    * Timeout duration, in seconds.
-    * @var integer
-    */
+    /**
+     * Timeout duration, in seconds.
+     * @var integer
+     */
     protected $timeout = 30;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $logfile = '';
 
-   /**
-    * @var resource|NULL
-    */
+    /**
+     * @var resource|NULL
+     */
     protected $logfilePointer = null;
     
-   /**
-    * Creates a new request helper to send POST data to the specified destination URL.
-    * @param string $destinationURL
-    */
+    /**
+     * Creates a new request helper to send POST data to the specified destination URL.
+     * @param string $destinationURL
+     */
     public function __construct(string $destinationURL)
     {
         $this->destination = $destinationURL;
@@ -112,13 +112,13 @@ 
         return $this->eol;
     }
     
-   /**
-    * Sets the timeout for the request, in seconds. If the request
-    * takes longer, it will be cancelled and an exception triggered.
-    * 
-    * @param int $seconds
-    * @return RequestHelper
-    */
+    /**
+     * Sets the timeout for the request, in seconds. If the request
+     * takes longer, it will be cancelled and an exception triggered.
+     * 
+     * @param int $seconds
+     * @return RequestHelper
+     */
     public function setTimeout(int $seconds) : RequestHelper
     {
         $this->timeout = $seconds;
@@ -131,13 +131,13 @@ 
         return $this->timeout;
     }
     
-   /**
-    * Enables verbose logging of the CURL request, which
-    * is then redirected to the target file.
-    * 
-    * @param string $targetFile
-    * @return RequestHelper
-    */
+    /**
+     * Enables verbose logging of the CURL request, which
+     * is then redirected to the target file.
+     * 
+     * @param string $targetFile
+     * @return RequestHelper
+     */
     public function enableLogging(string $targetFile) : RequestHelper
     {
         $this->logfile = $targetFile;
@@ -145,15 +145,15 @@ 
         return $this;
     }
 
-   /**
-    * Adds a file to be sent with the request.
-    *
-    * @param string $varName The variable name to send the file in
-    * @param string $fileName The name of the file as it should be received at the destination
-    * @param string $content The raw content of the file
-    * @param string $contentType The content type, use the constants to specify this
-    * @param string $encoding The encoding of the file, use the constants to specify this
-    */
+    /**
+     * Adds a file to be sent with the request.
+     *
+     * @param string $varName The variable name to send the file in
+     * @param string $fileName The name of the file as it should be received at the destination
+     * @param string $content The raw content of the file
+     * @param string $contentType The content type, use the constants to specify this
+     * @param string $encoding The encoding of the file, use the constants to specify this
+     */
     public function addFile(string $varName, string $fileName, string $content, string $contentType = '', string $encoding = '') : RequestHelper
     {
         $this->boundaries->addFile($varName, $fileName, $content, $contentType, $encoding);
@@ -161,13 +161,13 @@ 
         return $this;
     }
     
-   /**
-    * Adds arbitrary content.
-    * 
-    * @param string $varName The variable name to send the content in.
-    * @param string $content
-    * @param string $contentType
-    */
+    /**
+     * Adds arbitrary content.
+     * 
+     * @param string $varName The variable name to send the content in.
+     * @param string $content
+     * @param string $contentType
+     */
     public function addContent(string $varName, string $content, string $contentType) : RequestHelper
     {
         $this->boundaries->addContent($varName, $content, $contentType);
@@ -175,13 +175,13 @@ 
         return $this;
     }
 
-   /**
-    * Adds a variable to be sent with the request. If it
-    * already exists, its value is overwritten.
-    *
-    * @param string $name
-    * @param string $value
-    */
+    /**
+     * Adds a variable to be sent with the request. If it
+     * already exists, its value is overwritten.
+     *
+     * @param string $name
+     * @param string $value
+     */
     public function addVariable(string $name, string $value) : RequestHelper
     {
         $this->boundaries->addVariable($name, $value);
@@ -189,13 +189,13 @@ 
         return $this;
     }
     
-   /**
-    * Sets an HTTP header to include in the request.
-    * 
-    * @param string $name
-    * @param string $value
-    * @return RequestHelper
-    */
+    /**
+     * Sets an HTTP header to include in the request.
+     * 
+     * @param string $name
+     * @param string $value
+     * @return RequestHelper
+     */
     public function setHeader(string $name, string $value) : RequestHelper
     {
         $this->headers[$name] = $value;
@@ -203,36 +203,36 @@ 
         return $this;
     }
     
-   /**
-    * Disables SSL certificate checking.
-    * 
-    * @return RequestHelper
-    */
+    /**
+     * Disables SSL certificate checking.
+     * 
+     * @return RequestHelper
+     */
     public function disableSSLChecks() : RequestHelper
     {
         $this->verifySSL = false;
         return $this;
     }
    
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     protected $contentLength = 0;
 
-   /**
-    * Sends the POST request to the destination, and returns
-    * the response text.
-    *
-    * The response object is stored internally, so after calling
-    * this method it may be retrieved at any moment using the
-    * {@link getResponse()} method.
-    *
-    * @return string
-    * @see RequestHelper::getResponse()
-    * @throws RequestHelper_Exception
-    * 
-    * @see RequestHelper::ERROR_REQUEST_FAILED
-    */
+    /**
+     * Sends the POST request to the destination, and returns
+     * the response text.
+     *
+     * The response object is stored internally, so after calling
+     * this method it may be retrieved at any moment using the
+     * {@link getResponse()} method.
+     *
+     * @return string
+     * @see RequestHelper::getResponse()
+     * @throws RequestHelper_Exception
+     * 
+     * @see RequestHelper::ERROR_REQUEST_FAILED
+     */
     public function send() : string
     {
         $info = parseURL($this->destination);
@@ -272,26 +272,26 @@ 
         return $this->response->getResponseBody();
     }
     
-   /**
-    * Retrieves the request's body content. This is an alias
-    * for {@see RequestHelper::getMimeBody()}.
-    * 
-    * @return string
-    * @see RequestHelper::getMimeBody()
-    */
+    /**
+     * Retrieves the request's body content. This is an alias
+     * for {@see RequestHelper::getMimeBody()}.
+     * 
+     * @return string
+     * @see RequestHelper::getMimeBody()
+     */
     public function getBody() : string
     {
         return $this->getMimeBody();
     }
     
-   /**
-    * Creates a new CURL resource configured according to the
-    * request's settings.
-    * 
-    * @param URLInfo $url
-    * @throws RequestHelper_Exception
-    * @return resource
-    */
+    /**
+     * Creates a new CURL resource configured according to the
+     * request's settings.
+     * 
+     * @param URLInfo $url
+     * @throws RequestHelper_Exception
+     * @return resource
+     */
     protected function createCURL(URLInfo $url)
     {
         $ch = curl_init();
@@ -339,10 +339,10 @@ 
         return $ch;
     }
     
-   /**
-    * @param resource $ch
-    * @return bool Whether logging is enabled.
-    */
+    /**
+     * @param resource $ch
+     * @return bool Whether logging is enabled.
+     */
     protected function configureLogging($ch) : bool
     {
         if(empty($this->logfile))
@@ -369,13 +369,13 @@ 
         return true;
     }
 
-   /**
-    * Compiles the associative headers array into
-    * the format understood by CURL, namely an indexed
-    * array with one header string per entry.
-    * 
-    * @return array
-    */
+    /**
+     * Compiles the associative headers array into
+     * the format understood by CURL, namely an indexed
+     * array with one header string per entry.
+     * 
+     * @return array
+     */
     protected function renderHeaders() : array
     {
         $result = array();
@@ -389,12 +389,12 @@ 
         return $result;
     }
     
-   /**
-    * Retrieves the raw response header, in the form of an indexed
-    * array containing all response header lines.
-    * 
-    * @return array
-    */
+    /**
+     * Retrieves the raw response header, in the form of an indexed
+     * array containing all response header lines.
+     * 
+     * @return array
+     */
     public function getResponseHeader() : array
     {
         $response = $this->getResponse();
@@ -406,33 +406,33 @@ 
         return array();
     }
 
-   /**
-    * After calling the {@link send()} method, this may be used to
-    * retrieve the response text from the POST request.
-    *
-    * @return RequestHelper_Response|NULL
-    */
+    /**
+     * After calling the {@link send()} method, this may be used to
+     * retrieve the response text from the POST request.
+     *
+     * @return RequestHelper_Response|NULL
+     */
     public function getResponse() : ?RequestHelper_Response
     {
         return $this->response;
     }
     
-   /**
-    * Retrieves all headers set until now.
-    * 
-    * @return array<string,string>
-    */
+    /**
+     * Retrieves all headers set until now.
+     * 
+     * @return array<string,string>
+     */
     public function getHeaders() : array
     {
         return $this->headers;
     }
     
-   /**
-    * Retrieves the value of a header by its name.
-    * 
-    * @param string $name
-    * @return string The header value, or an empty string if not set.
-    */
+    /**
+     * Retrieves the value of a header by its name.
+     * 
+     * @param string $name
+     * @return string The header value, or an empty string if not set.
+     */
     public function getHeader(string $name) : string
     {
         if(isset($this->headers[$name]))

src/XMLHelper.php

Indentation +172 added lines, -172 removed lines

@@ -28,9 +28,9 @@ 
 {
     const ERROR_CANNOT_APPEND_FRAGMENT = 491001; 
 
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     private static $simulation = false;
 
     /**
@@ -38,11 +38,11 @@ 
      */
     private $dom;
     
-   /**
-    * Creates a new XMLHelper instance.
-    * 
-    * @return XMLHelper
-    */
+    /**
+     * Creates a new XMLHelper instance.
+     * 
+     * @return XMLHelper
+     */
     public static function create() : XMLHelper
     {
         $dom = new DOMDocument('1.0', 'UTF-8');
@@ -51,72 +51,72 @@ 
         return new XMLHelper($dom);
     }
     
-   /**
-    * Creates a converter instance from an XML file.
-    * @param string $xmlFile
-    * @return XMLHelper_Converter
-    */
+    /**
+     * Creates a converter instance from an XML file.
+     * @param string $xmlFile
+     * @return XMLHelper_Converter
+     */
     public static function convertFile(string $xmlFile) : XMLHelper_Converter
     {
         return XMLHelper_Converter::fromFile($xmlFile);
     }
     
-   /**
-    * Creates a converter from an XML string.
-    * @param string $xmlString
-    * @return XMLHelper_Converter
-    */
+    /**
+     * Creates a converter from an XML string.
+     * @param string $xmlString
+     * @return XMLHelper_Converter
+     */
     public static function convertString(string $xmlString) : XMLHelper_Converter
     {
         return XMLHelper_Converter::fromString($xmlString);
     }
 
-   /**
-    * Creates a converter from a SimpleXMLElement instance.
-    * @param SimpleXMLElement $element
-    * @return XMLHelper_Converter
-    */
+    /**
+     * Creates a converter from a SimpleXMLElement instance.
+     * @param SimpleXMLElement $element
+     * @return XMLHelper_Converter
+     */
     public static function convertElement(SimpleXMLElement $element) : XMLHelper_Converter
     {
         return XMLHelper_Converter::fromElement($element);
     }
    
-   /**
-    * Creates a converter from a DOMElement instance.
-    * @param DOMElement $element
-    * @return XMLHelper_Converter
-    */
+    /**
+     * Creates a converter from a DOMElement instance.
+     * @param DOMElement $element
+     * @return XMLHelper_Converter
+     */
     public static function convertDOMElement(DOMElement $element) : XMLHelper_Converter
     {
         return XMLHelper_Converter::fromDOMElement($element);
     }
 
-   /**
-    * Creates a new helper using an existing DOMDocument object.
-    * @param DOMDocument $dom
-    */
+    /**
+     * Creates a new helper using an existing DOMDocument object.
+     * @param DOMDocument $dom
+     */
     public function __construct(DOMDocument $dom)
     {
         $this->dom = $dom;
     }
 
-   /**
-    * @return DOMDocument
-    */
+    /**
+     * @return DOMDocument
+     */
     public function getDOM() : DOMDocument
     {
         return $this->dom;
     }
 
-   /**
-    * Adds an attribute to an existing tag with
-    * the specified value.
-    *
-    * @param DOMNode $parent
-    * @param string $name
-    * @param mixed $value
-    * @return DOMNode
-    */
+    /**
+     * Adds an attribute to an existing tag with
+     * the specified value.
+     *
+     * @param DOMNode $parent
+     * @param string $name
+     * @param mixed $value
+     * @return DOMNode
+     */
     public function addAttribute(DOMNode $parent, string $name, $value)
     {
         $node = $this->dom->createAttribute($name);
@@ -126,12 +126,12 @@ 
         return $parent->appendChild($node);
     }
 
-   /**
-    * Adds several attributes to the target node.
-    * 
-    * @param DOMNode $parent
-    * @param array<string,mixed> $attributes
-    */
+    /**
+     * Adds several attributes to the target node.
+     * 
+     * @param DOMNode $parent
+     * @param array<string,mixed> $attributes
+     */
     public function addAttributes(DOMNode $parent, array $attributes) : void
     {
         foreach ($attributes as $name => $value) {
@@ -139,14 +139,14 @@ 
         }
     }
 
-   /**
-    * Adds a tag without content.
-    *
-    * @param DOMNode $parent
-    * @param string $name
-    * @param integer $indent
-    * @return DOMNode
-    */
+    /**
+     * Adds a tag without content.
+     *
+     * @param DOMNode $parent
+     * @param string $name
+     * @param integer $indent
+     * @return DOMNode
+     */
     public function addTag(DOMNode $parent, string $name, int $indent = 0) : DOMNode
     {
         if ($indent > 0) {
@@ -168,17 +168,17 @@ 
         $parent->appendChild($this->dom->createTextNode(str_repeat("\t", $amount)));
     }
 
-   /**
-    * Adds a tag with textual content, like:
-    *
-    * <tagname>text</tagname>
-    *
-    * @param DOMNode $parent
-    * @param string $name
-    * @param string $text
-    * @param integer $indent
-    * @return DOMNode
-    */
+    /**
+     * Adds a tag with textual content, like:
+     *
+     * <tagname>text</tagname>
+     *
+     * @param DOMNode $parent
+     * @param string $name
+     * @param string $text
+     * @param integer $indent
+     * @return DOMNode
+     */
     public function addTextTag(DOMNode $parent, string $name, string $text, int $indent = 0) : DOMNode
     {
         if ($indent > 0) {
@@ -192,19 +192,19 @@ 
         return $parent->appendChild($tag);
     }
 
-   /**
-    * Adds a tag with textual content, like:
-    *
-    * <tagname>text</tagname>
-    *
-    * and removes <p> tags
-    *
-    * @param DOMNode $parent
-    * @param string $name
-    * @param string $text
-    * @param integer $indent
-    * @return DOMNode
-    */
+    /**
+     * Adds a tag with textual content, like:
+     *
+     * <tagname>text</tagname>
+     *
+     * and removes <p> tags
+     *
+     * @param DOMNode $parent
+     * @param string $name
+     * @param string $text
+     * @param integer $indent
+     * @return DOMNode
+     */
     public function addEscapedTag(DOMNode $parent, string $name, string $text, int $indent = 0)
     {
         if ($indent > 0) {
@@ -220,19 +220,19 @@ 
         return $parent->appendChild($tag);
     }
 
-   /**
-    * Adds a tag with HTML content, like:
-    *
-    * <tagname><i>text</i></tagname>
-    *
-    * Tags will not be escaped.
-    *
-    * @param DOMNode $parent
-    * @param string $name
-    * @param string $text
-    * @param integer $indent
-    * @return DOMNode
-    */
+    /**
+     * Adds a tag with HTML content, like:
+     *
+     * <tagname><i>text</i></tagname>
+     *
+     * Tags will not be escaped.
+     *
+     * @param DOMNode $parent
+     * @param string $name
+     * @param string $text
+     * @param integer $indent
+     * @return DOMNode
+     */
     public function addFragmentTag(DOMNode $parent, string $name, string $text, int $indent = 0)
     {
         if ($indent > 0) {
@@ -260,16 +260,16 @@ 
         return $parent->appendChild($tag);
     }
 
-   /**
-    * Adds a tag with CDATA content, like:
-    *
-    * <tagname><![CDATA[value]]></tagname>
-    *
-    * @param DOMNode $parent
-    * @param string $name
-    * @param string $content
-    * @return DOMNode
-    */
+    /**
+     * Adds a tag with CDATA content, like:
+     *
+     * <tagname><![CDATA[value]]></tagname>
+     *
+     * @param DOMNode $parent
+     * @param string $name
+     * @param string $content
+     * @return DOMNode
+     */
     public function addCDATATag(DOMNode $parent, string $name, string $content) : DOMNode
     {
         $tag = $this->dom->createElement($name);
@@ -279,12 +279,12 @@ 
         return $parent->appendChild($tag);
     }
 
-   /**
-    * Creates the root element of the document.
-    * @param string $name
-    * @param array<string,mixed> $attributes
-    * @return DOMNode
-    */
+    /**
+     * Creates the root element of the document.
+     * @param string $name
+     * @param array<string,mixed> $attributes
+     * @return DOMNode
+     */
     public function createRoot(string $name, array $attributes=array())
     {
         $root = $this->dom->appendChild($this->dom->createElement($name));
@@ -292,12 +292,12 @@ 
         return $root;
     }
 
-   /**
-    * Escaped the string for use in XML.
-    * 
-    * @param string $string
-    * @return string
-    */
+    /**
+     * Escaped the string for use in XML.
+     * 
+     * @param string $string
+     * @return string
+     */
     public function escape(string $string) : string
     {
         $string = preg_replace('#<p>(.*)</p>#isUm', '$1', $string);
@@ -317,18 +317,18 @@ 
         return $string;
     }
 
-   /**
-    * Sends the specified XML string to the browser with
-    * the correct headers to trigger a download of the XML
-    * to a local file.
-    * 
-    * NOTE: Ensure calling exit after this is done, and to
-    * not send additional content, which would corrupt the 
-    * download.
-    *
-    * @param string $xml
-    * @param string $filename
-    */
+    /**
+     * Sends the specified XML string to the browser with
+     * the correct headers to trigger a download of the XML
+     * to a local file.
+     * 
+     * NOTE: Ensure calling exit after this is done, and to
+     * not send additional content, which would corrupt the 
+     * download.
+     *
+     * @param string $xml
+     * @param string $filename
+     */
     public static function downloadXML(string $xml, string $filename = 'download.xml') : void
     {
         if(!headers_sent() && !self::$simulation) 
@@ -339,12 +339,12 @@ 
         echo $xml;
     }
 
-   /**
-    * Sends the specified XML string to the browser with
-    * the correct headers and terminates the request.
-    *
-    * @param string $xml
-    */
+    /**
+     * Sends the specified XML string to the browser with
+     * the correct headers and terminates the request.
+     *
+     * @param string $xml
+     */
     public static function displayXML(string $xml) : void
     {
         if(!headers_sent() && !self::$simulation) 
@@ -411,23 +411,23 @@ 
         return $xml->saveXML();
     }
 
-   /**
-    * Creates XML markup to describe an application error
-    * when using XML services. Creates XML with the
-    * following structure:
-    *
-    * <error>
-    *     <id>99</id>
-    *     <message>Full error message text</message>
-    *     <title>Short error label</title>
-    * </error>
-    *
-    * @param string|number $code
-    * @param string $message
-    * @param string $title
-    * @param array<string,string> $customInfo
-    * @return string
-    */
+    /**
+     * Creates XML markup to describe an application error
+     * when using XML services. Creates XML with the
+     * following structure:
+     *
+     * <error>
+     *     <id>99</id>
+     *     <message>Full error message text</message>
+     *     <title>Short error label</title>
+     * </error>
+     *
+     * @param string|number $code
+     * @param string $message
+     * @param string $title
+     * @param array<string,string> $customInfo
+     * @return string
+     */
     public static function buildErrorXML($code, string $message, string $title, array $customInfo=array())
     {
         $xml = new DOMDocument('1.0', 'UTF-8');
@@ -460,31 +460,31 @@ 
         return $this->dom->saveXML();
     }
     
-   /**
-    * Creates a new SimpleXML helper instance: this
-    * object is useful to work with loading XML strings
-    * and files with easy access to any errors that 
-    * may occurr, since the simplexml functions can be
-    * somewhat cryptic.
-    * 
-    * @return XMLHelper_SimpleXML
-    */
+    /**
+     * Creates a new SimpleXML helper instance: this
+     * object is useful to work with loading XML strings
+     * and files with easy access to any errors that 
+     * may occurr, since the simplexml functions can be
+     * somewhat cryptic.
+     * 
+     * @return XMLHelper_SimpleXML
+     */
     public static function createSimplexml() : XMLHelper_SimpleXML
     {
         return new XMLHelper_SimpleXML();
     }
     
-   /**
-    * Converts a string to valid XML: can be a text only string
-    * or an HTML string. Returns valid XML code.
-    * 
-    * NOTE: The string may contain custom tags, which are 
-    * preserved.
-    * 
-    * @param string $string
-    * @throws XMLHelper_Exception
-    * @return string
-    */
+    /**
+     * Converts a string to valid XML: can be a text only string
+     * or an HTML string. Returns valid XML code.
+     * 
+     * NOTE: The string may contain custom tags, which are 
+     * preserved.
+     * 
+     * @param string $string
+     * @throws XMLHelper_Exception
+     * @return string
+     */
     public static function string2xml(string $string) : string
     {
         return XMLHelper_HTMLLoader::loadFragment($string)->fragmentToXML();

src/Highlighter.php

Indentation +70 added lines, -70 removed lines

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

src/ConvertHelper/TimeConverter.php

Indentation +17 added lines, -17 removed lines

@@ -23,19 +23,19 @@ 
  */
 class ConvertHelper_TimeConverter
 {
-   /**
-    * @var float
-    */
+    /**
+     * @var float
+     */
     private $seconds;
 
-   /**
-    * @var array<int,array<string,string|int>>
-    */
+    /**
+     * @var array<int,array<string,string|int>>
+     */
     private static $units;
     
-   /**
-    * @param float $seconds
-    */
+    /**
+     * @param float $seconds
+     */
     public function __construct($seconds)
     {
         $this->seconds = $seconds;   
@@ -43,9 +43,9 @@ 
         $this->initUnits();
     }
     
-   /**
-    * Creates the list of units once per request as needed.
-    */
+    /**
+     * Creates the list of units once per request as needed.
+     */
     private function initUnits() : void
     {
         if(isset(self::$units))
@@ -112,11 +112,11 @@ 
         return implode(', ', $tokens) . ' ' . t('and') . ' ' . $last;
     }
     
-   /**
-    * Resolves the list of converted units.
-    * 
-    * @return string[]
-    */
+    /**
+     * Resolves the list of converted units.
+     * 
+     * @return string[]
+     */
     private function resolveTokens() : array
     {
         $seconds = $this->seconds;

src/FileHelper.php

Indentation +414 added lines, -414 removed lines

@@ -52,32 +52,32 @@ 
     const ERROR_PATH_IS_NOT_A_FOLDER = 340034;
     const ERROR_CANNOT_WRITE_TO_FOLDER = 340035;
     
-   /**
-    * Opens a serialized file and returns the unserialized data.
-    * 
-    * @param string $file
-    * @throws FileHelper_Exception
-    * @return array
-    * @deprecated Use parseSerializedFile() instead.
-    * @see FileHelper::parseSerializedFile()
-    */
+    /**
+     * Opens a serialized file and returns the unserialized data.
+     * 
+     * @param string $file
+     * @throws FileHelper_Exception
+     * @return array
+     * @deprecated Use parseSerializedFile() instead.
+     * @see FileHelper::parseSerializedFile()
+     */
     public static function openUnserialized(string $file) : array
     {
         return self::parseSerializedFile($file);
     }
 
-   /**
-    * Opens a serialized file and returns the unserialized data.
-    *
-    * @param string $file
-    * @throws FileHelper_Exception
-    * @return array
-    * @see FileHelper::parseSerializedFile()
-    * 
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
-    * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ
-    * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED
-    */
+    /**
+     * Opens a serialized file and returns the unserialized data.
+     *
+     * @param string $file
+     * @throws FileHelper_Exception
+     * @return array
+     * @see FileHelper::parseSerializedFile()
+     * 
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
+     * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ
+     * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED
+     */
     public static function parseSerializedFile(string $file)
     {
         self::requireFileExists($file);
@@ -146,13 +146,13 @@ 
         return rmdir($rootFolder);
     }
     
-   /**
-    * Create a folder, if it does not exist yet.
-    *  
-    * @param string $path
-    * @throws FileHelper_Exception
-    * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
-    */
+    /**
+     * Create a folder, if it does not exist yet.
+     *  
+     * @param string $path
+     * @throws FileHelper_Exception
+     * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
+     */
     public static function createFolder($path)
     {
         if(is_dir($path) || mkdir($path, 0777, true)) {
@@ -199,22 +199,22 @@ 
         }
     }
     
-   /**
-    * Copies a file to the target location. Includes checks
-    * for most error sources, like the source file not being
-    * readable. Automatically creates the target folder if it
-    * does not exist yet.
-    * 
-    * @param string $sourcePath
-    * @param string $targetPath
-    * @throws FileHelper_Exception
-    * 
-    * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
-    * @see FileHelper::ERROR_SOURCE_FILE_NOT_FOUND
-    * @see FileHelper::ERROR_SOURCE_FILE_NOT_READABLE
-    * @see FileHelper::ERROR_TARGET_COPY_FOLDER_NOT_WRITABLE
-    * @see FileHelper::ERROR_CANNOT_COPY_FILE
-    */
+    /**
+     * Copies a file to the target location. Includes checks
+     * for most error sources, like the source file not being
+     * readable. Automatically creates the target folder if it
+     * does not exist yet.
+     * 
+     * @param string $sourcePath
+     * @param string $targetPath
+     * @throws FileHelper_Exception
+     * 
+     * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
+     * @see FileHelper::ERROR_SOURCE_FILE_NOT_FOUND
+     * @see FileHelper::ERROR_SOURCE_FILE_NOT_READABLE
+     * @see FileHelper::ERROR_TARGET_COPY_FOLDER_NOT_WRITABLE
+     * @see FileHelper::ERROR_CANNOT_COPY_FILE
+     */
     public static function copyFile(string $sourcePath, string $targetPath) : void
     {
         self::requireFileExists($sourcePath, self::ERROR_SOURCE_FILE_NOT_FOUND);
@@ -254,15 +254,15 @@ 
         );
     }
     
-   /**
-    * Deletes the target file. Ignored if it cannot be found,
-    * and throws an exception if it fails.
-    * 
-    * @param string $filePath
-    * @throws FileHelper_Exception
-    * 
-    * @see FileHelper::ERROR_CANNOT_DELETE_FILE
-    */
+    /**
+     * Deletes the target file. Ignored if it cannot be found,
+     * and throws an exception if it fails.
+     * 
+     * @param string $filePath
+     * @throws FileHelper_Exception
+     * 
+     * @see FileHelper::ERROR_CANNOT_DELETE_FILE
+     */
     public static function deleteFile(string $filePath) : void
     {
         if(!file_exists($filePath)) {
@@ -284,15 +284,15 @@ 
     }
 
     /**
-    * Creates a new CSV parser instance and returns it.
-    * 
-    * @param string $delimiter
-    * @param string $enclosure
-    * @param string $escape
-    * @param bool $heading
-    * @return Csv
+     * Creates a new CSV parser instance and returns it.
+     * 
+     * @param string $delimiter
+     * @param string $enclosure
+     * @param string $escape
+     * @param bool $heading
+     * @return Csv
      * @see CSVHelper::createParser()
-    */
+     */
     public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : Csv
     {
         if($delimiter==='') { $delimiter = ';'; }
@@ -305,21 +305,21 @@ 
         return $parser;
     }
 
-   /**
-    * Parses all lines in the specified string and returns an
-    * indexed array with all csv values in each line.
-    *
-    * @param string $csv
-    * @param string $delimiter
-    * @param string $enclosure
-    * @param string $escape
-    * @param bool $heading
-    * @return array
-    * @throws FileHelper_Exception
-    * 
-    * @see parseCSVFile()
-    * @see FileHelper::ERROR_PARSING_CSV
-    */
+    /**
+     * Parses all lines in the specified string and returns an
+     * indexed array with all csv values in each line.
+     *
+     * @param string $csv
+     * @param string $delimiter
+     * @param string $enclosure
+     * @param string $escape
+     * @param bool $heading
+     * @return array
+     * @throws FileHelper_Exception
+     * 
+     * @see parseCSVFile()
+     * @see FileHelper::ERROR_PARSING_CSV
+     */
     public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array
     {
         $parser = self::createCSVParser($delimiter, $enclosure, '\\', $heading);
@@ -490,31 +490,31 @@ 
         );
     }
     
-   /**
-    * Verifies whether the target file is a PHP file. The path
-    * to the file can be a path to a file as a string, or a 
-    * DirectoryIterator object instance.
-    * 
-    * @param string|\DirectoryIterator $pathOrDirIterator
-    * @return boolean
-    */
+    /**
+     * Verifies whether the target file is a PHP file. The path
+     * to the file can be a path to a file as a string, or a 
+     * DirectoryIterator object instance.
+     * 
+     * @param string|\DirectoryIterator $pathOrDirIterator
+     * @return boolean
+     */
     public static function isPHPFile($pathOrDirIterator)
     {
-    	if(self::getExtension($pathOrDirIterator) == 'php') {
-    		return true;
-    	}
+        if(self::getExtension($pathOrDirIterator) == 'php') {
+            return true;
+        }
     	
-    	return false;
+        return false;
     }
     
-   /**
-    * Retrieves the extension of the specified file. Can be a path
-    * to a file as a string, or a DirectoryIterator object instance.
-    * 
-    * @param string|\DirectoryIterator $pathOrDirIterator
-    * @param bool $lowercase
-    * @return string
-    */
+    /**
+     * Retrieves the extension of the specified file. Can be a path
+     * to a file as a string, or a DirectoryIterator object instance.
+     * 
+     * @param string|\DirectoryIterator $pathOrDirIterator
+     * @param bool $lowercase
+     * @return string
+     */
     public static function getExtension($pathOrDirIterator, bool $lowercase = true) : string
     {
         if($pathOrDirIterator instanceof \DirectoryIterator) {
@@ -525,51 +525,51 @@ 
          
         $ext = pathinfo($filename, PATHINFO_EXTENSION);
         if($lowercase) {
-        	$ext = mb_strtolower($ext);
+            $ext = mb_strtolower($ext);
         }
         
         return $ext;
     }
     
-   /**
-    * Retrieves the file name from a path, with or without extension.
-    * The path to the file can be a string, or a DirectoryIterator object
-    * instance.
-    * 
-    * In case of folders, behaves like the pathinfo function: returns
-    * the name of the folder.
-    * 
-    * @param string|\DirectoryIterator $pathOrDirIterator
-    * @param bool $extension
-    * @return string
-    */
+    /**
+     * Retrieves the file name from a path, with or without extension.
+     * The path to the file can be a string, or a DirectoryIterator object
+     * instance.
+     * 
+     * In case of folders, behaves like the pathinfo function: returns
+     * the name of the folder.
+     * 
+     * @param string|\DirectoryIterator $pathOrDirIterator
+     * @param bool $extension
+     * @return string
+     */
     public static function getFilename($pathOrDirIterator, $extension = true)
     {
         $path = $pathOrDirIterator;
-    	if($pathOrDirIterator instanceof \DirectoryIterator) {
-    		$path = $pathOrDirIterator->getFilename();
-    	}
+        if($pathOrDirIterator instanceof \DirectoryIterator) {
+            $path = $pathOrDirIterator->getFilename();
+        }
     	
-    	$path = self::normalizePath($path);
+        $path = self::normalizePath($path);
     	
-    	if(!$extension) {
-    	    return pathinfo($path, PATHINFO_FILENAME);
-    	}
+        if(!$extension) {
+            return pathinfo($path, PATHINFO_FILENAME);
+        }
     	
-    	return pathinfo($path, PATHINFO_BASENAME); 
+        return pathinfo($path, PATHINFO_BASENAME); 
     }
    
-   /**
-    * Tries to read the contents of the target file and
-    * treat it as JSON to return the decoded JSON data.
-    * 
-    * @param string $file
-    * @throws FileHelper_Exception
-    * @return array
-    * 
-    * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE
-    * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE
-    */ 
+    /**
+     * Tries to read the contents of the target file and
+     * treat it as JSON to return the decoded JSON data.
+     * 
+     * @param string $file
+     * @throws FileHelper_Exception
+     * @return array
+     * 
+     * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE
+     * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE
+     */ 
     public static function parseJSONFile(string $file, $targetEncoding=null, $sourceEncoding=null)
     {
         self::requireFileExists($file, self::ERROR_CANNOT_FIND_JSON_FILE);
@@ -605,16 +605,16 @@ 
         return $json;
     }
     
-   /**
-    * Corrects common formatting mistakes when users enter
-    * file names, like too many spaces, dots and the like.
-    * 
-    * NOTE: if the file name contains a path, the path is
-    * stripped, leaving only the file name.
-    * 
-    * @param string $name
-    * @return string
-    */
+    /**
+     * Corrects common formatting mistakes when users enter
+     * file names, like too many spaces, dots and the like.
+     * 
+     * NOTE: if the file name contains a path, the path is
+     * stripped, leaving only the file name.
+     * 
+     * @param string $name
+     * @return string
+     */
     public static function fixFileName(string $name) : string
     {
         $name = trim($name);
@@ -644,68 +644,68 @@ 
         return $name;
     }
     
-   /**
-    * Creates an instance of the file finder, which is an easier
-    * alternative to the other manual findFile methods, since all
-    * options can be set by chaining.
-    * 
-    * @param string $path
-    * @return FileHelper_FileFinder
-    */
+    /**
+     * Creates an instance of the file finder, which is an easier
+     * alternative to the other manual findFile methods, since all
+     * options can be set by chaining.
+     * 
+     * @param string $path
+     * @return FileHelper_FileFinder
+     */
     public static function createFileFinder(string $path) : FileHelper_FileFinder
     {
         return new FileHelper_FileFinder($path);
     }
     
-   /**
-    * Searches for all HTML files in the target folder.
-    * 
-    * NOTE: This method only exists for backwards compatibility.
-    * Use the `createFileFinder()` method instead, which offers
-    * an object oriented interface that is much easier to use.
-    * 
-    * @param string $targetFolder
-    * @param array $options
-    * @return array An indexed array with files.
-    * @see FileHelper::createFileFinder()
-    */
+    /**
+     * Searches for all HTML files in the target folder.
+     * 
+     * NOTE: This method only exists for backwards compatibility.
+     * Use the `createFileFinder()` method instead, which offers
+     * an object oriented interface that is much easier to use.
+     * 
+     * @param string $targetFolder
+     * @param array $options
+     * @return array An indexed array with files.
+     * @see FileHelper::createFileFinder()
+     */
     public static function findHTMLFiles(string $targetFolder, array $options=array()) : array
     {
         return self::findFiles($targetFolder, array('html'), $options);
     }
 
-   /**
-    * Searches for all PHP files in the target folder.
-    * 
-    * NOTE: This method only exists for backwards compatibility.
-    * Use the `createFileFinder()` method instead, which offers
-    * an object oriented interface that is much easier to use.
-    * 
-    * @param string $targetFolder
-    * @param array $options
-    * @return array An indexed array of PHP files.
-    * @see FileHelper::createFileFinder()
-    */
+    /**
+     * Searches for all PHP files in the target folder.
+     * 
+     * NOTE: This method only exists for backwards compatibility.
+     * Use the `createFileFinder()` method instead, which offers
+     * an object oriented interface that is much easier to use.
+     * 
+     * @param string $targetFolder
+     * @param array $options
+     * @return array An indexed array of PHP files.
+     * @see FileHelper::createFileFinder()
+     */
     public static function findPHPFiles(string $targetFolder, array $options=array()) : array
     {
         return self::findFiles($targetFolder, array('php'), $options);
     }
     
-   /**
-    * Finds files according to the specified options.
-    * 
-    * NOTE: This method only exists for backwards compatibility.
-    * Use the `createFileFinder()` method instead, which offers
-    * an object oriented interface that is much easier to use.
-    *  
-    * @param string $targetFolder
-    * @param array $extensions
-    * @param array $options
-    * @param array $files
-    * @throws FileHelper_Exception
-    * @return array
-    * @see FileHelper::createFileFinder()
-    */
+    /**
+     * Finds files according to the specified options.
+     * 
+     * NOTE: This method only exists for backwards compatibility.
+     * Use the `createFileFinder()` method instead, which offers
+     * an object oriented interface that is much easier to use.
+     *  
+     * @param string $targetFolder
+     * @param array $extensions
+     * @param array $options
+     * @param array $files
+     * @throws FileHelper_Exception
+     * @return array
+     * @see FileHelper::createFileFinder()
+     */
     public static function findFiles(string $targetFolder, array $extensions=array(), array $options=array(), array $files=array()) : array
     {
         $finder = self::createFileFinder($targetFolder);
@@ -731,14 +731,14 @@ 
         return $finder->getAll();
     }
 
-   /**
-    * Removes the extension from the specified path or file name,
-    * if any, and returns the name without the extension.
-    * 
-    * @param string $filename
-    * @param bool $keepPath Whether to keep the path component, if any. Default PHP pathinfo behavior is not to.
-    * @return string
-    */
+    /**
+     * Removes the extension from the specified path or file name,
+     * if any, and returns the name without the extension.
+     * 
+     * @param string $filename
+     * @param bool $keepPath Whether to keep the path component, if any. Default PHP pathinfo behavior is not to.
+     * @return string
+     */
     public static function removeExtension(string $filename, bool $keepPath=false) : string
     {
         // normalize paths to allow windows style slashes even on nix servers
@@ -758,22 +758,22 @@ 
         return implode('/', $parts);
     }
     
-   /**
-    * Detects the UTF BOM in the target file, if any. Returns
-    * the encoding matching the BOM, which can be any of the
-    * following:
-    * 
-    * <ul>
-    * <li>UTF32-BE</li>
-    * <li>UTF32-LE</li>
-    * <li>UTF16-BE</li>
-    * <li>UTF16-LE</li>
-    * <li>UTF8</li>
-    * </ul>
-    * 
-    * @param string $filename
-    * @return string|NULL
-    */
+    /**
+     * Detects the UTF BOM in the target file, if any. Returns
+     * the encoding matching the BOM, which can be any of the
+     * following:
+     * 
+     * <ul>
+     * <li>UTF32-BE</li>
+     * <li>UTF32-LE</li>
+     * <li>UTF16-BE</li>
+     * <li>UTF16-LE</li>
+     * <li>UTF8</li>
+     * </ul>
+     * 
+     * @param string $filename
+     * @return string|NULL
+     */
     public static function detectUTFBom(string $filename) : ?string
     {
         $fp = fopen($filename, 'r');
@@ -805,13 +805,13 @@ 
     
     protected static $utfBoms;
     
-   /**
-    * Retrieves a list of all UTF byte order mark character
-    * sequences, as an assocative array with UTF encoding => bom sequence
-    * pairs.
-    * 
-    * @return array
-    */
+    /**
+     * Retrieves a list of all UTF byte order mark character
+     * sequences, as an assocative array with UTF encoding => bom sequence
+     * pairs.
+     * 
+     * @return array
+     */
     public static function getUTFBOMs()
     {
         if(!isset(self::$utfBoms)) {
@@ -827,15 +827,15 @@ 
         return self::$utfBoms;
     }
     
-   /**
-    * Checks whether the specified encoding is a valid
-    * unicode encoding, for example "UTF16-LE" or "UTF8".
-    * Also accounts for alternate way to write the, like
-    * "UTF-8", and omitting little/big endian suffixes.
-    * 
-    * @param string $encoding
-    * @return boolean
-    */
+    /**
+     * Checks whether the specified encoding is a valid
+     * unicode encoding, for example "UTF16-LE" or "UTF8".
+     * Also accounts for alternate way to write the, like
+     * "UTF-8", and omitting little/big endian suffixes.
+     * 
+     * @param string $encoding
+     * @return boolean
+     */
     public static function isValidUnicodeEncoding(string $encoding) : bool
     {
         $encodings = self::getKnownUnicodeEncodings();
@@ -854,40 +854,40 @@ 
         return in_array($encoding, $keep);
     }
     
-   /**
-    * Retrieves a list of all known unicode file encodings.
-    * @return array
-    */
+    /**
+     * Retrieves a list of all known unicode file encodings.
+     * @return array
+     */
     public static function getKnownUnicodeEncodings()
     {
         return array_keys(self::getUTFBOMs());
     }
     
-   /**
-    * Normalizes the slash style in a file or folder path,
-    * by replacing any antislashes with forward slashes.
-    * 
-    * @param string $path
-    * @return string
-    */
+    /**
+     * Normalizes the slash style in a file or folder path,
+     * by replacing any antislashes with forward slashes.
+     * 
+     * @param string $path
+     * @return string
+     */
     public static function normalizePath(string $path) : string
     {
         return str_replace(array('\\', '//'), array('/', '/'), $path);
     }
     
-   /**
-    * Saves the specified data to a file, JSON encoded.
-    * 
-    * @param mixed $data
-    * @param string $file
-    * @param bool $pretty
-    * @throws FileHelper_Exception
-    * 
-    * @see FileHelper::ERROR_JSON_ENCODE_ERROR
-    * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE
-    * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
-    * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
-    */
+    /**
+     * Saves the specified data to a file, JSON encoded.
+     * 
+     * @param mixed $data
+     * @param string $file
+     * @param bool $pretty
+     * @throws FileHelper_Exception
+     * 
+     * @see FileHelper::ERROR_JSON_ENCODE_ERROR
+     * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE
+     * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
+     * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
+     */
     public static function saveAsJSON($data, string $file, bool $pretty=false)
     {
         $options = null;
@@ -911,18 +911,18 @@ 
         self::saveFile($file, $json);
     }
    
-   /**
-    * Saves the specified content to the target file, creating
-    * the file and the folder as necessary.
-    * 
-    * @param string $filePath
-    * @param string $content
-    * @throws FileHelper_Exception
-    * 
-    * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE
-    * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
-    * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
-    */
+    /**
+     * Saves the specified content to the target file, creating
+     * the file and the folder as necessary.
+     * 
+     * @param string $filePath
+     * @param string $content
+     * @throws FileHelper_Exception
+     * 
+     * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE
+     * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
+     * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
+     */
     public static function saveFile(string $filePath, string $content='') : void
     {
         $filePath = self::normalizePath($filePath);
@@ -1072,16 +1072,16 @@ 
         return $result;
     }
     
-   /**
-    * Validates a PHP file's syntax.
-    * 
-    * NOTE: This will fail silently if the PHP command line
-    * is not available. Use {@link FileHelper::canMakePHPCalls()}
-    * to check this beforehand as needed.
-    * 
-    * @param string $path
-    * @return boolean|array A boolean true if the file is valid, an array with validation messages otherwise.
-    */
+    /**
+     * Validates a PHP file's syntax.
+     * 
+     * NOTE: This will fail silently if the PHP command line
+     * is not available. Use {@link FileHelper::canMakePHPCalls()}
+     * to check this beforehand as needed.
+     * 
+     * @param string $path
+     * @return boolean|array A boolean true if the file is valid, an array with validation messages otherwise.
+     */
     public static function checkPHPFileSyntax($path)
     {
         if(!self::canMakePHPCalls()) {
@@ -1105,14 +1105,14 @@ 
         return $output;
     }
     
-   /**
-    * Retrieves the last modified date for the specified file or folder.
-    * 
-    * Note: If the target does not exist, returns null. 
-    * 
-    * @param string $path
-    * @return \DateTime|NULL
-    */
+    /**
+     * Retrieves the last modified date for the specified file or folder.
+     * 
+     * Note: If the target does not exist, returns null. 
+     * 
+     * @param string $path
+     * @return \DateTime|NULL
+     */
     public static function getModifiedDate($path)
     {
         $time = filemtime($path);
@@ -1125,24 +1125,24 @@ 
         return null; 
     }
     
-   /**
-    * Retrieves the names of all subfolders in the specified path.
-    * 
-    * Available options:
-    * 
-    * - recursive: true/false
-    *   Whether to search for subfolders recursively. 
-    *   
-    * - absolute-paths: true/false
-    *   Whether to return a list of absolute paths.
-    * 
-    * @param string $targetFolder
-    * @param array $options
-    * @throws FileHelper_Exception
-    * @return string[]
-    * 
-    * @todo Move this to a separate class.
-    */
+    /**
+     * Retrieves the names of all subfolders in the specified path.
+     * 
+     * Available options:
+     * 
+     * - recursive: true/false
+     *   Whether to search for subfolders recursively. 
+     *   
+     * - absolute-paths: true/false
+     *   Whether to return a list of absolute paths.
+     * 
+     * @param string $targetFolder
+     * @param array $options
+     * @throws FileHelper_Exception
+     * @return string[]
+     * 
+     * @todo Move this to a separate class.
+     */
     public static function getSubfolders($targetFolder, $options = array())
     {
         if(!is_dir($targetFolder)) 
@@ -1203,16 +1203,16 @@ 
         return $result;
     }
 
-   /**
-    * Retrieves the maximum allowed upload file size, in bytes.
-    * Takes into account the PHP ini settings <code>post_max_size</code>
-    * and <code>upload_max_filesize</code>. Since these cannot
-    * be modified at runtime, they are the hard limits for uploads.
-    * 
-    * NOTE: Based on binary values, where 1KB = 1024 Bytes.
-    * 
-    * @return int Will return <code>-1</code> if no limit.
-    */
+    /**
+     * Retrieves the maximum allowed upload file size, in bytes.
+     * Takes into account the PHP ini settings <code>post_max_size</code>
+     * and <code>upload_max_filesize</code>. Since these cannot
+     * be modified at runtime, they are the hard limits for uploads.
+     * 
+     * NOTE: Based on binary values, where 1KB = 1024 Bytes.
+     * 
+     * @return int Will return <code>-1</code> if no limit.
+     */
     public static function getMaxUploadFilesize() : int
     {
         static $max_size = -1;
@@ -1250,16 +1250,16 @@ 
         return round($size);
     }
    
-   /**
-    * Makes a path relative using a folder depth: will reduce the
-    * length of the path so that only the amount of folders defined
-    * in the <code>$depth</code> attribute are shown below the actual
-    * folder or file in the path.
-    *  
-    * @param string  $path The absolute or relative path
-    * @param int $depth The folder depth to reduce the path to
-    * @return string
-    */
+    /**
+     * Makes a path relative using a folder depth: will reduce the
+     * length of the path so that only the amount of folders defined
+     * in the <code>$depth</code> attribute are shown below the actual
+     * folder or file in the path.
+     *  
+     * @param string  $path The absolute or relative path
+     * @param int $depth The folder depth to reduce the path to
+     * @return string
+     */
     public static function relativizePathByDepth(string $path, int $depth=2) : string
     {
         $path = self::normalizePath($path);
@@ -1297,23 +1297,23 @@ 
         return trim(implode('/', $tokens), '/');
     }
     
-   /**
-    * Makes the specified path relative to another path,
-    * by removing one from the other if found. Also 
-    * normalizes the path to use forward slashes. 
-    * 
-    * Example:
-    * 
-    * <pre>
-    * relativizePath('c:\some\folder\to\file.txt', 'c:\some\folder');
-    * </pre>
-    * 
-    * Result: <code>to/file.txt</code>
-    * 
-    * @param string $path
-    * @param string $relativeTo
-    * @return string
-    */
+    /**
+     * Makes the specified path relative to another path,
+     * by removing one from the other if found. Also 
+     * normalizes the path to use forward slashes. 
+     * 
+     * Example:
+     * 
+     * <pre>
+     * relativizePath('c:\some\folder\to\file.txt', 'c:\some\folder');
+     * </pre>
+     * 
+     * Result: <code>to/file.txt</code>
+     * 
+     * @param string $path
+     * @param string $relativeTo
+     * @return string
+     */
     public static function relativizePath(string $path, string $relativeTo) : string
     {
         $path = self::normalizePath($path);
@@ -1325,17 +1325,17 @@ 
         return $relative;
     }
     
-   /**
-    * Checks that the target file exists, and throws an exception
-    * if it does not. 
-    * 
-    * @param string $path
-    * @param int|NULL $errorCode Optional custom error code
-    * @throws FileHelper_Exception
-    * @return string The real path to the file
-    * 
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
-    */
+    /**
+     * Checks that the target file exists, and throws an exception
+     * if it does not. 
+     * 
+     * @param string $path
+     * @param int|NULL $errorCode Optional custom error code
+     * @throws FileHelper_Exception
+     * @return string The real path to the file
+     * 
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
+     */
     public static function requireFileExists(string $path, ?int $errorCode=null) : string
     {
         $result = realpath($path);
@@ -1373,18 +1373,18 @@ 
         );
     }
     
-   /**
-    * Reads a specific line number from the target file and returns its
-    * contents, if the file has such a line. Does so with little memory
-    * usage, as the file is not read entirely into memory.
-    * 
-    * @param string $path
-    * @param int $lineNumber Note: 1-based; the first line is number 1.
-    * @return string|NULL Will return null if the requested line does not exist.
-    * @throws FileHelper_Exception
-    * 
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
-    */
+    /**
+     * Reads a specific line number from the target file and returns its
+     * contents, if the file has such a line. Does so with little memory
+     * usage, as the file is not read entirely into memory.
+     * 
+     * @param string $path
+     * @param int $lineNumber Note: 1-based; the first line is number 1.
+     * @return string|NULL Will return null if the requested line does not exist.
+     * @throws FileHelper_Exception
+     * 
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
+     */
     public static function getLineFromFile(string $path, int $lineNumber) : ?string
     {
         self::requireFileExists($path);
@@ -1400,19 +1400,19 @@ 
         $file->seek($targetLine);
         
         if($file->key() !== $targetLine) {
-             return null;
+                return null;
         }
         
         return $file->current(); 
     }
     
-   /**
-    * Retrieves the total amount of lines in the file, without 
-    * reading the whole file into memory.
-    * 
-    * @param string $path
-    * @return int
-    */
+    /**
+     * Retrieves the total amount of lines in the file, without 
+     * reading the whole file into memory.
+     * 
+     * @param string $path
+     * @return int
+     */
     public static function countFileLines(string $path) : int
     {
         self::requireFileExists($path);
@@ -1442,26 +1442,26 @@ 
         return $number+1;
     }
     
-   /**
-    * Parses the target file to detect any PHP classes contained
-    * within, and retrieve information on them. Does not use the 
-    * PHP reflection API.
-    * 
-    * @param string $filePath
-    * @return FileHelper_PHPClassInfo
-    */
+    /**
+     * Parses the target file to detect any PHP classes contained
+     * within, and retrieve information on them. Does not use the 
+     * PHP reflection API.
+     * 
+     * @param string $filePath
+     * @return FileHelper_PHPClassInfo
+     */
     public static function findPHPClasses(string $filePath) : FileHelper_PHPClassInfo
     {
         return new FileHelper_PHPClassInfo($filePath);
     }
     
-   /**
-    * Detects the end of line style used in the target file, if any.
-    * Can be used with large files, because it only reads part of it.
-    * 
-    * @param string $filePath The path to the file.
-    * @return NULL|ConvertHelper_EOL The end of line character information, or NULL if none is found.
-    */
+    /**
+     * Detects the end of line style used in the target file, if any.
+     * Can be used with large files, because it only reads part of it.
+     * 
+     * @param string $filePath The path to the file.
+     * @return NULL|ConvertHelper_EOL The end of line character information, or NULL if none is found.
+     */
     public static function detectEOLCharacter(string $filePath) : ?ConvertHelper_EOL
     {
         // 20 lines is enough to get a good picture of the newline style in the file.
@@ -1474,18 +1474,18 @@ 
         return ConvertHelper::detectEOLCharacter($string);
     }
     
-   /**
-    * Reads the specified amount of lines from the target file.
-    * Unicode BOM compatible: any byte order marker is stripped
-    * from the resulting lines.
-    * 
-    * @param string $filePath
-    * @param int $amount Set to 0 to read all lines.
-    * @return array
-    * 
-    * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
-    */
+    /**
+     * Reads the specified amount of lines from the target file.
+     * Unicode BOM compatible: any byte order marker is stripped
+     * from the resulting lines.
+     * 
+     * @param string $filePath
+     * @param int $amount Set to 0 to read all lines.
+     * @return array
+     * 
+     * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
+     */
     public static function readLines(string $filePath, int $amount=0) : array
     {
         self::requireFileExists($filePath);
@@ -1538,16 +1538,16 @@ 
         return $result;
     }
     
-   /**
-    * Reads all content from a file.
-    * 
-    * @param string $filePath
-    * @throws FileHelper_Exception
-    * @return string
-    * 
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
-    * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS
-    */
+    /**
+     * Reads all content from a file.
+     * 
+     * @param string $filePath
+     * @throws FileHelper_Exception
+     * @return string
+     * 
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
+     * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS
+     */
     public static function readContents(string $filePath) : string
     {
         self::requireFileExists($filePath);
@@ -1568,18 +1568,18 @@ 
         );
     }
 
-   /**
-    * Ensures that the target path exists on disk, and is a folder.
-    * 
-    * @param string $path
-    * @return string The real path, with normalized slashes.
-    * @throws FileHelper_Exception
-    * 
-    * @see FileHelper::normalizePath()
-    * 
-    * @see FileHelper::ERROR_FOLDER_DOES_NOT_EXIST
-    * @see FileHelper::ERROR_PATH_IS_NOT_A_FOLDER
-    */
+    /**
+     * Ensures that the target path exists on disk, and is a folder.
+     * 
+     * @param string $path
+     * @return string The real path, with normalized slashes.
+     * @throws FileHelper_Exception
+     * 
+     * @see FileHelper::normalizePath()
+     * 
+     * @see FileHelper::ERROR_FOLDER_DOES_NOT_EXIST
+     * @see FileHelper::ERROR_PATH_IS_NOT_A_FOLDER
+     */
     public static function requireFolderExists(string $path) : string
     {
         $actual = realpath($path);

src/ConvertHelper.php

Indentation +496 added lines, -496 removed lines

@@ -54,13 +54,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);
@@ -78,133 +78,133 @@ 
         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);
         return $converter->toString();
     }
 
-   /**
-    * Converts a timestamp into an easily understandable
-    * format, e.g. "2 hours", "1 day", "3 months"
-    *
-    * If you set the date to parameter, the difference
-    * will be calculated between the two dates and not
-    * the current time.
-    *
-    * @param integer|DateTime $datefrom
-    * @param integer|DateTime $dateto
-    * @return string
-    */
+    /**
+     * Converts a timestamp into an easily understandable
+     * format, e.g. "2 hours", "1 day", "3 months"
+     *
+     * If you set the date to parameter, the difference
+     * will be calculated between the two dates and not
+     * the current time.
+     *
+     * @param integer|DateTime $datefrom
+     * @param integer|DateTime $dateto
+     * @return string
+     */
     public static function duration2string($datefrom, $dateto = -1) : string
     {
-         $converter = new ConvertHelper_DurationConverter();
+            $converter = new ConvertHelper_DurationConverter();
          
-         if($datefrom instanceof DateTime)
-         {
-             $converter->setDateFrom($datefrom);
-         }
-         else
-         {
-             $converter->setDateFrom(self::timestamp2date($datefrom)); 
-         }
+            if($datefrom instanceof DateTime)
+            {
+                $converter->setDateFrom($datefrom);
+            }
+            else
+            {
+                $converter->setDateFrom(self::timestamp2date($datefrom)); 
+            }
 
-         if($dateto instanceof DateTime)
-         {
-             $converter->setDateTo($dateto);
-         }
-         else if($dateto > 0)
-         {
-             $converter->setDateTo(self::timestamp2date($dateto));
-         }
+            if($dateto instanceof DateTime)
+            {
+                $converter->setDateTo($dateto);
+            }
+            else if($dateto > 0)
+            {
+                $converter->setDateTo(self::timestamp2date($dateto));
+            }
 
-         return $converter->convert();
+            return $converter->convert();
     }
 
-   /**
-    * 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);
@@ -221,14 +221,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();
@@ -249,41 +249,41 @@ 
         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);
     }
 
-   /**
-    * Alias for the {@\AppUtils\XMLHelper::string2xml()} method.
-    * 
-    * @param string $text
-    * @return string
-    * @deprecated
-    */
+    /**
+     * Alias for the {@\AppUtils\XMLHelper::string2xml()} method.
+     * 
+     * @param string $text
+     * @return string
+     * @deprecated
+     */
     public static function text_makeXMLCompliant($text)
     {
         return XMLHelper::string2xml($text);
@@ -379,36 +379,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()
     {
         return self::createControlCharacters()->getCharsAsHex();
     }
     
-   /**
-    * Retrieves an array of all control characters that
-    * the {@link stripControlCharacters()} method will 
-    * remove, as the actual UTF-8 characters.
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves an array of all control characters that
+     * the {@link stripControlCharacters()} method will 
+     * remove, as the actual UTF-8 characters.
+     * 
+     * @return string[]
+     */
     public static function getControlCharactersAsUTF8()
     {
         return self::createControlCharacters()->getCharsAsUTF8();
     }
     
-   /**
-    * Retrieves all control characters as JSON encoded
-    * characters, e.g. "\u200b".
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves all control characters as JSON encoded
+     * characters, e.g. "\u200b".
+     * 
+     * @return string[]
+     */
     public static function getControlCharactersAsJSON()
     {
         return self::createControlCharacters()->getCharsAsJSON();
@@ -429,31 +429,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 PHPO notation.
-    * 
-    * Example:
-    * 
-    * <pre>unicodeChar2php('"\u0000"')</pre>
-    * 
-    * Returns
-    * 
-    * <pre>\x0</pre>
-    * 
-    * @param string $unicodeChar
-    * @return string
-    */
+    /**
+     * Converts a unicode character to the PHPO notation.
+     * 
+     * Example:
+     * 
+     * <pre>unicodeChar2php('"\u0000"')</pre>
+     * 
+     * Returns
+     * 
+     * <pre>\x0</pre>
+     * 
+     * @param string $unicodeChar
+     * @return string
+     */
     public static function unicodeChar2php(string $unicodeChar) : string 
     {
         $unicodeChar = json_decode($unicodeChar);
@@ -563,87 +563,87 @@ 
         return ConvertHelper_Bool::toString($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 (int)$date->format('U');
     }
     
-   /**
-    * Converts a timestamp into a DateTime instance.
-    * @param int $timestamp
-    * @return DateTime
-    */
+    /**
+     * Converts a timestamp into a DateTime instance.
+     * @param int $timestamp
+     * @return DateTime
+     */
     public static function timestamp2date(int $timestamp) : DateTime
     {
         $date = new DateTime();
@@ -651,50 +651,50 @@ 
         return $date;
     }
     
-   /**
-    * Strips an absolute path to a file within the application
-    * to make the path relative to the application root path.
-    * 
-    * @param string $path
-    * @return string
-    * 
-    * @see FileHelper::relativizePath()
-    * @see FileHelper::relativizePathByDepth()
-    */
+    /**
+     * Strips an absolute path to a file within the application
+     * to make the path relative to the application root path.
+     * 
+     * @param string $path
+     * @return string
+     * 
+     * @see FileHelper::relativizePath()
+     * @see FileHelper::relativizePathByDepth()
+     */
     public static function fileRelativize(string $path) : string
     {
         return FileHelper::relativizePathByDepth($path);
     }
     
     /**
-    * Converts a PHP regex to a javascript RegExp object statement.
-    * 
-    * NOTE: This is an alias for the JSHelper's `convertRegex` method. 
-    * More details are available on its usage there.
-    *
-    * @param string $regex A PHP preg regex
-    * @param string $statementType The type of statement to return: Defaults to a statement to create a RegExp object.
-    * @return array|string Depending on the specified return type.
-    * 
-    * @see JSHelper::buildRegexStatement()
-    */
+     * Converts a PHP regex to a javascript RegExp object statement.
+     * 
+     * NOTE: This is an alias for the JSHelper's `convertRegex` method. 
+     * More details are available on its usage there.
+     *
+     * @param string $regex A PHP preg regex
+     * @param string $statementType The type of statement to return: Defaults to a statement to create a RegExp object.
+     * @return array|string Depending on the specified return type.
+     * 
+     * @see JSHelper::buildRegexStatement()
+     */
     public static function regex2js(string $regex, string $statementType=JSHelper::JS_REGEX_OBJECT)
     {
         return JSHelper::buildRegexStatement($regex, $statementType);
     }
     
-   /**
-    * Converts the specified variable to JSON. Works just
-    * like the native `json_encode` method, except that it
-    * will trigger an exception on failure, which has the 
-    * json error details included in its developer details.
-    * 
-    * @param mixed $variable
-    * @param int $options JSON encode options.
-    * @param int $depth 
-    * @throws ConvertHelper_Exception
-    * @return string
-    */
+    /**
+     * Converts the specified variable to JSON. Works just
+     * like the native `json_encode` method, except that it
+     * will trigger an exception on failure, which has the 
+     * json error details included in its developer details.
+     * 
+     * @param mixed $variable
+     * @param int $options JSON encode options.
+     * @param int $depth 
+     * @throws ConvertHelper_Exception
+     * @return string
+     */
     public static function var2json($variable, int $options=0, int $depth=512) : string
     {
         $result = json_encode($variable, $options, $depth);
@@ -715,12 +715,12 @@ 
         );
     }
     
-   /**
-    * Strips all known UTF byte order marks from the specified string.
-    * 
-    * @param string $string
-    * @return string
-    */
+    /**
+     * Strips all known UTF byte order marks from the specified string.
+     * 
+     * @param string $string
+     * @return string
+     */
     public static function stripUTFBom($string)
     {
         $boms = FileHelper::getUTFBOMs();
@@ -735,65 +735,65 @@ 
         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 $options
-    * @return float
-    */
+    /**
+     * Calculates a percentage match of the source string with the target string.
+     * 
+     * Options are:
+     * 
+     * - maxLevenshtein, default: 10
+     *   Any levenshtein results above this value are ignored.
+     *   
+     * - precision, default: 1
+     *   The precision of the percentage float value
+     * 
+     * @param string $source
+     * @param string $target
+     * @param array $options
+     * @return float
+     */
     public static function matchString($source, $target, $options=array())
     {
         $defaults = array(
@@ -817,14 +817,14 @@ 
         return round(100 - $percent, $options['precision']);
     }
     
-   /**
-    * Converts a date interval to a human readable string with
-    * all necessary time components, e.g. "1 year, 2 months and 4 days".
-    * 
-    * @param \DateInterval $interval
-    * @return string
-    * @see ConvertHelper_IntervalConverter
-    */
+    /**
+     * Converts a date interval to a human readable string with
+     * all necessary time components, e.g. "1 year, 2 months and 4 days".
+     * 
+     * @param \DateInterval $interval
+     * @return string
+     * @see ConvertHelper_IntervalConverter
+     */
     public static function interval2string(\DateInterval $interval) : string
     {
         $converter = new ConvertHelper_IntervalConverter();
@@ -839,60 +839,60 @@ 
     
     const INTERVAL_SECONDS = 'seconds';
     
-   /**
-    * Converts an interval to its total amount of days.
-    * @param \DateInterval $interval
-    * @return int
-    */
+    /**
+     * Converts an interval to its total amount of days.
+     * @param \DateInterval $interval
+     * @return int
+     */
     public static function interval2days(\DateInterval $interval) : int
     {
         return self::interval2total($interval, self::INTERVAL_DAYS);
     }
 
-   /**
-    * Converts an interval to its total amount of hours.
-    * @param \DateInterval $interval
-    * @return int
-    */
+    /**
+     * Converts an interval to its total amount of hours.
+     * @param \DateInterval $interval
+     * @return int
+     */
     public static function interval2hours(\DateInterval $interval) : int
     {
         return self::interval2total($interval, self::INTERVAL_HOURS);
     }
     
-   /**
-    * Converts an interval to its total amount of minutes. 
-    * @param \DateInterval $interval
-    * @return int
-    */
+    /**
+     * Converts an interval to its total amount of minutes. 
+     * @param \DateInterval $interval
+     * @return int
+     */
     public static function interval2minutes(\DateInterval $interval) : int
     {
         return self::interval2total($interval, self::INTERVAL_MINUTES);
     }
     
-   /**
-    * Converts an interval to its total amount of seconds.
-    * @param \DateInterval $interval
-    * @return int
-    */    
+    /**
+     * Converts an interval to its total amount of seconds.
+     * @param \DateInterval $interval
+     * @return int
+     */    
     public static function interval2seconds(\DateInterval $interval) : int
     {
         return self::interval2total($interval, self::INTERVAL_SECONDS);
     }
     
-   /**
-    * Calculates the total amount of days / hours / minutes or seconds
-    * of a date interval object (depending in the specified units), and 
-    * returns the total amount.
-    * 
-    * @param \DateInterval $interval
-    * @param string $unit What total value to calculate.
-    * @return integer
-    * 
-    * @see ConvertHelper::INTERVAL_SECONDS
-    * @see ConvertHelper::INTERVAL_MINUTES
-    * @see ConvertHelper::INTERVAL_HOURS
-    * @see ConvertHelper::INTERVAL_DAYS
-    */
+    /**
+     * Calculates the total amount of days / hours / minutes or seconds
+     * of a date interval object (depending in the specified units), and 
+     * returns the total amount.
+     * 
+     * @param \DateInterval $interval
+     * @param string $unit What total value to calculate.
+     * @return integer
+     * 
+     * @see ConvertHelper::INTERVAL_SECONDS
+     * @see ConvertHelper::INTERVAL_MINUTES
+     * @see ConvertHelper::INTERVAL_HOURS
+     * @see ConvertHelper::INTERVAL_DAYS
+     */
     public static function interval2total(\DateInterval $interval, $unit=self::INTERVAL_SECONDS) : int
     {
         $total = (int)$interval->format('%a');
@@ -932,13 +932,13 @@ 
         'Sunday'
     );
     
-   /**
-    * Converts a date to the corresponding day name.
-    * 
-    * @param DateTime $date
-    * @param bool $short
-    * @return string|NULL
-    */
+    /**
+     * Converts a date to the corresponding day name.
+     * 
+     * @param DateTime $date
+     * @param bool $short
+     * @return string|NULL
+     */
     public static function date2dayName(DateTime $date, bool $short=false)
     {
         $day = $date->format('l');
@@ -953,21 +953,21 @@ 
         return null;
     }
     
-   /**
-    * Retrieves a list of english day names.
-    * @return string[]
-    */
+    /**
+     * Retrieves a list of english day names.
+     * @return string[]
+     */
     public static function getDayNamesInvariant()
     {
         return self::$daysInvariant;
     }
     
-   /**
-    * Retrieves the day names list for the current locale.
-    * 
-    * @param bool $short
-    * @return array
-    */
+    /**
+     * Retrieves the day names list for the current locale.
+     * 
+     * @param bool $short
+     * @return array
+     */
     public static function getDayNames(bool $short=false) : array
     {
         if($short) {
@@ -1014,68 +1014,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);
@@ -1107,88 +1107,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
-    * @see ConvertHelper_QueryParser
-    */
+    /**
+     * Parses the specified query string like the native 
+     * function <code>parse_str</code>, without the key
+     * naming limitations.
+     * 
+     * Using parse_str, dots or spaces in key names are 
+     * replaced by underscores. This method keeps all names
+     * intact.
+     * 
+     * It still uses the parse_str implementation as it 
+     * is tested and tried, but fixes the parameter names
+     * after parsing, as needed.
+     * 
+     * @param string $queryString
+     * @return array
+     * @see ConvertHelper_QueryParser
+     */
     public static function parseQueryString(string $queryString) : array
     {
         $parser = new ConvertHelper_QueryParser();
         return $parser->parse($queryString);
     }
 
-   /**
-    * Searches for needle in the specified string, and returns a list
-    * of all occurrences, including the matched string. The matched 
-    * string is useful when doing a case insensitive search, as it 
-    * shows the exact matched case of needle.
-    *   
-    * @param string $needle
-    * @param string $haystack
-    * @param bool $caseInsensitive
-    * @return ConvertHelper_StringMatch[]
-    */
+    /**
+     * Searches for needle in the specified string, and returns a list
+     * of all occurrences, including the matched string. The matched 
+     * string is useful when doing a case insensitive search, as it 
+     * shows the exact matched case of needle.
+     *   
+     * @param string $needle
+     * @param string $haystack
+     * @param bool $caseInsensitive
+     * @return ConvertHelper_StringMatch[]
+     */
     public static function findString(string $needle, string $haystack, bool $caseInsensitive=false): 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 $array
-    * @param array $keys
-    */
+    /**
+     * Removes the specified keys from the target array,
+     * if they exist.
+     * 
+     * @param array $array
+     * @param array $keys
+     */
     public static function arrayRemoveKeys(array &$array, array $keys) : void
     {
         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)) {
@@ -1208,52 +1208,52 @@ 
         return false;    
     }
     
-   /**
-    * Converts an amount of seconds to a DateInterval object.
-    * 
-    * @param int $seconds
-    * @return \DateInterval
-    * @throws ConvertHelper_Exception If the date interval cannot be created.
-    * 
-    * @see ConvertHelper::ERROR_CANNOT_GET_DATE_DIFF
-    */
+    /**
+     * Converts an amount of seconds to a DateInterval object.
+     * 
+     * @param int $seconds
+     * @return \DateInterval
+     * @throws ConvertHelper_Exception If the date interval cannot be created.
+     * 
+     * @see ConvertHelper::ERROR_CANNOT_GET_DATE_DIFF
+     */
     public static function seconds2interval(int $seconds) : \DateInterval
     {
         return ConvertHelper_DateInterval::fromSeconds($seconds)->getInterval();
     }
     
-   /**
-    * Converts a size string like "50 MB" to the corresponding byte size.
-    * It is case insensitive, ignores spaces, and supports both traditional
-    * "MB" and "MiB" notations.
-    * 
-    * @param string $size
-    * @return int
-    */
+    /**
+     * Converts a size string like "50 MB" to the corresponding byte size.
+     * It is case insensitive, ignores spaces, and supports both traditional
+     * "MB" and "MiB" notations.
+     * 
+     * @param string $size
+     * @return int
+     */
     public static function size2bytes(string $size) : int
     {
         return self::parseSize($size)->toBytes();
     }
     
-   /**
-    * Parses a size string like "50 MB" and returns a size notation instance
-    * that has utility methods to access information on it, and convert it.
-    * 
-    * @param string $size
-    * @return ConvertHelper_SizeNotation
-    */
+    /**
+     * Parses a size string like "50 MB" and returns a size notation instance
+     * that has utility methods to access information on it, and convert it.
+     * 
+     * @param string $size
+     * @return ConvertHelper_SizeNotation
+     */
     public static function parseSize(string $size) : ConvertHelper_SizeNotation
     {
         return new ConvertHelper_SizeNotation($size);
     }
     
-   /**
-    * Creates a URL finder instance, which can be used to find
-    * URLs in a string - be it plain text, or HTML.
-    * 
-    * @param string $subject
-    * @return ConvertHelper_URLFinder
-    */
+    /**
+     * Creates a URL finder instance, which can be used to find
+     * URLs in a string - be it plain text, or HTML.
+     * 
+     * @param string $subject
+     * @return ConvertHelper_URLFinder
+     */
     public static function createURLFinder(string $subject) : ConvertHelper_URLFinder
     {
         return new ConvertHelper_URLFinder($subject);

src/ConvertHelper/EOL.php

Indentation +26 added lines, -26 removed lines

@@ -29,19 +29,19 @@ 
     const TYPE_LF = 'LF';
     const TYPE_CR = 'CR';
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $char;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $type;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $description;
 
     /**
@@ -56,33 +56,33 @@ 
         $this->description = $description;
     }
     
-   /**
-    * The actual EOL character.
-    * @return string
-    */
+    /**
+     * The actual EOL character.
+     * @return string
+     */
     public function getCharacter() : string
     {
         return $this->char;
     }
     
-   /**
-    * A more detailed, human readable description of the character.
-    * @return string
-    */
+    /**
+     * A more detailed, human readable description of the character.
+     * @return string
+     */
     public function getDescription() : string
     {
         return $this->description;
     }
     
-   /**
-    * The EOL character type, e.g. "CR+LF", "CR"...
-    * @return string
-    * 
-    * @see ConvertHelper_EOL::TYPE_CR
-    * @see ConvertHelper_EOL::TYPE_CRLF
-    * @see ConvertHelper_EOL::TYPE_LF
-    * @see ConvertHelper_EOL::TYPE_LFCR
-    */
+    /**
+     * The EOL character type, e.g. "CR+LF", "CR"...
+     * @return string
+     * 
+     * @see ConvertHelper_EOL::TYPE_CR
+     * @see ConvertHelper_EOL::TYPE_CRLF
+     * @see ConvertHelper_EOL::TYPE_LF
+     * @see ConvertHelper_EOL::TYPE_LFCR
+     */
     public function getType() : string
     {
         return $this->type;

src/StringBuilder.php

Indentation +147 added lines, -147 removed lines

@@ -33,24 +33,24 @@ 
  */
 class StringBuilder implements StringBuilder_Interface
 {
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $separator = ' ';
 
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected $strings = array();
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $mode = 'html';
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $noSpace = '§!§';
     
     public function __construct()
@@ -58,12 +58,12 @@ 
         
     }
     
-   /**
-    * Adds a subject as a string. Is ignored if empty.
-    * 
-    * @param string|number|StringBuilder_Interface $string
-    * @return $this
-    */
+    /**
+     * Adds a subject as a string. Is ignored if empty.
+     * 
+     * @param string|number|StringBuilder_Interface $string
+     * @return $this
+     */
     public function add($string) : StringBuilder
     {
         $string = strval($string);
@@ -76,57 +76,57 @@ 
         return $this;
     }
     
-   /**
-    * Adds a string without appending an automatic space.
-    * 
-    * @param string|number|StringBuilder_Interface $string
-    * @return $this
-    */
+    /**
+     * Adds a string without appending an automatic space.
+     * 
+     * @param string|number|StringBuilder_Interface $string
+     * @return $this
+     */
     public function nospace($string) : StringBuilder
     {
         return $this->add($this->noSpace.strval($string));
     }
     
-   /**
-    * Adds raw HTML code. Does not add an automatic space.
-    * 
-    * @param string|number|StringBuilder_Interface $html
-    * @return $this
-    */
+    /**
+     * Adds raw HTML code. Does not add an automatic space.
+     * 
+     * @param string|number|StringBuilder_Interface $html
+     * @return $this
+     */
     public function html($html) : StringBuilder
     {
         return $this->nospace($html);
     }
     
-   /**
-    * Adds an unordered list with the specified items.
-    * 
-    * @param array<int,string|number|StringBuilder_Interface> $items
-    * @return $this
-    */
+    /**
+     * Adds an unordered list with the specified items.
+     * 
+     * @param array<int,string|number|StringBuilder_Interface> $items
+     * @return $this
+     */
     public function ul(array $items) : StringBuilder
     {
         return $this->list('ul', $items);
     }
     
-   /**
-    * Adds an ordered list with the specified items.
-    * 
-    * @param array<int,string|number|StringBuilder_Interface> $items
-    * @return $this
-    */
+    /**
+     * Adds an ordered list with the specified items.
+     * 
+     * @param array<int,string|number|StringBuilder_Interface> $items
+     * @return $this
+     */
     public function ol(array $items) : StringBuilder
     {
         return $this->list('ol', $items);
     }
     
-   /**
-    * Creates a list tag with the items list.
-    * 
-    * @param string $type The list type, `ol` or `ul`.
-    * @param array<int,string|number|StringBuilder_Interface> $items
-    * @return $this
-    */
+    /**
+     * Creates a list tag with the items list.
+     * 
+     * @param string $type The list type, `ol` or `ul`.
+     * @param array<int,string|number|StringBuilder_Interface> $items
+     * @return $this
+     */
     protected function list(string $type, array $items) : StringBuilder
     {
         return $this->html(sprintf(
@@ -136,13 +136,13 @@ 
         ));
     }
     
-   /**
-    * Add a translated string.
-    * 
-    * @param string $format The native string to translate.
-    * @param array<int,mixed> $arguments The variables to inject into the translated string, if any.
-    * @return $this
-    */
+    /**
+     * Add a translated string.
+     * 
+     * @param string $format The native string to translate.
+     * @param array<int,mixed> $arguments The variables to inject into the translated string, if any.
+     * @return $this
+     */
     public function t(string $format, ...$arguments) : StringBuilder
     {
         array_unshift($arguments, $format);
@@ -158,47 +158,47 @@ 
         ));
     }
     
-   /**
-    * Adds a "5 months ago" age since the specified date.
-    * 
-    * @param DateTime $since
-    * @return $this
-    */
+    /**
+     * Adds a "5 months ago" age since the specified date.
+     * 
+     * @param DateTime $since
+     * @return $this
+     */
     public function age(DateTime $since) : StringBuilder
     {
         return $this->add(ConvertHelper::duration2string($since));
     }
     
-   /**
-    * Adds HTML quotes around the string.
-    * 
-    * @param string|number|StringBuilder_Interface $string
-    * @return $this
-    */
+    /**
+     * Adds HTML quotes around the string.
+     * 
+     * @param string|number|StringBuilder_Interface $string
+     * @return $this
+     */
     public function quote($string)
     {
         return $this->sf('&quot;%s&quot;', strval($string));
     }
     
-   /**
-    * Adds a text that is meant as a reference to an UI element,
-    * like a menu item, button, etc.
-    * 
-    * @param string|number|StringBuilder_Interface $string 
-    * @return $this
-    */
+    /**
+     * Adds a text that is meant as a reference to an UI element,
+     * like a menu item, button, etc.
+     * 
+     * @param string|number|StringBuilder_Interface $string 
+     * @return $this
+     */
     public function reference($string) : StringBuilder
     {
         return $this->sf('"%s"', $string);
     }
 
-   /**
-    * Add a string using the `sprintf` method.
-    * 
-    * @param string $format The format string
-    * @param string|number|StringBuilder_Interface ...$arguments The variables to inject
-    * @return $this
-    */
+    /**
+     * Add a string using the `sprintf` method.
+     * 
+     * @param string $format The format string
+     * @param string|number|StringBuilder_Interface ...$arguments The variables to inject
+     * @return $this
+     */
     public function sf(string $format, ...$arguments) : StringBuilder
     {
         array_unshift($arguments, $format);
@@ -206,12 +206,12 @@ 
         return $this->add(call_user_func_array('sprintf', $arguments));
     }
     
-   /**
-    * Adds a bold string.
-    * 
-    * @param string|number|StringBuilder_Interface $string
-    * @return $this
-    */
+    /**
+     * Adds a bold string.
+     * 
+     * @param string|number|StringBuilder_Interface $string
+     * @return $this
+     */
     public function bold($string) : StringBuilder
     {
         return $this->sf(
@@ -220,12 +220,12 @@ 
         );
     }
     
-   /**
-    * Adds a HTML `br` tag.
-    * 
-    * @return $this
-    * @see StringBuilder::eol()
-    */
+    /**
+     * Adds a HTML `br` tag.
+     * 
+     * @return $this
+     * @see StringBuilder::eol()
+     */
     public function nl() : StringBuilder
     {
         return $this->html('<br>');
@@ -242,52 +242,52 @@ 
         return $this->nospace(PHP_EOL);
     }
     
-   /**
-    * Adds the current time, in the format <code>H:i:s</code>.
-    * 
-    * @return $this
-    */
+    /**
+     * Adds the current time, in the format <code>H:i:s</code>.
+     * 
+     * @return $this
+     */
     public function time() : StringBuilder
     {
         return $this->add(date('H:i:s'));
     }
     
-   /**
-    * Adds the "Note:" text.
-    * 
-    * @return $this
-    */
+    /**
+     * Adds the "Note:" text.
+     * 
+     * @return $this
+     */
     public function note() : StringBuilder
     {
         return $this->t('Note:');
     }
     
-   /**
-    * Like `note()`, but as bold text.
-    * 
-    * @return $this
-    */
+    /**
+     * Like `note()`, but as bold text.
+     * 
+     * @return $this
+     */
     public function noteBold() : StringBuilder
     {
         return $this->bold(sb()->note());
     }
     
-   /**
-    * Adds the "Hint:" text.
-    * 
-    * @return $this
-    */
+    /**
+     * Adds the "Hint:" text.
+     * 
+     * @return $this
+     */
     public function hint() : StringBuilder
     {
         return $this->t('Hint:');
     }
     
-   /**
-    * Adds two linebreaks.
-    *
-    * @param StringBuilder_Interface|string|NULL
-    * @return $this
-    */
+    /**
+     * Adds two linebreaks.
+     *
+     * @param StringBuilder_Interface|string|NULL
+     * @return $this
+     */
     public function para($content=null) : StringBuilder
     {
         if($content !== null) {
@@ -297,14 +297,14 @@ 
         return $this->nl()->nl();
     }
     
-   /**
-    * Adds an anchor HTML tag.
-    * 
-    * @param string $label
-    * @param string $url
-    * @param bool $newTab
-    * @return $this
-    */
+    /**
+     * Adds an anchor HTML tag.
+     * 
+     * @param string $label
+     * @param string $url
+     * @param bool $newTab
+     * @return $this
+     */
     public function link(string $label, string $url, bool $newTab=false) : StringBuilder
     {
         $target = '';
@@ -320,12 +320,12 @@ 
         );
     }
     
-   /**
-    * Wraps the string in a `code` tag.
-    * 
-    * @param string|number|StringBuilder_Interface $string
-    * @return $this
-    */
+    /**
+     * Wraps the string in a `code` tag.
+     * 
+     * @param string|number|StringBuilder_Interface $string
+     * @return $this
+     */
     public function code($string) : StringBuilder
     {
         return $this->sf(
@@ -334,24 +334,24 @@ 
         );
     }
     
-   /**
-    * Wraps the string in a `pre` tag.
-    * 
-    * @param string|number|StringBuilder_Interface $string
-    * @return $this
-    */
+    /**
+     * Wraps the string in a `pre` tag.
+     * 
+     * @param string|number|StringBuilder_Interface $string
+     * @return $this
+     */
     public function pre($string) : StringBuilder
     {
         return $this->sf('<pre>%s</pre>', strval($string));
     }
     
-   /**
-    * Wraps the text in a `span` tag with the specified classes.
-    * 
-    * @param string|number|StringBuilder_Interface $string
-    * @param string|string[] $classes
-    * @return $this
-    */
+    /**
+     * Wraps the text in a `span` tag with the specified classes.
+     * 
+     * @param string|number|StringBuilder_Interface $string
+     * @param string|string[] $classes
+     * @return $this
+     */
     protected function spanned($string, $classes) : StringBuilder
     {
         if(!is_array($classes))