Mistralys / application-utils

src/Request.php

Indentation +142 added lines, -142 removed lines

@@ -39,9 +39,9 @@ 
      */
     protected static $instance;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $baseURL = '';
     
     public function __construct()
@@ -51,10 +51,10 @@ 
         $this->init();
     }
     
-   /**
-    * Can be extended in a subclass, to avoid
-    * redefining the constructor.
-    */
+    /**
+     * Can be extended in a subclass, to avoid
+     * redefining the constructor.
+     */
     protected function init()
     {
         
@@ -126,30 +126,30 @@ 
         return $this->buildURL($params, $dispatcher);
     }
     
-   /**
-    * Retrieves the name of the current dispatcher script / page.
-    * This is made to be extended and implemented in a subclass.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the name of the current dispatcher script / page.
+     * This is made to be extended and implemented in a subclass.
+     * 
+     * @return string
+     */
     public function getDispatcher() : string
     {
         return '';
     }
     
-   /**
-    * Filters and retrieves the current request variables 
-    * to be used to build an URL to refresh the current page.
-    * 
-    * For further customization options, use the 
-    * {@see Request::createRefreshParams()} method.
-    * 
-    * @param array<string,mixed> $params Key => value pairs of parameters to always include in the result.
-    * @param string[] $exclude Names of parameters to exclude from the result.
-    * @return array<string,mixed>
-    * 
-    * @see Request::createRefreshParams()
-    */
+    /**
+     * Filters and retrieves the current request variables 
+     * to be used to build an URL to refresh the current page.
+     * 
+     * For further customization options, use the 
+     * {@see Request::createRefreshParams()} method.
+     * 
+     * @param array<string,mixed> $params Key => value pairs of parameters to always include in the result.
+     * @param string[] $exclude Names of parameters to exclude from the result.
+     * @return array<string,mixed>
+     * 
+     * @see Request::createRefreshParams()
+     */
     public function getRefreshParams(array $params = array(), array $exclude = array())
     {
         return $this->createRefreshParams()
@@ -158,13 +158,13 @@ 
         ->getParams();
     }
     
-   /**
-    * Creates an instance of the helper that can be used to
-    * retrieve the request's parameters collection, with the
-    * possiblity to exlude and override some by rules.
-    * 
-    * @return Request_RefreshParams
-    */
+    /**
+     * Creates an instance of the helper that can be used to
+     * retrieve the request's parameters collection, with the
+     * possiblity to exlude and override some by rules.
+     * 
+     * @return Request_RefreshParams
+     */
     public function createRefreshParams() : Request_RefreshParams
     {
         return new Request_RefreshParams();
@@ -197,10 +197,10 @@ 
         return $url;
     }
     
-   /**
-    * Retrieves the base URL of the application.
-    * @return string
-    */
+    /**
+     * Retrieves the base URL of the application.
+     * @return string
+     */
     public function getBaseURL() : string
     {
         return $this->baseURL;
@@ -230,13 +230,13 @@ 
         return $this->knownParams[$name];
     }
     
-   /**
-    * Retrieves a previously registered parameter instance.
-    * 
-    * @param string $name
-    * @throws Request_Exception
-    * @return Request_Param
-    */
+    /**
+     * Retrieves a previously registered parameter instance.
+     * 
+     * @param string $name
+     * @throws Request_Exception
+     * @return Request_Param
+     */
     public function getRegisteredParam(string $name) : Request_Param
     {
         if(isset($this->knownParams[$name])) {
@@ -253,48 +253,48 @@ 
         );
     }
     
-   /**
-    * Checks whether a parameter with the specified name 
-    * has been registered.
-    * 
-    * @param string $name
-    * @return bool
-    */
+    /**
+     * Checks whether a parameter with the specified name 
+     * has been registered.
+     * 
+     * @param string $name
+     * @return bool
+     */
     public function hasRegisteredParam(string $name) : bool
     {
         return isset($this->knownParams[$name]);
     }
     
-   /**
-    * Retrieves an indexed array with accept mime types
-    * that the client sent, in the order of preference
-    * the client specified.
-    *
-    * Example:
-    *
-    * array(
-    *     'text/html',
-    *     'application/xhtml+xml',
-    *     'image/webp'
-    *     ...
-    * )
-    * 
-    * @return array
-    * @see Request::parseAcceptHeaders()
-    */
+    /**
+     * Retrieves an indexed array with accept mime types
+     * that the client sent, in the order of preference
+     * the client specified.
+     *
+     * Example:
+     *
+     * array(
+     *     'text/html',
+     *     'application/xhtml+xml',
+     *     'image/webp'
+     *     ...
+     * )
+     * 
+     * @return array
+     * @see Request::parseAcceptHeaders()
+     */
     public static function getAcceptHeaders() : array
     {
         return self::parseAcceptHeaders()->getMimeStrings();
     }
     
-   /**
-    * Returns an instance of the accept headers parser,
-    * to access information on the browser's accepted
-    * mime types.
-    *  
-    * @return Request_AcceptHeaders
-    * @see Request::getAcceptHeaders()
-    */
+    /**
+     * Returns an instance of the accept headers parser,
+     * to access information on the browser's accepted
+     * mime types.
+     *  
+     * @return Request_AcceptHeaders
+     * @see Request::getAcceptHeaders()
+     */
     public static function parseAcceptHeaders() : Request_AcceptHeaders
     {
         static $accept;
@@ -342,14 +342,14 @@ 
         return false;
     }
     
-   /**
-    * Removes a single parameter from the request.
-    * If the parameter has been registered, also
-    * removes the registration info.
-    * 
-    * @param string $name
-    * @return Request
-    */
+    /**
+     * Removes a single parameter from the request.
+     * If the parameter has been registered, also
+     * removes the registration info.
+     * 
+     * @param string $name
+     * @return Request
+     */
     public function removeParam(string $name) : Request
     {
         if(isset($_REQUEST[$name])) {
@@ -363,12 +363,12 @@ 
         return $this;
     }
     
-   /**
-    * Removes several parameters from the request.
-    * 
-    * @param string[] $names
-    * @return Request
-    */
+    /**
+     * Removes several parameters from the request.
+     * 
+     * @param string[] $names
+     * @return Request
+     */
     public function removeParams(array $names) : Request
     {
         foreach($names as $name) {
@@ -435,18 +435,18 @@ 
         return $val;
     }
     
-   /**
-    * Treats the request parameter as a JSON string, and
-    * if it exists and contains valid JSON, returns the
-    * decoded JSON value as an array (default).
-    *
-    * @param string $name
-    * @param bool $assoc
-    * @return array|object
-    * 
-    * @see Request::getJSONAssoc()
-    * @see Request::getJSONObject()
-    */
+    /**
+     * Treats the request parameter as a JSON string, and
+     * if it exists and contains valid JSON, returns the
+     * decoded JSON value as an array (default).
+     *
+     * @param string $name
+     * @param bool $assoc
+     * @return array|object
+     * 
+     * @see Request::getJSONAssoc()
+     * @see Request::getJSONObject()
+     */
     public function getJSON(string $name, bool $assoc=true)
     {
         $value = $this->getParam($name);
@@ -471,13 +471,13 @@ 
         return new \stdClass();
     }
     
-   /**
-    * Like {@link Request::getJSON()}, but omitting the second
-    * parameter. Use this for more readable code.
-    * 
-    * @param string $name
-    * @return array
-    */
+    /**
+     * Like {@link Request::getJSON()}, but omitting the second
+     * parameter. Use this for more readable code.
+     * 
+     * @param string $name
+     * @return array
+     */
     public function getJSONAssoc(string $name) : array
     {
         $result = $this->getJSON($name);
@@ -488,13 +488,13 @@ 
         return array();
     }
     
-   /**
-    * Like {@link Request::getJSON()}, but omitting the second
-    * parameter. Use this for more readable code.
-    *
-    * @param string $name
-    * @return object
-    */
+    /**
+     * Like {@link Request::getJSON()}, but omitting the second
+     * parameter. Use this for more readable code.
+     *
+     * @param string $name
+     * @return object
+     */
     public function getJSONObject(string $name) : object
     {
         $result = $this->getJSON($name, false);
@@ -505,12 +505,12 @@ 
         return new \stdClass();
     }
     
-   /**
-    * Sends a JSON response with the correct headers.
-    *
-    * @param array|string $data
-    * @param bool $exit Whether to exit the script afterwards.
-    */
+    /**
+     * Sends a JSON response with the correct headers.
+     *
+     * @param array|string $data
+     * @param bool $exit Whether to exit the script afterwards.
+     */
     public static function sendJSON($data, bool $exit=true)
     {
         $payload = $data;
@@ -530,12 +530,12 @@ 
         }
     }
     
-   /**
-    * Sends HTML to the browser with the correct headers.
-    * 
-    * @param string $html
-    * @param bool $exit Whether to exit the script afterwards.
-    */
+    /**
+     * Sends HTML to the browser with the correct headers.
+     * 
+     * @param string $html
+     * @param bool $exit Whether to exit the script afterwards.
+     */
     public static function sendHTML(string $html, bool $exit=true)
     {
         header('Cache-Control: no-cache, must-revalidate');
@@ -550,16 +550,16 @@ 
         }
     }
     
