Mistralys / application-utils

src/Request/RefreshParams.php

Indentation +82 added lines, -82 removed lines

@@ -23,14 +23,14 @@ 
 {
     use Traits_Optionable;
     
-   /**
-    * @var array<string,mixed>
-    */
+    /**
+     * @var array<string,mixed>
+     */
     private array $overrides = array();
     
-   /**
-    * @var Request_RefreshParams_Exclude[]
-    */
+    /**
+     * @var Request_RefreshParams_Exclude[]
+     */
     private array $excludes = array();
     
     public function getDefaultOptions() : array
@@ -41,27 +41,27 @@ 
         );
     }
     
-   /**
-    * Whether to automatically exclude the session variable
-    * from the parameters.
-    * 
-    * @param bool $exclude
-    * @return Request_RefreshParams
-    */
+    /**
+     * Whether to automatically exclude the session variable
+     * from the parameters.
+     * 
+     * @param bool $exclude
+     * @return Request_RefreshParams
+     */
     public function setExcludeSessionName(bool $exclude=true) : Request_RefreshParams
     {
         $this->setOption('exclude-session-name', $exclude);
         return $this;
     }
     
-   /**
-    * Whether to automatically exclude the HTML_QuickForm2
-    * request variable used to track whether a form has been
-    * submitted.
-    * 
-    * @param bool $exclude
-    * @return Request_RefreshParams
-    */
+    /**
+     * Whether to automatically exclude the HTML_QuickForm2
+     * request variable used to track whether a form has been
+     * submitted.
+     * 
+     * @param bool $exclude
+     * @return Request_RefreshParams
+     */
     public function setExcludeQuickform(bool $exclude) : Request_RefreshParams
     {
         $this->setOption('exclude-quickform-submitter', $exclude);
@@ -99,12 +99,12 @@ 
         return $this;
     }
     
-   /**
-    * Excludes a request parameter by name.
-    * 
-    * @param array<int,string|number> $paramNames
-    * @return Request_RefreshParams
-    */
+    /**
+     * Excludes a request parameter by name.
+     * 
+     * @param array<int,string|number> $paramNames
+     * @return Request_RefreshParams
+     */
     public function excludeParamsByName(array $paramNames) : Request_RefreshParams
     {
         foreach($paramNames as $name)
@@ -115,15 +115,15 @@ 
         return $this;
     }
     
-   /**
-    * Overrides a parameter: even if it exists, this
-    * value will be used instead - even if it is on 
-    * the list of excluded parameters.
-    * 
-    * @param string $paramName
-    * @param mixed $paramValue
-    * @return Request_RefreshParams
-    */
+    /**
+     * Overrides a parameter: even if it exists, this
+     * value will be used instead - even if it is on 
+     * the list of excluded parameters.
+     * 
+     * @param string $paramName
+     * @param mixed $paramValue
+     * @return Request_RefreshParams
+     */
     public function overrideParam(string $paramName, $paramValue) : Request_RefreshParams
     {
         $this->overrides[$paramName] = $paramValue;
@@ -131,12 +131,12 @@ 
         return $this;
     }
     
-   /**
-    * Overrides an array of parameters. 
-    * 
-    * @param array<string|number,mixed> $params
-    * @return Request_RefreshParams
-    */
+    /**
+     * Overrides an array of parameters. 
+     * 
+     * @param array<string|number,mixed> $params
+     * @return Request_RefreshParams
+     */
     public function overrideParams(array $params) : Request_RefreshParams
     {
         foreach($params as $name => $value)
@@ -147,14 +147,14 @@ 
         return $this;
     }
     
-   /**
-    * Resolves all the parameter exclusions that should
-    * be applied to the list of parameters. This includes
-    * the manually added exclusions and the dynamic exclusions
-    * like the session name.
-    * 
-    * @return Request_RefreshParams_Exclude[]
-    */
+    /**
+     * Resolves all the parameter exclusions that should
+     * be applied to the list of parameters. This includes
+     * the manually added exclusions and the dynamic exclusions
+     * like the session name.
+     * 
+     * @return Request_RefreshParams_Exclude[]
+     */
     private function resolveExcludes() : array
     {
         $excludes = $this->excludes;
@@ -165,12 +165,12 @@ 
         return $excludes;
     }
     
-   /**
-    * Automatically excludes the session name from the
-    * parameters, if present.
-    * 
-    * @param Request_RefreshParams_Exclude[] $excludes
-    */
+    /**
+     * Automatically excludes the session name from the
+     * parameters, if present.
+     * 
+     * @param Request_RefreshParams_Exclude[] $excludes
+     */
     private function autoExcludeSessionName(array &$excludes) : void
     {
         if($this->getBoolOption('exclude-session-name'))
@@ -179,12 +179,12 @@ 
         }
     }
    
-   /**
-    * Automatically excludes the HTML_QuickForm2 submit
-    * tracking variable, when enabled.
-    * 
-    * @param Request_RefreshParams_Exclude[] $excludes
-    */
+    /**
+     * Automatically excludes the HTML_QuickForm2 submit
+     * tracking variable, when enabled.
+     * 
+     * @param Request_RefreshParams_Exclude[] $excludes
+     */
     private function autoExcludeQuickform(array &$excludes) : void
     {
         if($this->getBoolOption('exclude-quickform-submitter'))
@@ -196,12 +196,12 @@ 
         }
     }
     
-   /**
-    * Retrieves the list of parameters matching the 
-    * current settings.
-    * 
-    * @return array<string,mixed>
-    */
+    /**
+     * Retrieves the list of parameters matching the 
+     * current settings.
+     * 
+     * @return array<string,mixed>
+     */
     public function getParams() : array
     {
         $params = $this->removeExcluded($_REQUEST);
@@ -217,12 +217,12 @@ 
         return $params;
     }
     
-   /**
-    * Removes all excluded parameters from the array.
-    * 
-    * @param array<string,mixed> $params
-    * @return array<string,mixed>
-    */
+    /**
+     * Removes all excluded parameters from the array.
+     * 
+     * @param array<string,mixed> $params
+     * @return array<string,mixed>
+     */
     private function removeExcluded(array $params) : array
     {
         $result = array();
@@ -240,14 +240,14 @@ 
         return $result;
     }
     