-   /**
-    * Creates a new instance of the URL comparer, which can check 
-    * whether the specified URLs match, regardless of the order in 
-    * which the query parameters are, if any.
-    * 
-    * @param string $sourceURL
-    * @param string $targetURL
-    * @param array $limitParams Whether to limit the comparison to these specific parameter names (if present)
-    * @return Request_URLComparer
-    */
+    /**
+     * Creates a new instance of the URL comparer, which can check 
+     * whether the specified URLs match, regardless of the order in 
+     * which the query parameters are, if any.
+     * 
+     * @param string $sourceURL
+     * @param string $targetURL
+     * @param array $limitParams Whether to limit the comparison to these specific parameter names (if present)
+     * @return Request_URLComparer
+     */
     public function createURLComparer(string $sourceURL, string $targetURL, array $limitParams=array()) : Request_URLComparer
     {
         $comparer = new Request_URLComparer($this, $sourceURL, $targetURL);
@@ -568,10 +568,10 @@ 
         return $comparer;
     }
     
-   /**
-    * Retrieves the full URL that was used to access the current page.
-    * @return string
-    */
+    /**
+     * Retrieves the full URL that was used to access the current page.
+     * @return string
+     */
     public function getCurrentURL() : string
     {
         return $_SERVER['HTTP_HOST'].$_SERVER['REQUEST_URI'];

Spacing +31 added lines, -31 removed lines

@@ -90,11 +90,11 @@ 
     public function getParam($name, $default = null)
     {
         $value = $default;
-        if(isset($_REQUEST[$name])) {
+        if (isset($_REQUEST[$name])) {
             $value = $_REQUEST[$name];
         }
         
-        if(isset($this->knownParams[$name])) {
+        if (isset($this->knownParams[$name])) {
             $value = $this->knownParams[$name]->validate($value);
         }
         
@@ -185,13 +185,13 @@ 
      * @param string $dispatcher Relative path to script to use for the URL. Append trailing slash if needed.
      * @return string
      */
-    public function buildURL($params = array(), string $dispatcher='')
+    public function buildURL($params = array(), string $dispatcher = '')
     {
-        $url = rtrim($this->getBaseURL(), '/') . '/' . $dispatcher;
+        $url = rtrim($this->getBaseURL(), '/').'/'.$dispatcher;
         
         // append any leftover parameters to the end of the URL
         if (!empty($params)) {
-            $url .= '?' . http_build_query($params, '', '&');
+            $url .= '?'.http_build_query($params, '', '&');
         }
         
         return $url;
@@ -222,7 +222,7 @@ 
      */
     public function registerParam($name)
     {
-        if(!isset($this->knownParams[$name])) {
+        if (!isset($this->knownParams[$name])) {
             $param = new Request_Param($this, $name);
             $this->knownParams[$name] = $param;
         }
@@ -239,7 +239,7 @@ 
     */
     public function getRegisteredParam(string $name) : Request_Param
     {
-        if(isset($this->knownParams[$name])) {
+        if (isset($this->knownParams[$name])) {
             return $this->knownParams[$name];
         }
         
@@ -299,7 +299,7 @@ 
     {
         static $accept;
         
-        if(!isset($accept)) {
+        if (!isset($accept)) {
             $accept = new Request_AcceptHeaders();
         }
         
@@ -318,7 +318,7 @@ 
     {
         $_REQUEST[$name] = $value;
         
-        if(isset($this->knownParams[$name])) {
+        if (isset($this->knownParams[$name])) {
             unset($this->knownParams[$name]);
         }
         
@@ -352,11 +352,11 @@ 
     */
     public function removeParam(string $name) : Request
     {
-        if(isset($_REQUEST[$name])) {
+        if (isset($_REQUEST[$name])) {
             unset($_REQUEST[$name]);
         }
         
-        if(isset($this->knownParams[$name])) {
+        if (isset($this->knownParams[$name])) {
             unset($this->knownParams[$name]);
         }
         
@@ -371,7 +371,7 @@ 
     */
     public function removeParams(array $names) : Request
     {
-        foreach($names as $name) {
+        foreach ($names as $name) {
             $this->removeParam($name);
         }
         
@@ -387,10 +387,10 @@ 
      * @param string $name
      * @return bool
      */
-    public function getBool($name, $default=false)
+    public function getBool($name, $default = false)
     {
         $value = $this->getParam($name, $default);
-        if(ConvertHelper::isBoolean($value)) {
+        if (ConvertHelper::isBoolean($value)) {
             return ConvertHelper::string2bool($value);
         }
         
@@ -399,11 +399,11 @@ 
     
     public function validate()
     {
-        foreach($this->knownParams as $param) 
+        foreach ($this->knownParams as $param) 
         {
             $name = $param->getName();
             
-            if($param->isRequired() && !$this->hasParam($name)) 
+            if ($param->isRequired() && !$this->hasParam($name)) 
             {
                 throw new Request_Exception(
                     'Missing request parameter '.$name,
@@ -425,10 +425,10 @@ 
      * @param mixed $default
      * @return string
      */
-    public function getFilteredParam($name, $default=null)
+    public function getFilteredParam($name, $default = null)
     {
         $val = $this->getParam($name, $default);
-        if(is_string($val)) {
+        if (is_string($val)) {
             $val = htmlspecialchars(trim(strip_tags($val)), ENT_QUOTES, 'UTF-8');
         }
         
@@ -447,24 +447,24 @@ 
     * @see Request::getJSONAssoc()
     * @see Request::getJSONObject()
     */
-    public function getJSON(string $name, bool $assoc=true)
+    public function getJSON(string $name, bool $assoc = true)
     {
         $value = $this->getParam($name);
         
-        if(!empty($value) && is_string($value)) 
+        if (!empty($value) && is_string($value)) 
         {
             $data = json_decode($value, $assoc);
             
-            if($assoc && is_array($data)) {
+            if ($assoc && is_array($data)) {
                 return $data;
             }
             
-            if(is_object($data)) {
+            if (is_object($data)) {
                 return $data;
             }
         }
         
-        if($assoc) {
+        if ($assoc) {
             return array();
         }
         
@@ -481,7 +481,7 @@ 
     public function getJSONAssoc(string $name) : array
     {
         $result = $this->getJSON($name);
-        if(is_array($result)) {
+        if (is_array($result)) {
             return $result;
         }
         
@@ -498,7 +498,7 @@ 
     public function getJSONObject(string $name) : object
     {
         $result = $this->getJSON($name, false);
-        if(is_object($result)) {
+        if (is_object($result)) {
             return $result;
         }
         
@@ -511,10 +511,10 @@ 
     * @param array|string $data
     * @param bool $exit Whether to exit the script afterwards.
     */
-    public static function sendJSON($data, bool $exit=true)
+    public static function sendJSON($data, bool $exit = true)
     {
         $payload = $data;
-        if(!is_string($payload)) {
+        if (!is_string($payload)) {
             $payload = json_encode($payload);
         }
         
@@ -524,7 +524,7 @@ 
         
         echo $payload;
         
-        if($exit) 
+        if ($exit) 
         {
             exit;
         }
@@ -536,7 +536,7 @@ 
     * @param string $html
     * @param bool $exit Whether to exit the script afterwards.
     */
-    public static function sendHTML(string $html, bool $exit=true)
+    public static function sendHTML(string $html, bool $exit = true)
     {
         header('Cache-Control: no-cache, must-revalidate');
         header('Expires: Mon, 26 Jul 1997 05:00:00 GMT');
@@ -544,7 +544,7 @@ 
         
         echo $html;
         
-        if($exit)
+        if ($exit)
         {
             exit;
         }
@@ -560,7 +560,7 @@ 
     * @param array $limitParams Whether to limit the comparison to these specific parameter names (if present)
     * @return Request_URLComparer
     */
-    public function createURLComparer(string $sourceURL, string $targetURL, array $limitParams=array()) : Request_URLComparer
+    public function createURLComparer(string $sourceURL, string $targetURL, array $limitParams = array()) : Request_URLComparer
     {
         $comparer = new Request_URLComparer($this, $sourceURL, $targetURL);
         $comparer->addLimitParams($limitParams);

src/Request/RefreshParams/Exclude/Name.php

Indentation +3 added lines, -3 removed lines

@@ -19,9 +19,9 @@
  */
 class Request_RefreshParams_Exclude_Name extends Request_RefreshParams_Exclude
 {
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $name;
     
     public function __construct(string $paramName)

src/Request/RefreshParams/Exclude/Callback.php

Indentation +3 added lines, -3 removed lines

@@ -22,9 +22,9 @@
 {
     const ERROR_INVALID_CALLBACK = 62101;
     
-   /**
-    * @var callable
-    */
+    /**
+     * @var callable
+     */
     private $callback;
     
     public function __construct($callback)

Spacing +1 added lines, -1 removed lines

@@ -29,7 +29,7 @@
     
     public function __construct($callback)
     {
-        if(!is_callable($callback))
+        if (!is_callable($callback))
         {
             throw new Request_Exception(
                 'Invalid exclusion callback',

src/Request/RefreshParams.php

Indentation +96 added lines, -96 removed lines

@@ -23,14 +23,14 @@ 
 {
     use Traits_Optionable;
     
-   /**
-    * @var array<string,mixed>
-    */
+    /**
+     * @var array<string,mixed>
+     */
     private $overrides = array();
     
-   /**
-    * @var Request_RefreshParams_Exclude[]
-    */
+    /**
+     * @var Request_RefreshParams_Exclude[]
+     */
     private $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);
@@ -78,20 +78,20 @@ 
         return $this;
     }
     
-   /**
-    * Exclude a request using a callback function.
-    * 
-    * The function gets two parameters:
-    * 
-    * - The name of the request parameter
-    * - The value of the request parameter
-    * 
-    * If the callback returns a boolean true, the
-    * parameter will be excluded.
-    * 
-    * @param callable $callback
-    * @return Request_RefreshParams
-    */
+    /**
+     * Exclude a request using a callback function.
+     * 
+     * The function gets two parameters:
+     * 
+     * - The name of the request parameter
+     * - The value of the request parameter
+     * 
+     * If the callback returns a boolean true, the
+     * parameter will be excluded.
+     * 
+     * @param callable $callback
+     * @return Request_RefreshParams
+     */
     public function excludeParamByCallback($callback) : Request_RefreshParams
     {
         $this->excludes[] = new Request_RefreshParams_Exclude_Callback($callback);
@@ -99,12 +99,12 @@ 
         return $this;
     }
     
-   /**
-    * Excludes a request parameter by name.
-    * 
-    * @param array $paramNames
-    * @return Request_RefreshParams
-    */
+    /**
+     * Excludes a request parameter by name.
+     * 
+     * @param array $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 $params
-    * @return Request_RefreshParams
-    */
+    /**
+     * Overrides an array of parameters. 
+     * 
+     * @param array $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();

Spacing +11 added lines, -11 removed lines

@@ -48,7 +48,7 @@ 
     * @param bool $exclude
     * @return Request_RefreshParams
     */
-    public function setExcludeSessionName(bool $exclude=true) : Request_RefreshParams
+    public function setExcludeSessionName(bool $exclude = true) : Request_RefreshParams
     {
         $this->setOption('exclude-session-name', $exclude);
         return $this;
@@ -70,7 +70,7 @@ 
     
     public function excludeParamByName(string $paramName) : Request_RefreshParams
     {
-        if($paramName !== '')
+        if ($paramName !== '')
         {
             $this->excludes[] = new Request_RefreshParams_Exclude_Name($paramName);
         }
@@ -107,7 +107,7 @@ 
     */
     public function excludeParamsByName(array $paramNames) : Request_RefreshParams
     {
-        foreach($paramNames as $name)
+        foreach ($paramNames as $name)
         {
             $this->excludeParamByName((string)$name);
         }
@@ -139,7 +139,7 @@ 
     */
     public function overrideParams(array $params) : Request_RefreshParams
     {
-        foreach($params as $name => $value)
+        foreach ($params as $name => $value)
         {
             $this->overrideParam((string)$name, $value);
         }
@@ -173,7 +173,7 @@ 
     */
     private function autoExcludeSessionName(array &$excludes) : void
     {
-        if($this->getBoolOption('exclude-session-name'))
+        if ($this->getBoolOption('exclude-session-name'))
         {
             $excludes[] = new Request_RefreshParams_Exclude_Name(session_name());
         }
@@ -187,7 +187,7 @@ 
     */
     private function autoExcludeQuickform(array &$excludes) : void
     {
-        if($this->getBoolOption('exclude-quickform-submitter'))
+        if ($this->getBoolOption('exclude-quickform-submitter'))
         {
             $excludes[] = new Request_RefreshParams_Exclude_Callback(function(string $paramName)
             {
@@ -209,7 +209,7 @@ 
         // Note: using this loop instead of array_merge,
         // because array_merge has weird behavior when
         // using numeric keys.
-        foreach($this->overrides as $name => $val)
+        foreach ($this->overrides as $name => $val)
         {
             $params[$name] = $val;
         }
@@ -227,11 +227,11 @@ 
     {
         $result = array();
         
-        foreach($params as $name => $value)
+        foreach ($params as $name => $value)
         {
             $name = (string)$name;
             
-            if(!$this->isExcluded($name, $value))
+            if (!$this->isExcluded($name, $value))
             {
                 $result[$name] = $value;
             }
@@ -252,9 +252,9 @@ 
     {
         $excludes = $this->resolveExcludes();
         
-        foreach($excludes as $exclude)
+        foreach ($excludes as $exclude)
         {
-            if($exclude->isExcluded($paramName, $paramValue))
+            if ($exclude->isExcluded($paramName, $paramValue))
             {
                 return true;
             }

src/RequestHelper.php

Spacing +12 added lines, -12 removed lines

@@ -241,7 +241,7 @@ 
 
         $output = curl_exec($ch);
 
-        if(isset($this->logfilePointer))
+        if (isset($this->logfilePointer))
         {
             fclose($this->logfilePointer);
         }
@@ -253,7 +253,7 @@ 
         // CURL will complain about an empty response when the 
         // server sends a 100-continue code. That should not be
         // regarded as an error.
-        if($output === false && $this->response->getCode() !== 100)
+        if ($output === false && $this->response->getCode() !== 100)
         {
             $curlCode = curl_errno($ch);
             
@@ -289,7 +289,7 @@ 
     {
         $ch = curl_init();
         
-        if(!is_resource($ch))
+        if (!is_resource($ch))
         {
             throw new RequestHelper_Exception(
                 'Could not initialize a new cURL instance.',
@@ -299,7 +299,7 @@ 
         }
 
         $this->setHeader('Content-Length', (string)$this->boundaries->getContentLength());
-        $this->setHeader('Content-Type', 'multipart/form-data; boundary=' . $this->mimeBoundary);
+        $this->setHeader('Content-Type', 'multipart/form-data; boundary='.$this->mimeBoundary);
 
         curl_setopt($ch, CURLOPT_POST, true);
         curl_setopt($ch, CURLOPT_URL, $url->getNormalizedWithoutAuth());
@@ -312,18 +312,18 @@ 
         
         $loggingEnabled = $this->configureLogging($ch);
         
-        if(!$loggingEnabled) 
+        if (!$loggingEnabled) 
         {
             curl_setopt($ch, CURLINFO_HEADER_OUT, true);
         }
         
-        if($this->verifySSL)
+        if ($this->verifySSL)
         {
             curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
             curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
         }
         
-        if($url->hasUsername())
+        if ($url->hasUsername())
         {
             curl_setopt($ch, CURLOPT_USERNAME, $url->getUsername());
             curl_setopt($ch, CURLOPT_PASSWORD, $url->getPassword());
@@ -338,14 +338,14 @@ 
     */
     protected function configureLogging($ch) : bool
     {
-        if(empty($this->logfile))
+        if (empty($this->logfile))
         {
             return false;
         }
         
         $res = fopen($this->logfile, 'w+');
         
-        if($res === false)
+        if ($res === false)
         {
             throw new RequestHelper_Exception(
                 'Cannot open logfile for writing.',
@@ -375,7 +375,7 @@ 
         
         $this->setHeader('Expect', '');
         
-        foreach($this->headers as $name => $value) {
+        foreach ($this->headers as $name => $value) {
             $result[] = $name.': '.$value;
         }
         
@@ -392,7 +392,7 @@ 
     {
         $response = $this->getResponse();
         
-        if($response !== null) {
+        if ($response !== null) {
             return $response->getHeaders();
         }
 
@@ -428,7 +428,7 @@ 
     */
     public function getHeader(string $name) : string
     {
-        if(isset($this->headers[$name]))
+        if (isset($this->headers[$name]))
         {
             return $this->headers[$name];
         }

Braces +1 added lines, -2 removed lines

@@ -261,8 +261,7 @@
                 $curlCode,
                 curl_error($ch).' | Explanation: '.curl_strerror($curlCode)
             );
-        }
-        else
+        } else
         {
             $this->response->setBody((string)$output);
         }

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();

Spacing +14 added lines, -14 removed lines

@@ -243,7 +243,7 @@ 
 
         if (!empty($text)) {
             $fragment = $this->dom->createDocumentFragment();
-            if(!@$fragment->appendXML($text)) {
+            if (!@$fragment->appendXML($text)) {
                 throw new XMLHelper_Exception(
                     'Cannot append XML fragment',
                     sprintf(
@@ -285,7 +285,7 @@ 
     * @param array<string,mixed> $attributes
     * @return DOMNode
     */
-    public function createRoot(string $name, array $attributes=array())
+    public function createRoot(string $name, array $attributes = array())
     {
         $root = $this->dom->appendChild($this->dom->createElement($name));
         $this->addAttributes($root, $attributes);
@@ -311,8 +311,8 @@ 
         $string = str_replace('&lt;', 'LT_ESCAPE', $string);
         $string = str_replace('&gt;', 'GT_ESCAPE', $string);
 
-        $string = str_replace('&nbsp;',' ',  $string);
-        $string = str_replace('&','&amp;',  $string);
+        $string = str_replace('&nbsp;', ' ', $string);
+        $string = str_replace('&', '&amp;', $string);
 
         return $string;
     }
@@ -331,9 +331,9 @@ 
     */
     public static function downloadXML(string $xml, string $filename = 'download.xml') : void
     {
-        if(!headers_sent() && !self::$simulation) 
+        if (!headers_sent() && !self::$simulation) 
         {
-            header('Content-Disposition: attachment; filename="' . $filename . '"');
+            header('Content-Disposition: attachment; filename="'.$filename.'"');
         }
         
         echo $xml;
@@ -347,12 +347,12 @@ 
     */
     public static function displayXML(string $xml) : void
     {
-        if(!headers_sent() && !self::$simulation) 
+        if (!headers_sent() && !self::$simulation) 
         {
             header('Content-Type:text/xml; charset=utf-8');
         }
         
-        if(self::$simulation) 
+        if (self::$simulation) 
         {
             $xml = '<pre>'.htmlspecialchars($xml).'</pre>';
         }
@@ -370,16 +370,16 @@ 
      * @param array<string,string> $customInfo Associative array with name => value pairs for custom tags to add to the output xml
      * @see buildErrorXML()
      */
-    public static function displayErrorXML($code, string $message, string $title, array $customInfo=array())
+    public static function displayErrorXML($code, string $message, string $title, array $customInfo = array())
     {
-        if(!headers_sent() && !self::$simulation) {
-            header('HTTP/1.1 400 Bad Request: ' . $title, true, 400);
+        if (!headers_sent() && !self::$simulation) {
+            header('HTTP/1.1 400 Bad Request: '.$title, true, 400);
         }
 
         self::displayXML(self::buildErrorXML($code, $message, $title, $customInfo));
     }
     
-    public static function setSimulation(bool $simulate=true) : void
+    public static function setSimulation(bool $simulate = true) : void
     {
         self::$simulation = $simulate;
     }
@@ -428,7 +428,7 @@ 
     * @param array<string,string> $customInfo
     * @return string
     */
-    public static function buildErrorXML($code, string $message, string $title, array $customInfo=array())
+    public static function buildErrorXML($code, string $message, string $title, array $customInfo = array())
     {
         $xml = new DOMDocument('1.0', 'UTF-8');
         $xml->formatOutput = true;
@@ -442,7 +442,7 @@ 
         $helper->addTextTag($root, 'title', $title);
         $helper->addTextTag($root, 'request_uri', $_SERVER['REQUEST_URI']);
         
-        foreach($customInfo as $name => $value) {
+        foreach ($customInfo as $name => $value) {
             $helper->addTextTag($root, $name, $value);
         }
 

src/Highlighter.php

Spacing +5 added lines, -5 removed lines

@@ -108,7 +108,7 @@ 
     */
     public static function json($subject) : string
     {
-        if(!is_string($subject))
+        if (!is_string($subject))
         {
             $subject = json_encode($subject, JSON_PRETTY_PRINT);
         }
@@ -125,9 +125,9 @@ 
     * @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
+    public static function xml(string $xml, bool $formatSource = false) : string
     {
-        if($formatSource)
+        if ($formatSource)
         {
             $dom = new DOMDocument();
             $dom->preserveWhiteSpace = false;
@@ -148,9 +148,9 @@ 
     * @param bool $formatSource
     * @return string
     */
-    public static function html(string $html, bool $formatSource=false) : string
+    public static function html(string $html, bool $formatSource = false) : string
     {
-        if($formatSource)
+        if ($formatSource)
         {
             $dom = new DOMDocument();
             $dom->preserveWhiteSpace = false;

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<int|string,mixed>|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<int|string,mixed>|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;

Spacing +10 added lines, -10 removed lines

@@ -48,7 +48,7 @@ 
     */
     private function initUnits() : void
     {
-        if(isset(self::$units))
+        if (isset(self::$units))
         {
             return;
         }
@@ -90,12 +90,12 @@ 
     public function toString() : string
     {
         // specifically handle zero
-        if($this->seconds <= 0) 
+        if ($this->seconds <= 0) 
         {
-            return '0 ' . t('seconds');
+            return '0 '.t('seconds');
         }
         
-        if($this->seconds < 1) 
+        if ($this->seconds < 1) 
         {
             return t('less than a second');
         }
@@ -104,12 +104,12 @@ 
 
         $last = array_pop($tokens);
         
-        if(empty($tokens)) 
+        if (empty($tokens)) 
         {
             return $last;
         }
         
-        return implode(', ', $tokens) . ' ' . t('and') . ' ' . $last;
+        return implode(', ', $tokens).' '.t('and').' '.$last;
     }
     
    /**
@@ -122,18 +122,18 @@ 
         $seconds = $this->seconds;
         $tokens = array();
         
-        foreach(self::$units as $def)
+        foreach (self::$units as $def)
         {
             $unitValue = intval($seconds / $def['value']);
             
-            if($unitValue <= 0)
+            if ($unitValue <= 0)
             {
                 continue;
             }
             
-            $item = strval($unitValue) . ' ';
+            $item = strval($unitValue).' ';
             
-            if(abs($unitValue) > 1)
+            if (abs($unitValue) > 1)
             {
                 $item .= $def['plural'];
             }

Braces +1 added lines, -2 removed lines

@@ -136,8 +136,7 @@
             if(abs($unitValue) > 1)
             {
                 $item .= $def['plural'];
-            }
-            else
+            } else
             {
                 $item .= $def['singular'];
             }

src/FileHelper.php

Braces +3 added lines, -6 removed lines

@@ -191,8 +191,7 @@ 
             if ($item->isDir()) 
             {
                 FileHelper::copyTree($itemPath, $target . '/' . $baseName);
-            } 
-            else if($item->isFile()) 
+            } else if($item->isFile()) 
             {
                 self::copyFile($itemPath, $target . '/' . $baseName);
             }
@@ -225,8 +224,7 @@ 
         if(!file_exists($targetFolder))
         {
             self::createFolder($targetFolder);
-        }
-        else if(!is_writable($targetFolder)) 
+        } else if(!is_writable($targetFolder)) 
         {
             throw new FileHelper_Exception(
                 sprintf('Target folder [%s] is not writable.', basename($targetFolder)),
@@ -715,8 +713,7 @@ 
         if(isset($options['relative-path']) && $options['relative-path'] === true) 
         {
             $finder->setPathmodeRelative();
-        } 
-        else if(isset($options['absolute-path']) && $options['absolute-path'] === true)
+        } else if(isset($options['absolute-path']) && $options['absolute-path'] === true)
         {
             $finder->setPathmodeAbsolute();
         }

Indentation +329 added lines, -329 removed lines

@@ -60,31 +60,31 @@ 
     protected static $utfBoms;
 
     /**
-    * Opens a serialized file and returns the unserialized data.
-    * 
-    * @param string $file
-    * @throws FileHelper_Exception
-    * @return array<int|string,mixed>
-    * @deprecated Use parseSerializedFile() instead.
-    * @see FileHelper::parseSerializedFile()
-    */
+     * Opens a serialized file and returns the unserialized data.
+     * 
+     * @param string $file
+     * @throws FileHelper_Exception
+     * @return array<int|string,mixed>
+     * @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<int|string,mixed>
-    * @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<int|string,mixed>
+     * @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) : array
     {
         self::requireFileExists($file);
@@ -160,13 +160,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(string $path) : void
     {
         if(is_dir($path) || mkdir($path, 0777, true)) {
@@ -213,22 +213,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);
@@ -268,15 +268,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)) {
@@ -298,15 +298,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 = ';'; }
@@ -319,21 +319,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<int,array<string,string>>
-    * @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<int,array<string,string>>
+     * @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);
@@ -521,27 +521,27 @@ 
         );
     }
     
-   /**
-    * 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) : bool
     {
-    	return self::getExtension($pathOrDirIterator) === 'php';
+        return self::getExtension($pathOrDirIterator) === 'php';
     }
     
-   /**
-    * 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) {
@@ -552,38 +552,38 @@ 
          
         $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) : string
     {
         $path = strval($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); 
     }
 
     /**
@@ -624,16 +624,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);
@@ -715,20 +715,20 @@ 
         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 string[] $extensions
-    * @param array<string,mixed> $options
-    * @throws FileHelper_Exception
-    * @return string[]
-    * @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 string[] $extensions
+     * @param array<string,mixed> $options
+     * @throws FileHelper_Exception
+     * @return string[]
+     * @see FileHelper::createFileFinder()
+     */
     public static function findFiles(string $targetFolder, array $extensions=array(), array $options=array()) : array
     {
         $finder = self::createFileFinder($targetFolder);
@@ -758,14 +758,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
@@ -833,13 +833,13 @@ 
         return null;
     }
 
-   /**
-    * Retrieves a list of all UTF byte order mark character
-    * sequences, as an associative array with UTF encoding => bom sequence
-    * pairs.
-    * 
-    * @return array<string,string>
-    */
+    /**
+     * Retrieves a list of all UTF byte order mark character
+     * sequences, as an associative array with UTF encoding => bom sequence
+     * pairs.
+     * 
+     * @return array<string,string>
+     */
     public static function getUTFBOMs() : array
     {
         if(!isset(self::$utfBoms)) {
@@ -855,15 +855,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();
@@ -882,40 +882,40 @@ 
         return in_array($encoding, $keep);
     }
     
-   /**
-    * Retrieves a list of all known unicode file encodings.
-    * @return string[]
-    */
+    /**
+     * Retrieves a list of all known unicode file encodings.
+     * @return string[]
+     */
     public static function getKnownUnicodeEncodings() : array
     {
         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) : void
     {
         $options = null;
@@ -939,18 +939,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);
@@ -1134,14 +1134,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(string $path) : ?DateTime
     {
         $time = filemtime($path);
@@ -1154,25 +1154,25 @@ 
         return $date;
     }
     
-   /**
-    * Retrieves the names of all sub-folders in the specified path.
-    * 
-    * Available options:
-    * 
-    * - recursive: true/false
-    *   Whether to search for sub-folders recursively.
-    *   
-    * - absolute-paths: true/false
-    *   Whether to return a list of absolute paths.
-    * 
-    * @param string|DirectoryIterator $targetFolder
-    * @param array<string,mixed> $options
-    * @throws FileHelper_Exception
-    * @return string[]
-    *
-    * @see FileHelper::ERROR_FIND_SUBFOLDERS_FOLDER_DOES_NOT_EXIST
-    * @todo Move this to a separate class.
-    */
+    /**
+     * Retrieves the names of all sub-folders in the specified path.
+     * 
+     * Available options:
+     * 
+     * - recursive: true/false
+     *   Whether to search for sub-folders recursively.
+     *   
+     * - absolute-paths: true/false
+     *   Whether to return a list of absolute paths.
+     * 
+     * @param string|DirectoryIterator $targetFolder
+     * @param array<string,mixed> $options
+     * @throws FileHelper_Exception
+     * @return string[]
+     *
+     * @see FileHelper::ERROR_FIND_SUBFOLDERS_FOLDER_DOES_NOT_EXIST
+     * @todo Move this to a separate class.
+     */
     public static function getSubfolders($targetFolder, array $options = array())
     {
         if($targetFolder instanceof DirectoryIterator) {
@@ -1237,16 +1237,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;
@@ -1284,16 +1284,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);
@@ -1331,23 +1331,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);
@@ -1359,17 +1359,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);
@@ -1413,18 +1413,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);
@@ -1440,19 +1440,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);
@@ -1482,26 +1482,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.
@@ -1579,16 +1579,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);
@@ -1609,18 +1609,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);

Spacing +105 added lines, -105 removed lines

@@ -91,7 +91,7 @@ 
         
         $contents = file_get_contents($file);
         
-        if($contents === false) 
+        if ($contents === false) 
         {
             throw new FileHelper_Exception(
                 'Cannot load serialized content from file.',
@@ -105,7 +105,7 @@ 
         
         $result = @unserialize($contents);
         
-        if($result !== false) {
+        if ($result !== false) {
             return $result;
         }
         
@@ -128,7 +128,7 @@ 
      */
     public static function deleteTree(string $rootFolder) : bool
     {
-        if(!file_exists($rootFolder)) {
+        if (!file_exists($rootFolder)) {
             return true;
         }
         
@@ -169,7 +169,7 @@ 
     */
     public static function createFolder(string $path) : void
     {
-        if(is_dir($path) || mkdir($path, 0777, true)) {
+        if (is_dir($path) || mkdir($path, 0777, true)) {
             return;
         }
         
@@ -204,11 +204,11 @@ 
 
             if ($item->isDir()) 
             {
-                FileHelper::copyTree($itemPath, $target . '/' . $baseName);
+                FileHelper::copyTree($itemPath, $target.'/'.$baseName);
             } 
-            else if($item->isFile()) 
+            else if ($item->isFile()) 
             {
-                self::copyFile($itemPath, $target . '/' . $baseName);
+                self::copyFile($itemPath, $target.'/'.$baseName);
             }
         }
     }
@@ -236,11 +236,11 @@ 
         
         $targetFolder = dirname($targetPath);
         
-        if(!file_exists($targetFolder))
+        if (!file_exists($targetFolder))
         {
             self::createFolder($targetFolder);
         }
-        else if(!is_writable($targetFolder)) 
+        else if (!is_writable($targetFolder)) 
         {
             throw new FileHelper_Exception(
                 sprintf('Target folder [%s] is not writable.', basename($targetFolder)),
@@ -252,7 +252,7 @@ 
             );
         }
         
-        if(copy($sourcePath, $targetPath)) {
+        if (copy($sourcePath, $targetPath)) {
             return;
         }
         
@@ -279,11 +279,11 @@ 
     */
     public static function deleteFile(string $filePath) : void
     {
-        if(!file_exists($filePath)) {
+        if (!file_exists($filePath)) {
             return;
         }
         
-        if(unlink($filePath)) {
+        if (unlink($filePath)) {
             return;
         }
         
@@ -307,10 +307,10 @@ 
     * @return Csv
      * @see CSVHelper::createParser()
     */
-    public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : Csv
+    public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : Csv
     {
-        if($delimiter==='') { $delimiter = ';'; }
-        if($enclosure==='') { $enclosure = '"'; }
+        if ($delimiter === '') { $delimiter = ';'; }
+        if ($enclosure === '') { $enclosure = '"'; }
 
         $parser = CSVHelper::createParser($delimiter);
         $parser->enclosure = $enclosure;
@@ -334,11 +334,11 @@ 
     * @see parseCSVFile()
     * @see FileHelper::ERROR_PARSING_CSV
     */
-    public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array
+    public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : array
     {
         $parser = self::createCSVParser($delimiter, $enclosure, '\\', $heading);
 
-        if($parser->parse($csv))
+        if ($parser->parse($csv))
         {
             return $parser->data;
         }
@@ -366,7 +366,7 @@ 
      * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
      * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS
      */
-    public static function parseCSVFile(string $filePath, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array
+    public static function parseCSVFile(string $filePath, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : array
     {
         $content = self::readContents($filePath);
 
@@ -383,7 +383,7 @@ 
     public static function detectMimeType(string $fileName) : ?string
     {
         $ext = self::getExtension($fileName);
-        if(empty($ext)) {
+        if (empty($ext)) {
             return null;
         }
 
@@ -423,11 +423,11 @@ 
      * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
      * @see FileHelper::ERROR_UNKNOWN_FILE_MIME_TYPE
      */
-    public static function sendFile(string $filePath, ?string $fileName = null, bool $asAttachment=true) : void
+    public static function sendFile(string $filePath, ?string $fileName = null, bool $asAttachment = true) : void
     {
         self::requireFileExists($filePath);
         
-        if(empty($fileName)) {
+        if (empty($fileName)) {
             $fileName = basename($filePath);
         }
 
@@ -445,10 +445,10 @@ 
         
         header("Cache-Control: public", true);
         header("Content-Description: File Transfer", true);
-        header("Content-Type: " . $mime, true);
+        header("Content-Type: ".$mime, true);
 
         $disposition = 'inline';
-        if($asAttachment) {
+        if ($asAttachment) {
             $disposition = 'attachment';
         }
         
@@ -474,7 +474,7 @@ 
     public static function downloadFile(string $url) : string
     {
         $ch = curl_init();
-        if(!is_resource($ch)) 
+        if (!is_resource($ch)) 
         {
             throw new FileHelper_Exception(
                 'Could not initialize a new cURL instance.',
@@ -495,7 +495,7 @@ 
         
         $output = curl_exec($ch);
 
-        if($output === false) {
+        if ($output === false) {
             throw new FileHelper_Exception(
                 'Unable to open URL',
                 sprintf(
@@ -509,7 +509,7 @@ 
 
         curl_close($ch);
 
-        if(is_string($output)) 
+        if (is_string($output)) 
         {
             return $output;
         }
@@ -544,14 +544,14 @@ 
     */
     public static function getExtension($pathOrDirIterator, bool $lowercase = true) : string
     {
-        if($pathOrDirIterator instanceof DirectoryIterator) {
+        if ($pathOrDirIterator instanceof DirectoryIterator) {
             $filename = $pathOrDirIterator->getFilename();
         } else {
             $filename = basename(strval($pathOrDirIterator));
         }
          
         $ext = pathinfo($filename, PATHINFO_EXTENSION);
-        if($lowercase) {
+        if ($lowercase) {
         	$ext = mb_strtolower($ext);
         }
         
@@ -573,13 +573,13 @@ 
     public static function getFilename($pathOrDirIterator, $extension = true) : string
     {
         $path = strval($pathOrDirIterator);
-    	if($pathOrDirIterator instanceof DirectoryIterator) {
+    	if ($pathOrDirIterator instanceof DirectoryIterator) {
     		$path = $pathOrDirIterator->getFilename();
     	}
     	
     	$path = self::normalizePath($path);
     	
-    	if(!$extension) {
+    	if (!$extension) {
     	    return pathinfo($path, PATHINFO_FILENAME);
     	}
     	
@@ -599,18 +599,18 @@ 
      * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE
      * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE
      */
-    public static function parseJSONFile(string $file, string $targetEncoding='', $sourceEncoding=null) : array
+    public static function parseJSONFile(string $file, string $targetEncoding = '', $sourceEncoding = null) : array
     {
         self::requireFileExists($file, self::ERROR_CANNOT_FIND_JSON_FILE);
         
         $content = self::readContents($file);
 
-        if(!empty($targetEncoding)) {
+        if (!empty($targetEncoding)) {
             $content = mb_convert_encoding($content, $targetEncoding, $sourceEncoding);
         }
         
         $json = json_decode($content, true);
-        if($json === false || $json === NULL) {
+        if ($json === false || $json === NULL) {
             throw new FileHelper_Exception(
                 'Cannot decode json data',
                 sprintf(
@@ -650,13 +650,13 @@ 
         
         $name = str_replace(array_keys($replaces), array_values($replaces), $name);
         
-        while(strstr($name, '  ')) {
+        while (strstr($name, '  ')) {
             $name = str_replace('  ', ' ', $name);
         }
 
         $name = str_replace(array_keys($replaces), array_values($replaces), $name);
         
-        while(strstr($name, '..')) {
+        while (strstr($name, '..')) {
             $name = str_replace('..', '.', $name);
         }
         
@@ -692,7 +692,7 @@ 
      * @throws FileHelper_Exception
      * @see FileHelper::createFileFinder()
      */
-    public static function findHTMLFiles(string $targetFolder, array $options=array()) : array
+    public static function findHTMLFiles(string $targetFolder, array $options = array()) : array
     {
         return self::findFiles($targetFolder, array('html'), $options);
     }
@@ -710,7 +710,7 @@ 
      * @throws FileHelper_Exception
      * @see FileHelper::createFileFinder()
      */
-    public static function findPHPFiles(string $targetFolder, array $options=array()) : array
+    public static function findPHPFiles(string $targetFolder, array $options = array()) : array
     {
         return self::findFiles($targetFolder, array('php'), $options);
     }
@@ -729,7 +729,7 @@ 
     * @return string[]
     * @see FileHelper::createFileFinder()
     */
-    public static function findFiles(string $targetFolder, array $extensions=array(), array $options=array()) : array
+    public static function findFiles(string $targetFolder, array $extensions = array(), array $options = array()) : array
     {
         $finder = self::createFileFinder($targetFolder);
 
@@ -739,16 +739,16 @@ 
 
         $finder->setPathmodeStrip();
         
-        if(isset($options['relative-path']) && $options['relative-path'] === true) 
+        if (isset($options['relative-path']) && $options['relative-path'] === true) 
         {
             $finder->setPathmodeRelative();
         } 
-        else if(isset($options['absolute-path']) && $options['absolute-path'] === true)
+        else if (isset($options['absolute-path']) && $options['absolute-path'] === true)
         {
             $finder->setPathmodeAbsolute();
         }
         
-        if(isset($options['strip-extension'])) 
+        if (isset($options['strip-extension'])) 
         {
             $finder->stripExtensions();
         }
@@ -766,12 +766,12 @@ 
     * @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
+    public static function removeExtension(string $filename, bool $keepPath = false) : string
     {
         // normalize paths to allow windows style slashes even on nix servers
         $filename = self::normalizePath($filename);
         
-        if(!$keepPath) 
+        if (!$keepPath) 
         {
             return pathinfo($filename, PATHINFO_FILENAME);
         }
@@ -807,7 +807,7 @@ 
     public static function detectUTFBom(string $filename) : ?string
     {
         $fp = fopen($filename, 'r');
-        if($fp === false) 
+        if ($fp === false) 
         {
             throw new FileHelper_Exception(
                 'Cannot open file for reading',
@@ -822,10 +822,10 @@ 
 
         $boms = self::getUTFBOMs();
         
-        foreach($boms as $bom => $value) 
+        foreach ($boms as $bom => $value) 
         {
             $length = mb_strlen($value);
-            if(mb_substr($text, 0, $length) == $value) {
+            if (mb_substr($text, 0, $length) == $value) {
                 return $bom;
             }
         }
@@ -842,13 +842,13 @@ 
     */
     public static function getUTFBOMs() : array
     {
-        if(!isset(self::$utfBoms)) {
+        if (!isset(self::$utfBoms)) {
             self::$utfBoms = array(
-                'UTF32-BE' => chr(0x00) . chr(0x00) . chr(0xFE) . chr(0xFF),
-                'UTF32-LE' => chr(0xFF) . chr(0xFE) . chr(0x00) . chr(0x00),
-                'UTF16-BE' => chr(0xFE) . chr(0xFF),
-                'UTF16-LE' => chr(0xFF) . chr(0xFE),
-                'UTF8' => chr(0xEF) . chr(0xBB) . chr(0xBF)
+                'UTF32-BE' => chr(0x00).chr(0x00).chr(0xFE).chr(0xFF),
+                'UTF32-LE' => chr(0xFF).chr(0xFE).chr(0x00).chr(0x00),
+                'UTF16-BE' => chr(0xFE).chr(0xFF),
+                'UTF16-LE' => chr(0xFF).chr(0xFE),
+                'UTF8' => chr(0xEF).chr(0xBB).chr(0xBF)
             );
         }
         
@@ -869,7 +869,7 @@ 
         $encodings = self::getKnownUnicodeEncodings();
 
         $keep = array();
-        foreach($encodings as $string) 
+        foreach ($encodings as $string) 
         {
             $withHyphen = str_replace('UTF', 'UTF-', $string);
             
@@ -916,16 +916,16 @@ 
     * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
     * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
     */
-    public static function saveAsJSON($data, string $file, bool $pretty=false) : void
+    public static function saveAsJSON($data, string $file, bool $pretty = false) : void
     {
         $options = null;
-        if($pretty) {
+        if ($pretty) {
             $options = JSON_PRETTY_PRINT;
         }
         
         $json = json_encode($data, $options);
         
-        if($json===false) 
+        if ($json === false) 
         {
             $errorCode = json_last_error();
             
@@ -951,14 +951,14 @@ 
     * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
     * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
     */
-    public static function saveFile(string $filePath, string $content='') : void
+    public static function saveFile(string $filePath, string $content = '') : void
     {
         $filePath = self::normalizePath($filePath);
         
         // target file already exists
-        if(file_exists($filePath))
+        if (file_exists($filePath))
         {
-            if(!is_writable($filePath))
+            if (!is_writable($filePath))
             {
                 throw new FileHelper_Exception(
                     sprintf('Cannot save file: target file [%s] exists, but is not writable.', basename($filePath)),
@@ -978,7 +978,7 @@ 
             // create the folder as needed
             self::createFolder($targetFolder);
             
-            if(!is_writable($targetFolder)) 
+            if (!is_writable($targetFolder)) 
             {
                 throw new FileHelper_Exception(
                     sprintf('Cannot save file: target folder [%s] is not writable.', basename($targetFolder)),
@@ -991,7 +991,7 @@ 
             }
         }
         
-        if(is_dir($filePath))
+        if (is_dir($filePath))
         {
             throw new FileHelper_Exception(
                 sprintf('Cannot save file: the target [%s] is a directory.', basename($filePath)),
@@ -1003,7 +1003,7 @@ 
             );
         }
         
-        if(file_put_contents($filePath, $content) !== false) {
+        if (file_put_contents($filePath, $content) !== false) {
             return;
         }
         
@@ -1042,7 +1042,7 @@ 
     {
         static $checked = array();
         
-        if(isset($checked[$command])) {
+        if (isset($checked[$command])) {
             return $checked[$command];
         }
         
@@ -1055,7 +1055,7 @@ 
         
         $os = strtolower(PHP_OS_FAMILY);
         
-        if(!isset($osCommands[$os])) 
+        if (!isset($osCommands[$os])) 
         {
             throw new FileHelper_Exception(
                 'Unsupported OS for CLI commands',
@@ -1081,7 +1081,7 @@ 
             $pipes
         );
         
-        if($process === false) {
+        if ($process === false) {
             $checked[$command] = false;
             return false;
         }
@@ -1113,7 +1113,7 @@ 
      */
     public static function checkPHPFileSyntax(string $path)
     {
-        if(!self::canMakePHPCalls()) {
+        if (!self::canMakePHPCalls()) {
             return true;
         }
         
@@ -1124,7 +1124,7 @@ 
         // when the validation is successful, the first entry
         // in the array contains the success message. When it
         // is invalid, the first entry is always empty.
-        if(!empty($output[0])) {
+        if (!empty($output[0])) {
             return true;
         }
         
@@ -1145,7 +1145,7 @@ 
     public static function getModifiedDate(string $path) : ?DateTime
     {
         $time = filemtime($path);
-        if($time === false) {
+        if ($time === false) {
             return null;
         }
 
@@ -1175,11 +1175,11 @@ 
     */
     public static function getSubfolders($targetFolder, array $options = array())
     {
-        if($targetFolder instanceof DirectoryIterator) {
+        if ($targetFolder instanceof DirectoryIterator) {
             $targetFolder = $targetFolder->getPathname();
         }
 
-        if(!is_dir($targetFolder)) 
+        if (!is_dir($targetFolder)) 
         {
             throw new FileHelper_Exception(
                 'Target folder does not exist',
@@ -1203,29 +1203,29 @@ 
         
         $d = new DirectoryIterator($targetFolder);
         
-        foreach($d as $item) 
+        foreach ($d as $item) 
         {
-            if($item->isDir() && !$item->isDot()) 
+            if ($item->isDir() && !$item->isDot()) 
             {
                 $name = $item->getFilename();
                 
-                if(!$options['absolute-path']) {
+                if (!$options['absolute-path']) {
                     $result[] = $name;
                 } else {
                     $result[] = $targetFolder.'/'.$name;
                 }
                 
-                if(!$options['recursive']) 
+                if (!$options['recursive']) 
                 {
                     continue;
                 }
                 
                 $subs = self::getSubfolders($targetFolder.'/'.$name, $options);
-                foreach($subs as $sub) 
+                foreach ($subs as $sub) 
                 {
                     $relative = $name.'/'.$sub;
                     
-                    if(!$options['absolute-path']) {
+                    if (!$options['absolute-path']) {
                         $result[] = $relative;
                     } else {
                         $result[] = $targetFolder.'/'.$relative;
@@ -1275,7 +1275,7 @@ 
         $unit = preg_replace('/[^bkmgtpezy]/i', '', $size); // Remove the non-unit characters from the size.
         $size = floatval(preg_replace('/[^0-9\.]/', '', $size)); // Remove the non-numeric characters from the size.
         
-        if($unit) 
+        if ($unit) 
         {
             // Find the position of the unit in the ordered string which is the power of magnitude to multiply a kilobyte by.
             return round($size * pow(1024, stripos('bkmgtpezy', $unit[0])));
@@ -1294,7 +1294,7 @@ 
     * @param int $depth The folder depth to reduce the path to
     * @return string
     */
-    public static function relativizePathByDepth(string $path, int $depth=2) : string
+    public static function relativizePathByDepth(string $path, int $depth = 2) : string
     {
         $path = self::normalizePath($path);
         
@@ -1302,17 +1302,17 @@ 
         $tokens = array_filter($tokens); // remove empty entries (trailing slash for example)
         $tokens = array_values($tokens); // re-index keys
         
-        if(empty($tokens)) {
+        if (empty($tokens)) {
             return '';
         }
         
         // remove the drive if present
-        if(strstr($tokens[0], ':')) {
+        if (strstr($tokens[0], ':')) {
             array_shift($tokens);
         }
         
         // path was only the drive
-        if(count($tokens) == 0) {
+        if (count($tokens) == 0) {
             return '';
         }
 
@@ -1321,8 +1321,8 @@ 
         
         // reduce the path to the specified depth
         $length = count($tokens);
-        if($length > $depth) {
-            $tokens = array_slice($tokens, $length-$depth);
+        if ($length > $depth) {
+            $tokens = array_slice($tokens, $length - $depth);
         }
 
         // append the last element again
@@ -1370,14 +1370,14 @@ 
     * 
     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
     */
-    public static function requireFileExists(string $path, ?int $errorCode=null) : string
+    public static function requireFileExists(string $path, ?int $errorCode = null) : string
     {
         $result = realpath($path);
-        if($result !== false) {
+        if ($result !== false) {
             return $result;
         }
         
-        if($errorCode === null) {
+        if ($errorCode === null) {
             $errorCode = self::ERROR_FILE_DOES_NOT_EXIST;
         }
         
@@ -1394,15 +1394,15 @@ 
      * @return string
      * @throws FileHelper_Exception
      */
-    public static function requireFileReadable(string $path, ?int $errorCode=null) : string
+    public static function requireFileReadable(string $path, ?int $errorCode = null) : string
     {
         $path = self::requireFileExists($path, $errorCode);
 
-        if(is_readable($path)) {
+        if (is_readable($path)) {
             return $path;
         }
 
-        if($errorCode === null) {
+        if ($errorCode === null) {
             $errorCode = self::ERROR_FILE_NOT_READABLE;
         }
 
@@ -1431,15 +1431,15 @@ 
         
         $file = new \SplFileObject($path);
         
-        if($file->eof()) {
+        if ($file->eof()) {
             return '';
         }
         
-        $targetLine = $lineNumber-1;
+        $targetLine = $lineNumber - 1;
         
         $file->seek($targetLine);
         
-        if($file->key() !== $targetLine) {
+        if ($file->key() !== $targetLine) {
              return null;
         }
         
@@ -1465,7 +1465,7 @@ 
         $number = $spl->key();
         
         // if seeking to the end the cursor is still at 0, there are no lines. 
-        if($number === 0) 
+        if ($number === 0) 
         {
             // since it's a very small file, to get reliable results,
             // we read its contents and use that to determine what
@@ -1473,13 +1473,13 @@ 
             // that this is not pactical to solve with the SplFileObject.
             $content = file_get_contents($path);
             
-            if(empty($content)) {
+            if (empty($content)) {
                 return 0;
             }
         }
         
         // return the line number we were able to reach + 1 (key is zero-based)
-        return $number+1;
+        return $number + 1;
     }
     
    /**
@@ -1527,13 +1527,13 @@ 
      * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
      * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES
      */
-    public static function readLines(string $filePath, int $amount=0) : array
+    public static function readLines(string $filePath, int $amount = 0) : array
     {
         self::requireFileExists($filePath);
         
         $fn = fopen($filePath, "r");
         
-        if($fn === false) 
+        if ($fn === false) 
         {
             throw new FileHelper_Exception(
                 'Could not open file for reading.',
@@ -1549,19 +1549,19 @@ 
         $counter = 0;
         $first = true;
         
-        while(!feof($fn)) 
+        while (!feof($fn)) 
         {
             $counter++;
             
             $line = fgets($fn);
             
             // can happen with zero length files
-            if($line === false) {
+            if ($line === false) {
                 continue;
             }
             
             // the first line may contain a unicode BOM marker.
-            if($first) 
+            if ($first) 
             {
                 $line = ConvertHelper::stripUTFBom($line);
                 $first = false;
@@ -1569,7 +1569,7 @@ 
             
             $result[] = $line;
             
-            if($amount > 0 && $counter == $amount) {
+            if ($amount > 0 && $counter == $amount) {
                 break;
             }
         }
@@ -1595,7 +1595,7 @@ 
         
         $result = file_get_contents($filePath);
         
-        if($result !== false) {
+        if ($result !== false) {
             return $result;
         }
         
@@ -1625,7 +1625,7 @@ 
     {
         $actual = realpath($path);
         
-        if($actual === false) 
+        if ($actual === false) 
         {
             throw new FileHelper_Exception(
                 'Folder does not exist',
@@ -1637,7 +1637,7 @@ 
             );
         }
         
-        if(is_dir($path)) 
+        if (is_dir($path)) 
         {
             return self::normalizePath($actual);
         }
@@ -1659,7 +1659,7 @@ 
      * @param string[] $paths
      * @return FileHelper_PathsReducer
      */
-    public static function createPathsReducer(array $paths=array()) : FileHelper_PathsReducer
+    public static function createPathsReducer(array $paths = array()) : FileHelper_PathsReducer
     {
         return new FileHelper_PathsReducer();
     }