-   /**
-    * Checks all configured exclusions to see if the 
-    * parameter should be excluded or not.
-    * 
-    * @param string $paramName
-    * @param mixed $paramValue
-    * @return bool
-    */
+    /**
+     * Checks all configured exclusions to see if the 
+     * parameter should be excluded or not.
+     * 
+     * @param string $paramName
+     * @param mixed $paramValue
+     * @return bool
+     */
     public function isExcluded(string $paramName, $paramValue) : bool
     {
         $excludes = $this->resolveExcludes();

src/Request/RefreshParams/Exclude/Callback.php

Indentation +3 added lines, -3 removed lines

@@ -20,9 +20,9 @@
  */
 class Request_RefreshParams_Exclude_Callback extends Request_RefreshParams_Exclude
 {
-   /**
-    * @var callable
-    */
+    /**
+     * @var callable
+     */
     private $callback;
     
     public function __construct(callable $callback)

src/VariableInfo/Renderer.php

Indentation +8 added lines, -8 removed lines

@@ -6,9 +6,9 @@ 
 
 abstract class VariableInfo_Renderer
 {
-   /**
-    * @var mixed|NULL
-    */
+    /**
+     * @var mixed|NULL
+     */
     protected $value;
     
     protected VariableInfo $info;
@@ -24,11 +24,11 @@ 
     
     abstract protected function init() : void;
 
-   /**
-    * Renders the value to the target format.
-    * 
-    * @return string
-    */
+    /**
+     * Renders the value to the target format.
+     * 
+     * @return string
+     */
     public function render() : string
     {
         return $this->_render();

src/CSVHelper.php

Indentation +116 added lines, -116 removed lines

@@ -78,12 +78,12 @@ 
         
     }
 
-   /**
-    * Creates and returns a new instance of the CSV builder which
-    * can be used to build CSV from scratch.
-    * 
-    * @return CSVHelper_Builder
-    */
+    /**
+     * Creates and returns a new instance of the CSV builder which
+     * can be used to build CSV from scratch.
+     * 
+     * @return CSVHelper_Builder
+     */
     public static function createBuilder() : CSVHelper_Builder
     {
         return new CSVHelper_Builder();
@@ -91,16 +91,16 @@ 
 
 
 
-   /**
-    * Loads CSV data from a string. 
-    * 
-    * Note: Use the {@link hasErrors()} method to 
-    * check if the string could be parsed correctly
-    * afterwards.
-    * 
-    * @param string $string
-    * @return $this
-    */
+    /**
+     * Loads CSV data from a string. 
+     * 
+     * Note: Use the {@link hasErrors()} method to 
+     * check if the string could be parsed correctly
+     * afterwards.
+     * 
+     * @param string $string
+     * @return $this
+     */
     public function loadString(string $string) : self
     {
         // remove any UTF byte order marks that may still be present in the string
@@ -114,20 +114,20 @@ 
         return $this;
     }
     
-   /**
-    * Loads CSV data from a file.
-    * 
-    * Note: Use the {@link hasErrors()} method to 
-    * check if the string could be parsed correctly
-    * afterwards.
-    * 
-    * @param string $file
-    * @throws FileHelper_Exception
-    * @return CSVHelper
-    * 
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
-    * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS
-    */
+    /**
+     * Loads CSV data from a file.
+     * 
+     * Note: Use the {@link hasErrors()} method to 
+     * check if the string could be parsed correctly
+     * afterwards.
+     * 
+     * @param string $file
+     * @throws FileHelper_Exception
+     * @return CSVHelper
+     * 
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
+     * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS
+     */
     public function loadFile(string $file) : self
     {
         $csv = FileHelper::readContents($file);
@@ -188,19 +188,19 @@ 
         return $this->headersPosition === $position;
     }
     
-   /**
-    * Specifies where the headers are positioned in the
-    * CSV, or turns them off entirely. Use the class constants
-    * to ensure the value is correct.
-    * 
-    * @param string $position
-    * @throws CSVHelper_Exception
-    * @return $this
-    *
-    * @see CSVHelper::HEADERS_LEFT
-    * @see CSVHelper::HEADERS_TOP
-    * @see CSVHelper::HEADERS_NONE
-    */
+    /**
+     * Specifies where the headers are positioned in the
+     * CSV, or turns them off entirely. Use the class constants
+     * to ensure the value is correct.
+     * 
+     * @param string $position
+     * @throws CSVHelper_Exception
+     * @return $this
+     *
+     * @see CSVHelper::HEADERS_LEFT
+     * @see CSVHelper::HEADERS_TOP
+     * @see CSVHelper::HEADERS_NONE
+     */
     public function setHeadersPosition(string $position) : self
     {
         $validPositions = array(
@@ -227,13 +227,13 @@ 
         return $this;
     }
     
-   /**
-    * Resets all internal data, allowing to start entirely anew
-    * with a new file, or to start building a new CSV file from
-    * scratch.
-    * 
-    * @return $this
-    */
+    /**
+     * Resets all internal data, allowing to start entirely anew
+     * with a new file, or to start building a new CSV file from
+     * scratch.
+     * 
+     * @return $this
+     */
     public function reset() : self
     {
         $this->data = array();
@@ -253,81 +253,81 @@ 
         return $this->data;
     }
     
-   /**
-    * Retrieves the row at the specified index.
-    * If there is no data at the index, this will
-    * return an array populated with empty strings
-    * for all available columns.
-    * 
-    * Tip: Use the {@link rowExists()} method to check
-    * whether the specified row exists.
-    * 
-    * @param integer $index
-    * @return array<int,mixed>
-    * @see rowExists()
-    */
+    /**
+     * Retrieves the row at the specified index.
+     * If there is no data at the index, this will
+     * return an array populated with empty strings
+     * for all available columns.
+     * 
+     * Tip: Use the {@link rowExists()} method to check
+     * whether the specified row exists.
+     * 
+     * @param integer $index
+     * @return array<int,mixed>
+     * @see rowExists()
+     */
     public function getRow(int $index) : array
     {
         return $this->data[$index] ?? array_fill(0, $this->rowCount, '');
     }
     
-   /**
-    * Checks whether the specified row exists in the data set.
-    * @param integer $index
-    * @return boolean
-    */
+    /**
+     * Checks whether the specified row exists in the data set.
+     * @param integer $index
+     * @return boolean
+     */
     public function rowExists(int $index) : bool
     {
         return isset($this->data[$index]);
     }
     
-   /**
-    * Counts the amount of rows in the parsed CSV,
-    * excluding the headers if any, depending on 
-    * their position.
-    * 
-    * @return integer
-    */
+    /**
+     * Counts the amount of rows in the parsed CSV,
+     * excluding the headers if any, depending on 
+     * their position.
+     * 
+     * @return integer
+     */
     public function countRows() : int
     {
         return $this->rowCount;
     }
     
-   /**
-    * Counts the amount of rows in the parsed CSV, 
-    * excluding the headers if any, depending on
-    * their position.
-    * 
-    * @return integer
-    */
+    /**
+     * Counts the amount of rows in the parsed CSV, 
+     * excluding the headers if any, depending on
+     * their position.
+     * 
+     * @return integer
+     */
     public function countColumns() : int
     {
         return $this->columnCount;
     }
     
-   /**
-    * Retrieves the headers, if any. Specify the position of the
-    * headers first to ensure this works correctly.
-    * 
-    * @return string[] Indexed array with header names.
-    */
+    /**
+     * Retrieves the headers, if any. Specify the position of the
+     * headers first to ensure this works correctly.
+     * 
+     * @return string[] Indexed array with header names.
+     */
     public function getHeaders() : array
     {
         return $this->headers;
     }
     
-   /**
-    * Retrieves the column at the specified index. If there
-    * is no column at the index, this returns an array
-    * populated with empty strings.
-    * 
-    * Tip: Use the {@link columnExists()} method to check
-    * whether a column exists.
-    * 
-    * @param integer $index
-    * @return string[]
-    * @see columnExists()
-    */
+    /**
+     * Retrieves the column at the specified index. If there
+     * is no column at the index, this returns an array
+     * populated with empty strings.
+     * 
+     * Tip: Use the {@link columnExists()} method to check
+     * whether a column exists.
+     * 
+     * @param integer $index
+     * @return string[]
+     * @see columnExists()
+     */
     public function getColumn(int $index) : array
     {
         $data = array();
@@ -342,11 +342,11 @@ 
         return $data;
     }
     
-   /**
-    * Checks whether the specified column exists in the data set.
-    * @param integer $index
-    * @return boolean
-    */
+    /**
+     * Checks whether the specified column exists in the data set.
+     * @param integer $index
+     * @return boolean
+     */
     public function columnExists(int $index) : bool
     {
         return $index < $this->columnCount;
@@ -406,22 +406,22 @@ 
         }
     }
     
-   /**
-    * Checks whether any errors have been encountered
-    * while parsing the CSV.
-    * 
-    * @return boolean
-    * @see getErrorMessages()
-    */
+    /**
+     * Checks whether any errors have been encountered
+     * while parsing the CSV.
+     * 
+     * @return boolean
+     * @see getErrorMessages()
+     */
     public function hasErrors() : bool
     {
         return !empty($this->errors);
     }
     
-   /**
-    * Retrieves all error messages.
-    * @return string[]
-    */
+    /**
+     * Retrieves all error messages.
+     * @return string[]
+     */
     public function getErrorMessages() : array
     {
         return $this->errors;

src/URLInfo/URIConnectionTester.php

Indentation +10 added lines, -10 removed lines

@@ -43,13 +43,13 @@ 
         );
     }
     
-   /**
-    * Whether to verify the host's SSL certificate, in
-    * case of a https connection.
-    * 
-    * @param bool $verifySSL
-    * @return URIConnectionTester
-    */
+    /**
+     * Whether to verify the host's SSL certificate, in
+     * case of a https connection.
+     * 
+     * @param bool $verifySSL
+     * @return URIConnectionTester
+     */
     public function setVerifySSL(bool $verifySSL=true) : URIConnectionTester
     {
         $this->setOption('verify-ssl', $verifySSL);
@@ -83,9 +83,9 @@ 
         return $this->getIntOption('timeout');
     }
     
-   /**
-    * @param resource|CurlHandle $ch
-    */
+    /**
+     * @param resource|CurlHandle $ch
+     */
     private function configureOptions($ch) : void
     {
         if($this->isVerboseModeEnabled())

src/RequestHelper.php

Indentation +103 added lines, -103 removed lines

@@ -46,19 +46,19 @@ 
     protected int $contentLength = 0;
 
     /**
-    * @var array<string,string>
-    */
+     * @var array<string,string>
+     */
     protected $headers = array();
 
-   /**
-    * @var resource|NULL
-    */
+    /**
+     * @var resource|NULL
+     */
     protected $logfilePointer;
     
-   /**
-    * 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;
@@ -81,13 +81,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;
@@ -100,13 +100,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;
@@ -114,15 +114,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);
@@ -160,13 +160,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;
@@ -174,31 +174,31 @@ 
         return $this;
     }
     
-   /**
-    * Disables SSL certificate checking.
-    * 
-    * @return RequestHelper
-    */
+    /**
+     * Disables SSL certificate checking.
+     * 
+     * @return RequestHelper
+     */
     public function disableSSLChecks() : RequestHelper
     {
         $this->verifySSL = false;
         return $this;
     }
    
-   /**
-    * 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);
@@ -238,13 +238,13 @@ 
         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();
@@ -276,14 +276,14 @@ 
         );
     }
 
-   /**
-    * 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 configureCURL(URLInfo $url)
     {
         $ch = self::createCURL();
@@ -353,13 +353,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 string[]
-    */
+    /**
+     * Compiles the associative headers array into
+     * the format understood by CURL, namely an indexed
+     * array with one header string per entry.
+     * 
+     * @return string[]
+     */
     protected function renderHeaders() : array
     {
         $result = array();
@@ -373,12 +373,12 @@ 
         return $result;
     }
     
-   /**
-    * Retrieves the raw response header, in the form of an indexed
-    * array containing all response header lines.
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves the raw response header, in the form of an indexed
+     * array containing all response header lines.
+     * 
+     * @return string[]
+     */
     public function getResponseHeader() : array
     {
         $response = $this->getResponse();
@@ -390,33 +390,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
     {
         return $this->headers[$name] ?? '';

src/FileHelper.php

Indentation +162 added lines, -162 removed lines

@@ -73,18 +73,18 @@ 
     public const ERROR_PATH_INVALID = 340040;
     public const ERROR_CANNOT_COPY_FILE_TO_FOLDER = 340041;
 
-   /**
-    * Opens a serialized file and returns the unserialized data.
-    *
-    * @param string|PathInfoInterface|SplFileInfo $file
-    * @throws FileHelper_Exception
-    * @return array<int|string,mixed>
-    * @see SerializedFile::parse()
-    * 
-    * @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|PathInfoInterface|SplFileInfo $file
+     * @throws FileHelper_Exception
+     * @return array<int|string,mixed>
+     * @see SerializedFile::parse()
+     * 
+     * @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($file) : array
     {
         return SerializedFile::factory($file)->parse();
@@ -103,13 +103,13 @@ 
         return FolderTree::delete($rootFolder);
     }
     
-   /**
-    * Create a folder, if it does not exist yet.
-    *  
-    * @param string|PathInfoInterface $path
-    * @throws FileHelper_Exception
-    * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
-    */
+    /**
+     * Create a folder, if it does not exist yet.
+     *  
+     * @param string|PathInfoInterface $path
+     * @throws FileHelper_Exception
+     * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
+     */
     public static function createFolder($path) : FolderInfo
     {
         return self::getFolderInfo($path)->create();
@@ -138,36 +138,36 @@ 
         FolderTree::copy($source, $target);
     }
     
-   /**
-    * 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|PathInfoInterface|SplFileInfo $sourcePath
-    * @param string|PathInfoInterface|SplFileInfo $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|PathInfoInterface|SplFileInfo $sourcePath
+     * @param string|PathInfoInterface|SplFileInfo $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($sourcePath, $targetPath) : void
     {
         self::getFileInfo($sourcePath)->copyTo($targetPath);
     }
     
-   /**
-    * Deletes the target file. Ignored if it cannot be found,
-    * and throws an exception if it fails.
-    * 
-    * @param string|PathInfoInterface|SplFileInfo $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|PathInfoInterface|SplFileInfo $filePath
+     * @throws FileHelper_Exception
+     * 
+     * @see FileHelper::ERROR_CANNOT_DELETE_FILE
+     */
     public static function deleteFile($filePath) : void
     {
         self::getFileInfo($filePath)->delete();
@@ -288,7 +288,7 @@ 
      */
     public static function isPHPFile($filePath) : bool
     {
-    	return self::getExtension($filePath) === 'php';
+        return self::getExtension($filePath) === 'php';
     }
 
     /**
@@ -354,16 +354,16 @@ 
             ->parse();
     }
     
-   /**
-    * 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
     {
         return NameFixer::fixName($name);
@@ -423,23 +423,23 @@ 
         return self::findFiles($targetFolder, array('php'), $options);
     }
     
-   /**
-    * Finds files according to the specified options.
-    * 
-    * NOTE: This method only exists for backwards compatibility.
-    * Use the {@see FileHelper::createFileFinder()} method instead,
-    * which offers an object-oriented interface that is much easier
-    * to use.
-    *  
-    * @param string|PathInfoInterface|SplFileInfo $targetFolder
-    * @param string[] $extensions
-    * @param array<string,mixed> $options
-    * @throws FileHelper_Exception
-    * @return string[]
-    *
-    * @see FileHelper::createFileFinder()
-    * @deprecated Use the file finder instead.
-    */
+    /**
+     * Finds files according to the specified options.
+     * 
+     * NOTE: This method only exists for backwards compatibility.
+     * Use the {@see FileHelper::createFileFinder()} method instead,
+     * which offers an object-oriented interface that is much easier
+     * to use.
+     *  
+     * @param string|PathInfoInterface|SplFileInfo $targetFolder
+     * @param string[] $extensions
+     * @param array<string,mixed> $options
+     * @throws FileHelper_Exception
+     * @return string[]
+     *
+     * @see FileHelper::createFileFinder()
+     * @deprecated Use the file finder instead.
+     */
     public static function findFiles($targetFolder, array $extensions=array(), array $options=array()) : array
     {
         $finder = self::createFileFinder($targetFolder);
@@ -510,13 +510,13 @@ 
         return self::$unicodeHandling;
     }
     
-   /**
-    * Normalizes the slash style in a file or folder path,
-    * by replacing any anti-slashes with forward slashes.
-    * 
-    * @param string $path
-    * @return string
-    */
+    /**
+     * Normalizes the slash style in a file or folder path,
+     * by replacing any anti-slashes with forward slashes.
+     * 
+     * @param string $path
+     * @return string
+     */
     public static function normalizePath(string $path) : string
     {
         return str_replace(array('\\', '//'), array('/', '/'), $path);
@@ -641,70 +641,70 @@ 
             ->getPaths();
     }
 
-   /**
-    * 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
     {
         return UploadFileSizeInfo::getFileSize();
     }
    
-   /**
-    * 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
     {
         return PathRelativizer::relativizeByDepth($path, $depth);
     }
     
-   /**
-    * 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
     {
         return PathRelativizer::relativize($path, $relativeTo);
     }
     
-   /**
-    * Checks that the target file exists, and throws an exception
-    * if it does not. 
-    * 
-    * @param string|SplFileInfo $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
-    * @see FileHelper::ERROR_REAL_PATH_NOT_FOUND
-    */
+    /**
+     * Checks that the target file exists, and throws an exception
+     * if it does not. 
+     * 
+     * @param string|SplFileInfo $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
+     * @see FileHelper::ERROR_REAL_PATH_NOT_FOUND
+     */
     public static function requireFileExists($path, ?int $errorCode=null) : string
     {
         return self::getPathInfo($path)
@@ -727,18 +727,18 @@ 
             ->getPath();
     }
     
-   /**
-    * 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|PathInfoInterface|SplFileInfo $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|PathInfoInterface|SplFileInfo $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($path, int $lineNumber) : ?string
     {
         return self::getFileInfo($path)->getLine($lineNumber);
@@ -804,33 +804,33 @@ 
             ->getLines($amount);
     }
     
-   /**
-    * Reads all content from a file.
-    * 
-    * @param string|PathInfoInterface|SplFileInfo $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|PathInfoInterface|SplFileInfo $filePath
+     * @throws FileHelper_Exception
+     * @return string
+     * 
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
+     * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS
+     */
     public static function readContents($filePath) : string
     {
         return self::getFileInfo($filePath)->getContents();
     }
 
-   /**
-    * Ensures that the target path exists on disk, and is a folder.
-    * 
-    * @param string|PathInfoInterface|SplFileInfo $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|PathInfoInterface|SplFileInfo $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($path) : string
     {
         return self::getFolderInfo($path)

src/ConvertHelper.php

Indentation +471 added lines, -471 removed lines

@@ -66,13 +66,13 @@ 
         return ConvertHelper_String::tabs2spaces($string, $tabSize);
     }
     
-   /**
-    * Converts spaces to tabs in the specified string.
-    * 
-    * @param string $string
-    * @param int $tabSize The amount of spaces per tab in the source string.
-    * @return string
-    */
+    /**
+     * Converts spaces to tabs in the specified string.
+     * 
+     * @param string $string
+     * @param int $tabSize The amount of spaces per tab in the source string.
+     * @return string
+     */
     public static function spaces2tabs(string $string, int $tabSize=4) : string
     {
         return ConvertHelper_String::spaces2tabs($string, $tabSize);
@@ -90,14 +90,14 @@ 
         return ConvertHelper_String::hidden2visible($string);
     }
     
-   /**
-    * Converts the specified amount of seconds into
-    * a human-readable string split in months, weeks,
-    * days, hours, minutes and seconds.
-    *
-    * @param float $seconds
-    * @return string
-    */
+    /**
+     * Converts the specified amount of seconds into
+     * a human-readable string split in months, weeks,
+     * days, hours, minutes and seconds.
+     *
+     * @param float $seconds
+     * @return string
+     */
     public static function time2string($seconds) : string
     {
         $converter = new ConvertHelper_TimeConverter($seconds);
@@ -121,85 +121,85 @@ 
      */
     public static function duration2string($datefrom, $dateto = -1) : string
     {
-         return ConvertHelper_DurationConverter::toString($datefrom, $dateto);
+            return ConvertHelper_DurationConverter::toString($datefrom, $dateto);
     }
 
-   /**
-    * Adds HTML syntax highlighting to the specified SQL string.
-    * 
-    * @param string $sql
-    * @return string
-    * @deprecated Use the Highlighter class directly instead.
-    * @see Highlighter::sql()
-    */
+    /**
+     * Adds HTML syntax highlighting to the specified SQL string.
+     * 
+     * @param string $sql
+     * @return string
+     * @deprecated Use the Highlighter class directly instead.
+     * @see Highlighter::sql()
+     */
     public static function highlight_sql(string $sql) : string
     {
         return Highlighter::sql($sql);
     }
 
-   /**
-    * Adds HTML syntax highlighting to the specified XML code.
-    * 
-    * @param string $xml The XML to highlight.
-    * @param bool $formatSource Whether to format the source with indentation to make it readable.
-    * @return string
-    * @deprecated Use the Highlighter class directly instead.
-    * @see Highlighter::xml()
-    */
+    /**
+     * Adds HTML syntax highlighting to the specified XML code.
+     * 
+     * @param string $xml The XML to highlight.
+     * @param bool $formatSource Whether to format the source with indentation to make it readable.
+     * @return string
+     * @deprecated Use the Highlighter class directly instead.
+     * @see Highlighter::xml()
+     */
     public static function highlight_xml(string $xml, bool $formatSource=false) : string
     {
         return Highlighter::xml($xml, $formatSource);
     }
 
-   /**
-    * @param string $phpCode
-    * @return string
-    * @deprecated Use the Highlighter class directly instead.
-    * @see Highlighter::php()
-    */
+    /**
+     * @param string $phpCode
+     * @return string
+     * @deprecated Use the Highlighter class directly instead.
+     * @see Highlighter::php()
+     */
     public static function highlight_php(string $phpCode) : string
     {
         return Highlighter::php($phpCode);
     }
     
-   /**
-    * Converts a number of bytes to a human-readable form,
-    * e.g. xx Kb / xx Mb / xx Gb
-    *
-    * @param int $bytes The amount of bytes to convert.
-    * @param int $precision The amount of decimals
-    * @param int $base The base to calculate with: Base 10 is default (=1000 Bytes in a KB), Base 2 is mainly used for Windows memory (=1024 Bytes in a KB).
-    * @return string
-    * 
-    * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions
-    */
+    /**
+     * Converts a number of bytes to a human-readable form,
+     * e.g. xx Kb / xx Mb / xx Gb
+     *
+     * @param int $bytes The amount of bytes to convert.
+     * @param int $precision The amount of decimals
+     * @param int $base The base to calculate with: Base 10 is default (=1000 Bytes in a KB), Base 2 is mainly used for Windows memory (=1024 Bytes in a KB).
+     * @return string
+     * 
+     * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions
+     */
     public static function bytes2readable(int $bytes, int $precision = 1, int $base = ConvertHelper_StorageSizeEnum::BASE_10) : string
     {
         return self::parseBytes($bytes)->toString($precision, $base);
     }
     
-   /**
-    * Parses a number of bytes, and creates a converter instance which
-    * allows doing common operations with it.
-    * 
-    * @param int $bytes
-    * @return ConvertHelper_ByteConverter
-    */
+    /**
+     * Parses a number of bytes, and creates a converter instance which
+     * allows doing common operations with it.
+     * 
+     * @param int $bytes
+     * @return ConvertHelper_ByteConverter
+     */
     public static function parseBytes(int $bytes) : ConvertHelper_ByteConverter
     {
         return new ConvertHelper_ByteConverter($bytes);
     }
 
-   /**
-    * Cuts a text to the specified length if it is longer than the
-    * target length. Appends a text to signify it has been cut at 
-    * the end of the string.
-    * 
-    * @param string $text
-    * @param int $targetLength
-    * @param string $append
-    * @return string
-    */
+    /**
+     * Cuts a text to the specified length if it is longer than the
+     * target length. Appends a text to signify it has been cut at 
+     * the end of the string.
+     * 
+     * @param string $text
+     * @param int $targetLength
+     * @param string $append
+     * @return string
+     */
     public static function text_cut(string $text, int $targetLength, string $append = '...') : string
     {
         return ConvertHelper_String::cutText($text, $targetLength, $append);
@@ -223,14 +223,14 @@ 
         return $info->toString();
     }
     
-   /**
-    * Pretty `print_r`.
-    * 
-    * @param mixed $var The variable to dump.
-    * @param bool $return Whether to return the dumped code.
-    * @param bool $html Whether to style the dump as HTML.
-    * @return string
-    */
+    /**
+     * Pretty `print_r`.
+     * 
+     * @param mixed $var The variable to dump.
+     * @param bool $return Whether to return the dumped code.
+     * @param bool $html Whether to style the dump as HTML.
+     * @return string
+     */
     public static function print_r($var, bool $return=false, bool $html=true) : string
     {
         $result = parseVariable($var)->enableType()->toString();
@@ -251,29 +251,29 @@ 
         return $result;
     }
     
-   /**
-    * Converts a string, number or boolean value to a boolean value.
-    *
-    * @param mixed $string
-    * @throws ConvertHelper_Exception
-    * @return bool
-    *
-    * @see ConvertHelper::ERROR_INVALID_BOOLEAN_STRING
-    */
+    /**
+     * Converts a string, number or boolean value to a boolean value.
+     *
+     * @param mixed $string
+     * @throws ConvertHelper_Exception
+     * @return bool
+     *
+     * @see ConvertHelper::ERROR_INVALID_BOOLEAN_STRING
+     */
     public static function string2bool($string) : bool
     {
         return ConvertHelper_Bool::fromString($string);
     }
 
-   /**
-    * Whether the specified string is a boolean string or boolean value.
-    * Alias for {@link ConvertHelper::isBoolean()}.
-    *
-    * @param mixed $string
-    * @return bool
-    * @deprecated
-    * @see ConvertHelper::isBoolean()
-    */
+    /**
+     * Whether the specified string is a boolean string or boolean value.
+     * Alias for {@link ConvertHelper::isBoolean()}.
+     *
+     * @param mixed $string
+     * @return bool
+     * @deprecated
+     * @see ConvertHelper::isBoolean()
+     */
     public static function isBooleanString($string) : bool
     {
         return self::isBoolean($string);
@@ -343,36 +343,36 @@ 
         return ConvertHelper_String::transliterate($string, $spaceChar, $lowercase);
     }
     
-   /**
-    * Retrieves the HEX character codes for all control
-    * characters that the {@link stripControlCharacters()} 
-    * method will remove.
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves the HEX character codes for all control
+     * characters that the {@link stripControlCharacters()} 
+     * method will remove.
+     * 
+     * @return string[]
+     */
     public static function getControlCharactersAsHex() : array
     {
         return self::createControlCharacters()->getCharsAsHex();
     }
     
-   /**
-    * Retrieves an array of all control characters that
-    * the {@link stripControlCharacters()} method will 
-    * remove, as the actual UTF-8 characters.
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves an array of all control characters that
+     * the {@link stripControlCharacters()} method will 
+     * remove, as the actual UTF-8 characters.
+     * 
+     * @return string[]
+     */
     public static function getControlCharactersAsUTF8() : array
     {
         return self::createControlCharacters()->getCharsAsUTF8();
     }
     
-   /**
-    * Retrieves all control characters as JSON encoded
-    * characters, e.g. "\u200b".
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves all control characters as JSON encoded
+     * characters, e.g. "\u200b".
+     * 
+     * @return string[]
+     */
     public static function getControlCharactersAsJSON() : array
     {
         return self::createControlCharacters()->getCharsAsJSON();
@@ -393,31 +393,31 @@ 
         return self::createControlCharacters()->stripControlCharacters($string);
     }
     
-   /**
-    * Creates the control characters class, used to 
-    * work with control characters in strings.
-    * 
-    * @return ConvertHelper_ControlCharacters
-    */
+    /**
+     * Creates the control characters class, used to 
+     * work with control characters in strings.
+     * 
+     * @return ConvertHelper_ControlCharacters
+     */
     public static function createControlCharacters() : ConvertHelper_ControlCharacters
     {
         return new ConvertHelper_ControlCharacters();
     }
 
-   /**
-    * Converts a unicode character to the PHP notation.
-    * 
-    * Example:
-    * 
-    * <pre>unicodeChar2php('"\u0000"')</pre>
-    * 
-    * Returns
-    * 
-    * <pre>\x0</pre>
-    * 
-    * @param string $unicodeChar
-    * @return string
-    */
+    /**
+     * Converts a unicode character to the PHP notation.
+     * 
+     * Example:
+     * 
+     * <pre>unicodeChar2php('"\u0000"')</pre>
+     * 
+     * Returns
+     * 
+     * <pre>\x0</pre>
+     * 
+     * @param string $unicodeChar
+     * @return string
+     */
     public static function unicodeChar2php(string $unicodeChar) : string 
     {
         $unicodeChar = json_decode($unicodeChar);
@@ -531,25 +531,25 @@ 
         return ConvertHelper_Bool::toStringStrict($boolean, $yesNo);
     }
 
-   /**
-    * Converts an associative array with attribute name > value pairs
-    * to an attribute string that can be used in an HTML tag. Empty 
-    * attribute values are ignored.
-    * 
-    * Example:
-    * 
-    * array2attributeString(array(
-    *     'id' => 45,
-    *     'href' => 'http://www.mistralys.com'
-    * ));
-    * 
-    * Result:
-    * 
-    * id="45" href="http://www.mistralys.com"
-    * 
-    * @param array<string,mixed> $array
-    * @return string
-    */
+    /**
+     * Converts an associative array with attribute name > value pairs
+     * to an attribute string that can be used in an HTML tag. Empty 
+     * attribute values are ignored.
+     * 
+     * Example:
+     * 
+     * array2attributeString(array(
+     *     'id' => 45,
+     *     'href' => 'http://www.mistralys.com'
+     * ));
+     * 
+     * Result:
+     * 
+     * id="45" href="http://www.mistralys.com"
+     * 
+     * @param array<string,mixed> $array
+     * @return string
+     */
     public static function array2attributeString(array $array) : string
     {
         return ConvertHelper_Array::toAttributeString($array);
@@ -569,116 +569,116 @@ 
         return self::var2json($array);
     }
     
-   /**
-    * Converts a string, so it can safely be used in a javascript
-    * statement in an HTML tag: uses single quotes around the string
-    * and encodes all special characters as needed.
-    * 
-    * @param string $string
-    * @return string
-    * @deprecated Use the JSHelper class instead.
-    * @see JSHelper::phpVariable2AttributeJS()
-    */
+    /**
+     * Converts a string, so it can safely be used in a javascript
+     * statement in an HTML tag: uses single quotes around the string
+     * and encodes all special characters as needed.
+     * 
+     * @param string $string
+     * @return string
+     * @deprecated Use the JSHelper class instead.
+     * @see JSHelper::phpVariable2AttributeJS()
+     */
     public static function string2attributeJS(string $string) : string
     {
         return JSHelper::phpVariable2AttributeJS($string);
     }
     
-   /**
-    * Checks if the specified string is a boolean value, which
-    * includes string representations of boolean values, like 
-    * <code>yes</code> or <code>no</code>, and <code>true</code>
-    * or <code>false</code>.
-    * 
-    * @param mixed $value
-    * @return boolean
-    */
+    /**
+     * Checks if the specified string is a boolean value, which
+     * includes string representations of boolean values, like 
+     * <code>yes</code> or <code>no</code>, and <code>true</code>
+     * or <code>false</code>.
+     * 
+     * @param mixed $value
+     * @return boolean
+     */
     public static function isBoolean($value) : bool
     {
         return ConvertHelper_Bool::isBoolean($value);
     }
     
-   /**
-    * Converts an associative array to an HTML style attribute value string.
-    * 
-    * @param array<string,mixed> $subject
-    * @return string
-    */
+    /**
+     * Converts an associative array to an HTML style attribute value string.
+     * 
+     * @param array<string,mixed> $subject
+     * @return string
+     */
     public static function array2styleString(array $subject) : string
     {
         return ConvertHelper_Array::toStyleString($subject);
     }
     
-   /**
-    * Converts a DateTime object to a timestamp, which
-    * is PHP 5.2 compatible.
-    * 
-    * @param DateTime $date
-    * @return integer
-    */
+    /**
+     * Converts a DateTime object to a timestamp, which
+     * is PHP 5.2 compatible.
+     * 
+     * @param DateTime $date
+     * @return integer
+     */
     public static function date2timestamp(DateTime $date) : int
     {
         return ConvertHelper_Date::toTimestamp($date);
     }
     
-   /**
-    * Converts a timestamp into a DateTime instance.
-    * @param int $timestamp
-    * @return DateTime
-    */
+    /**
+     * Converts a timestamp into a DateTime instance.
+     * @param int $timestamp
+     * @return DateTime
+     */
     public static function timestamp2date(int $timestamp) : DateTime
     {
         return ConvertHelper_Date::fromTimestamp($timestamp);
     }
     
-   /**
-    * Strips an absolute path to a file within the application
-    * to make the path relative to the application root path.
-    * 
-    * @param string $path
-    * @return string
-    * 
-    * @see FileHelper::relativizePath()
-    * @see FileHelper::relativizePathByDepth()
-    */
+    /**
+     * Strips an absolute path to a file within the application
+     * to make the path relative to the application root path.
+     * 
+     * @param string $path
+     * @return string
+     * 
+     * @see FileHelper::relativizePath()
+     * @see FileHelper::relativizePathByDepth()
+     */
     public static function fileRelativize(string $path) : string
     {
         return FileHelper::relativizePathByDepth($path);
     }
     
     /**
-    * Converts a PHP regex to a javascript RegExp object statement.
-    * 
-    * NOTE: This is an alias for the JSHelper's `convertRegex` method. 
-    * More details are available on its usage there.
-    *
-    * @param string $regex A PHP preg regex
-    * @param string $statementType The type of statement to return: Defaults to a statement to create a RegExp object.
-    * @return string Depending on the specified return type.
-    * 
-    * @see JSHelper::buildRegexStatement()
-    */
+     * Converts a PHP regex to a javascript RegExp object statement.
+     * 
+     * NOTE: This is an alias for the JSHelper's `convertRegex` method. 
+     * More details are available on its usage there.
+     *
+     * @param string $regex A PHP preg regex
+     * @param string $statementType The type of statement to return: Defaults to a statement to create a RegExp object.
+     * @return string Depending on the specified return type.
+     * 
+     * @see JSHelper::buildRegexStatement()
+     */
     public static function regex2js(string $regex, string $statementType=JSHelper::JS_REGEX_OBJECT) : string
     {
         return JSHelper::buildRegexStatement($regex, $statementType);
     }
     
-   /**
-    * Converts the specified variable to a JSON string.
-    *
-    * Works just like the native `json_encode` method,
-    * except that it will trigger an exception on failure,
-    * which has the json error details included in its
-    * developer details.
-    * 
-    * @param mixed $variable
-    * @param int $options JSON encode options.
-    * @param int $depth 
-    * @return string
-    *
-    * @throws JSONConverterException
-    * @see ConvertHelper::ERROR_JSON_ENCODE_FAILED
-    */
+    /**
+     * Converts the specified variable to a JSON string.
+     *
+     * Works just like the native `json_encode` method,
+     * except that it will trigger an exception on failure,
+     * which has the json error details included in its
+     * developer details.
+     * 
+     * @param mixed $variable
+     * @param int $options JSON encode options.
+     * @param int $depth 
+     * @return string
+     *
+     * @throws JSONConverterException
+     * @see ConvertHelper::ERROR_JSON_ENCODE_FAILED
+     */
     public static function var2json($variable, int $options=0, int $depth=512) : string
     {
         return JSONConverter::var2json($variable, $options, $depth);
@@ -726,12 +726,12 @@ 
             ->toString();
     }
     
-   /**
-    * Strips all known UTF byte order marks from the specified string.
-    * 
-    * @param string $string
-    * @return string
-    */
+    /**
+     * Strips all known UTF byte order marks from the specified string.
+     * 
+     * @param string $string
+     * @return string
+     */
     public static function stripUTFBom(string $string) : string
     {
         $boms = FileHelper::createUnicodeHandling()->getUTFBOMs();
@@ -750,69 +750,69 @@ 
         return $string;
     }
 
-   /**
-    * Converts a string to valid utf8, regardless
-    * of the string's encoding(s).
-    * 
-    * @param string $string
-    * @return string
-    */
+    /**
+     * Converts a string to valid utf8, regardless
+     * of the string's encoding(s).
+     * 
+     * @param string $string
+     * @return string
+     */
     public static function string2utf8(string $string) : string
     {
         return ConvertHelper_String::toUtf8($string);
     }
     
-   /**
-    * Checks whether the specified string is an ASCII
-    * string, without any special or UTF8 characters.
-    * Note: empty strings and NULL are considered ASCII.
-    * Any variable types other than strings are not.
-    * 
-    * @param string|float|int|NULL $string
-    * @return boolean
-    */
+    /**
+     * Checks whether the specified string is an ASCII
+     * string, without any special or UTF8 characters.
+     * Note: empty strings and NULL are considered ASCII.
+     * Any variable types other than strings are not.
+     * 
+     * @param string|float|int|NULL $string
+     * @return boolean
+     */
     public static function isStringASCII($string) : bool
     {
         return ConvertHelper_String::isASCII(strval($string));
     }
     
-   /**
-    * Adds HTML syntax highlighting to an URL.
-    * 
-    * NOTE: Includes the necessary CSS styles. When
-    * highlighting several URLs in the same page,
-    * prefer using the `parseURL` function instead.
-    * 
-    * @param string $url
-    * @return string
-    * @deprecated Use the Highlighter class directly instead.
-    * @see Highlighter
-    */
+    /**
+     * Adds HTML syntax highlighting to an URL.
+     * 
+     * NOTE: Includes the necessary CSS styles. When
+     * highlighting several URLs in the same page,
+     * prefer using the `parseURL` function instead.
+     * 
+     * @param string $url
+     * @return string
+     * @deprecated Use the Highlighter class directly instead.
+     * @see Highlighter
+     */
     public static function highlight_url(string $url) : string
     {
         return Highlighter::url($url);
     }
 
-   /**
-    * Calculates a percentage match of the source string with the target string.
-    * 
-    * Options are:
-    * 
-    * - maxLevenshtein, default: 10
-    *   Any levenshtein results above this value are ignored.
-    *   
-    * - precision, default: 1
-    *   The precision of the percentage float value
-    * 
-    * @param string $source
-    * @param string $target
-    * @param array<string,mixed> $options
-    * @return float
-    *
-    * @see ConvertHelper_TextComparer
-    * @see ConvertHelper_TextComparer::OPTION_MAX_LEVENSHTEIN_DISTANCE
-    * @see ConvertHelper_TextComparer::OPTION_PRECISION
-    */
+    /**
+     * Calculates a percentage match of the source string with the target string.
+     * 
+     * Options are:
+     * 
+     * - maxLevenshtein, default: 10
+     *   Any levenshtein results above this value are ignored.
+     *   
+     * - precision, default: 1
+     *   The precision of the percentage float value
+     * 
+     * @param string $source
+     * @param string $target
+     * @param array<string,mixed> $options
+     * @return float
+     *
+     * @see ConvertHelper_TextComparer
+     * @see ConvertHelper_TextComparer::OPTION_MAX_LEVENSHTEIN_DISTANCE
+     * @see ConvertHelper_TextComparer::OPTION_PRECISION
+     */
     public static function matchString(string $source, string $target, array $options=array()) : float
     {
         return (new ConvertHelper_TextComparer())
@@ -820,109 +820,109 @@ 
             ->match($source, $target);
     }
     
-   /**
-    * Converts a date interval to a human-readable string with
-    * all necessary time components, e.g. "1 year, 2 months and 4 days".
-    * 
-    * @param DateInterval $interval
-    * @return string
-    * @see ConvertHelper_IntervalConverter
-    *
-    * @throws ConvertHelper_Exception
-    * @see ConvertHelper_IntervalConverter::ERROR_MISSING_TRANSLATION
-    */
+    /**
+     * Converts a date interval to a human-readable string with
+     * all necessary time components, e.g. "1 year, 2 months and 4 days".
+     * 
+     * @param DateInterval $interval
+     * @return string
+     * @see ConvertHelper_IntervalConverter
+     *
+     * @throws ConvertHelper_Exception
+     * @see ConvertHelper_IntervalConverter::ERROR_MISSING_TRANSLATION
+     */
     public static function interval2string(DateInterval $interval) : string
     {
         return (new ConvertHelper_IntervalConverter())
             ->toString($interval);
     }
     
-   /**
-    * Converts an interval to its total amount of days.
-    * @param DateInterval $interval
-    * @return int
-    */
+    /**
+     * Converts an interval to its total amount of days.
+     * @param DateInterval $interval
+     * @return int
+     */
     public static function interval2days(DateInterval $interval) : int
     {
         return ConvertHelper_DateInterval::toDays($interval);
     }
 
-   /**
-    * Converts an interval to its total amount of hours.
-    * @param DateInterval $interval
-    * @return int
-    */
+    /**
+     * Converts an interval to its total amount of hours.
+     * @param DateInterval $interval
+     * @return int
+     */
     public static function interval2hours(DateInterval $interval) : int
     {
         return ConvertHelper_DateInterval::toHours($interval);
     }
     
-   /**
-    * Converts an interval to its total amount of minutes. 
-    * @param DateInterval $interval
-    * @return int
-    */
+    /**
+     * Converts an interval to its total amount of minutes. 
+     * @param DateInterval $interval
+     * @return int
+     */
     public static function interval2minutes(DateInterval $interval) : int
     {
         return ConvertHelper_DateInterval::toMinutes($interval);
     }
     
-   /**
-    * Converts an interval to its total amount of seconds.
-    * @param DateInterval $interval
-    * @return int
-    */    
+    /**
+     * Converts an interval to its total amount of seconds.
+     * @param DateInterval $interval
+     * @return int
+     */    
     public static function interval2seconds(DateInterval $interval) : int
     {
         return ConvertHelper_DateInterval::toSeconds($interval);
     }
     
-   /**
-    * Calculates the total amount of days / hours / minutes or seconds
-    * of a date interval object (depending on the specified units), and
-    * returns the total amount.
-    * 
-    * @param DateInterval $interval
-    * @param string $unit What total value to calculate.
-    * @return integer
-    * 
-    * @see ConvertHelper::INTERVAL_SECONDS
-    * @see ConvertHelper::INTERVAL_MINUTES
-    * @see ConvertHelper::INTERVAL_HOURS
-    * @see ConvertHelper::INTERVAL_DAYS
-    */
+    /**
+     * Calculates the total amount of days / hours / minutes or seconds
+     * of a date interval object (depending on the specified units), and
+     * returns the total amount.
+     * 
+     * @param DateInterval $interval
+     * @param string $unit What total value to calculate.
+     * @return integer
+     * 
+     * @see ConvertHelper::INTERVAL_SECONDS
+     * @see ConvertHelper::INTERVAL_MINUTES
+     * @see ConvertHelper::INTERVAL_HOURS
+     * @see ConvertHelper::INTERVAL_DAYS
+     */
     public static function interval2total(DateInterval $interval, string $unit=self::INTERVAL_SECONDS) : int
     {
         return ConvertHelper_DateInterval::toTotal($interval, $unit);
     }
 
-   /**
-    * Converts a date to the corresponding day name.
-    * 
-    * @param DateTime $date
-    * @param bool $short
-    * @return string|NULL
-    */
+    /**
+     * Converts a date to the corresponding day name.
+     * 
+     * @param DateTime $date
+     * @param bool $short
+     * @return string|NULL
+     */
     public static function date2dayName(DateTime $date, bool $short=false) : ?string
     {
         return ConvertHelper_Date::toDayName($date, $short);
     }
     
-   /**
-    * Retrieves a list of english day names.
-    * @return string[]
-    */
+    /**
+     * Retrieves a list of english day names.
+     * @return string[]
+     */
     public static function getDayNamesInvariant() : array
     {
         return ConvertHelper_Date::getDayNamesInvariant();
     }
     
-   /**
-    * Retrieves the day names list for the current locale.
-    * 
-    * @param bool $short
-    * @return string[]
-    */
+    /**
+     * Retrieves the day names list for the current locale.
+     * 
+     * @param bool $short
+     * @return string[]
+     */
     public static function getDayNames(bool $short=false) : array
     {
         return ConvertHelper_Date::getDayNames($short);
@@ -941,16 +941,16 @@ 
         return ConvertHelper_Array::implodeWithAnd($list, $sep, $conjunction);
     }
     
-   /**
-    * Splits a string into an array of all characters it is composed of.
-    * Unicode character safe.
-    * 
-    * NOTE: Spaces and newlines (both \r and \n) are also considered single
-    * characters.
-    * 
-    * @param string $string
-    * @return string[]
-    */
+    /**
+     * Splits a string into an array of all characters it is composed of.
+     * Unicode character safe.
+     * 
+     * NOTE: Spaces and newlines (both \r and \n) are also considered single
+     * characters.
+     * 
+     * @param string $string
+     * @return string[]
+     */
     public static function string2array(string $string) : array
     {
         return ConvertHelper_String::toArray($string);
@@ -961,53 +961,53 @@ 
         return new WordSplitter($string);
     }
     
-   /**
-    * Checks whether the specified string contains HTML code.
-    * 
-    * @param string $string
-    * @return boolean
-    */
+    /**
+     * Checks whether the specified string contains HTML code.
+     * 
+     * @param string $string
+     * @return boolean
+     */
     public static function isStringHTML(string $string) : bool
     {
         return ConvertHelper_String::isHTML($string);
     }
     
-   /**
-    * UTF8-safe wordwrap method: works like the regular wordwrap
-    * PHP function but compatible with UTF8. Otherwise the lengths
-    * are not calculated correctly.
-    * 
-    * @param string $str
-    * @param int $width
-    * @param string $break
-    * @param bool $cut
-    * @return string
-    */
+    /**
+     * UTF8-safe wordwrap method: works like the regular wordwrap
+     * PHP function but compatible with UTF8. Otherwise the lengths
+     * are not calculated correctly.
+     * 
+     * @param string $str
+     * @param int $width
+     * @param string $break
+     * @param bool $cut
+     * @return string
+     */
     public static function wordwrap(string $str, int $width = 75, string $break = "\n", bool $cut = false) : string 
     {
         return ConvertHelper_String::wordwrap($str, $width, $break, $cut);
     }
     
-   /**
-    * Calculates the byte length of a string, taking into 
-    * account any unicode characters.
-    * 
-    * @param string $string
-    * @return int
-    */
+    /**
+     * Calculates the byte length of a string, taking into 
+     * account any unicode characters.
+     * 
+     * @param string $string
+     * @return int
+     */
     public static function string2bytes(string $string): int
     {
         return ConvertHelper_String::toBytes($string);
     }
     
-   /**
-    * Creates a short, 8-character long hash for the specified string.
-    * 
-    * WARNING: Not cryptographically safe.
-    * 
-    * @param string $string
-    * @return string
-    */
+    /**
+     * Creates a short, 8-character long hash for the specified string.
+     * 
+     * WARNING: Not cryptographically safe.
+     * 
+     * @param string $string
+     * @return string
+     */
     public static function string2shortHash(string $string) : string
     {
         return ConvertHelper_String::toShortHash($string);
@@ -1053,88 +1053,88 @@ 
         return ConvertHelper_ThrowableInfo::fromThrowable($e);
     }
     
-   /**
-    * Parses the specified query string like the native 
-    * function <code>parse_str</code>, without the key
-    * naming limitations.
-    * 
-    * Using parse_str, dots or spaces in key names are 
-    * replaced by underscores. This method keeps all names
-    * intact.
-    * 
-    * It still uses the parse_str implementation as it 
-    * is tested and tried, but fixes the parameter names
-    * after parsing, as needed.
-    * 
-    * @param string $queryString
-    * @return array<string,string>
-    * @see ConvertHelper_QueryParser
-    */
+    /**
+     * Parses the specified query string like the native 
+     * function <code>parse_str</code>, without the key
+     * naming limitations.
+     * 
+     * Using parse_str, dots or spaces in key names are 
+     * replaced by underscores. This method keeps all names
+     * intact.
+     * 
+     * It still uses the parse_str implementation as it 
+     * is tested and tried, but fixes the parameter names
+     * after parsing, as needed.
+     * 
+     * @param string $queryString
+     * @return array<string,string>
+     * @see ConvertHelper_QueryParser
+     */
     public static function parseQueryString(string $queryString) : array
     {
         $parser = new ConvertHelper_QueryParser();
         return $parser->parse($queryString);
     }
 
-   /**
-    * Searches for needle in the specified string, and returns a list
-    * of all occurrences, including the matched string. The matched 
-    * string is useful when doing a case-insensitive search, as it
-    * shows the exact matched case of needle.
-    *   
-    * @param string $needle
-    * @param string $haystack
-    * @param bool $caseInsensitive
-    * @return ConvertHelper_StringMatch[]
-    */
+    /**
+     * Searches for needle in the specified string, and returns a list
+     * of all occurrences, including the matched string. The matched 
+     * string is useful when doing a case-insensitive search, as it
+     * shows the exact matched case of needle.
+     *   
+     * @param string $needle
+     * @param string $haystack
+     * @param bool $caseInsensitive
+     * @return ConvertHelper_StringMatch[]
+     */
     public static function findString(string $needle, string $haystack, bool $caseInsensitive=false): array
     {
         return ConvertHelper_String::findString($needle, $haystack, $caseInsensitive);
     }
     
-   /**
-    * Like explode, but trims all entries, and removes 
-    * empty entries from the resulting array.
-    * 
-    * @param string $delimiter
-    * @param string $string
-    * @return string[]
-    */
+    /**
+     * Like explode, but trims all entries, and removes 
+     * empty entries from the resulting array.
+     * 
+     * @param string $delimiter
+     * @param string $string
+     * @return string[]
+     */
     public static function explodeTrim(string $delimiter, string $string) : array
     {
         return ConvertHelper_String::explodeTrim($delimiter, $string);
     }
     
-   /**
-    * Detects the most used end-of-line character in the subject string.
-    * 
-    * @param string $subjectString The string to check.
-    * @return NULL|ConvertHelper_EOL The detected EOL instance, or NULL if none has been detected.
-    */
+    /**
+     * Detects the most used end-of-line character in the subject string.
+     * 
+     * @param string $subjectString The string to check.
+     * @return NULL|ConvertHelper_EOL The detected EOL instance, or NULL if none has been detected.
+     */
     public static function detectEOLCharacter(string $subjectString) : ?ConvertHelper_EOL
     {
         return ConvertHelper_EOL::detect($subjectString);
     }
 
-   /**
-    * Removes the specified keys from the target array,
-    * if they exist.
-    * 
-    * @param array<string|int,mixed> $array
-    * @param string[] $keys
-    */
+    /**
+     * Removes the specified keys from the target array,
+     * if they exist.
+     * 
+     * @param array<string|int,mixed> $array
+     * @param string[] $keys
+     */
     public static function arrayRemoveKeys(array &$array, array $keys) : void
     {
         ConvertHelper_Array::removeKeys($array, $keys);
     }
     
-   /**
-    * Checks if the specified variable is an integer or a string containing an integer.
-    * Accepts both positive and negative integers.
-    * 
-    * @param mixed $value
-    * @return bool
-    */
+    /**
+     * Checks if the specified variable is an integer or a string containing an integer.
+     * Accepts both positive and negative integers.
+     * 
+     * @param mixed $value
+     * @return bool
+     */
     public static function isInteger($value) : bool
     {
         if(is_int($value)) {
@@ -1154,52 +1154,52 @@ 
         return false;    
     }
     
-   /**
-    * Converts an amount of seconds to a DateInterval object.
-    * 
-    * @param int $seconds
-    * @return DateInterval
-    * @throws ConvertHelper_Exception If the date interval cannot be created.
-    * 
-    * @see ConvertHelper::ERROR_CANNOT_GET_DATE_DIFF
-    */
+    /**
+     * Converts an amount of seconds to a DateInterval object.
+     * 
+     * @param int $seconds
+     * @return DateInterval
+     * @throws ConvertHelper_Exception If the date interval cannot be created.
+     * 
+     * @see ConvertHelper::ERROR_CANNOT_GET_DATE_DIFF
+     */
     public static function seconds2interval(int $seconds) : DateInterval
     {
         return ConvertHelper_DateInterval::fromSeconds($seconds)->getInterval();
     }
     
-   /**
-    * Converts a size string like "50 MB" to the corresponding byte size.
-    * It is case-insensitive, ignores spaces, and supports both traditional
-    * "MB" and "MiB" notations.
-    * 
-    * @param string $size
-    * @return int
-    */
+    /**
+     * Converts a size string like "50 MB" to the corresponding byte size.
+     * It is case-insensitive, ignores spaces, and supports both traditional
+     * "MB" and "MiB" notations.
+     * 
+     * @param string $size
+     * @return int
+     */
     public static function size2bytes(string $size) : int
     {
         return self::parseSize($size)->toBytes();
     }
     
-   /**
-    * Parses a size string like "50 MB" and returns a size notation instance
-    * that has utility methods to access information on it, and convert it.
-    * 
-    * @param string $size
-    * @return ConvertHelper_SizeNotation
-    */
+    /**
+     * Parses a size string like "50 MB" and returns a size notation instance
+     * that has utility methods to access information on it, and convert it.
+     * 
+     * @param string $size
+     * @return ConvertHelper_SizeNotation
+     */
     public static function parseSize(string $size) : ConvertHelper_SizeNotation
     {
         return new ConvertHelper_SizeNotation($size);
     }
     
-   /**
-    * Creates a URL finder instance, which can be used to find
-    * URLs in a string - be it plain text, or HTML.
-    * 
-    * @param string $subject
-    * @return ConvertHelper_URLFinder
-    */
+    /**
+     * Creates a URL finder instance, which can be used to find
+     * URLs in a string - be it plain text, or HTML.
+     * 
+     * @param string $subject
+     * @return ConvertHelper_URLFinder
+     */
     public static function createURLFinder(string $subject) : ConvertHelper_URLFinder
     {
         return new ConvertHelper_URLFinder($subject);

src/Highlighter.php

Indentation +64 added lines, -64 removed lines

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