Mistralys / application-utils

src/FileHelper/UnicodeHandling.php

Spacing +12 added lines, -12 removed lines

@@ -27,12 +27,12 @@ 
     /**
      * @var array<string,string>|NULL
      */
-    protected static ?array $utfBoms = null;
+    protected static ? array $utfBoms = null;
 
     /**
      * @var string[]|NULL
      */
-    protected static ?array $encodings = null;
+    protected static ? array $encodings = null;
 
     public function __construct()
     {
@@ -70,9 +70,9 @@ 
 
         fclose($fp);
 
-        foreach(self::$utfBoms as $bom => $value)
+        foreach (self::$utfBoms as $bom => $value)
         {
-            if(mb_strpos($text, $value) === 0)
+            if (mb_strpos($text, $value) === 0)
             {
                 return $bom;
             }
@@ -83,23 +83,23 @@ 
 
     private function initBOMs() : void
     {
-        if(isset(self::$utfBoms))
+        if (isset(self::$utfBoms))
         {
             return;
         }
 
         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)
         );
     }
 
     private function initEncodings() : void
     {
-        if(isset(self::$encodings))
+        if (isset(self::$encodings))
         {
             return;
         }
@@ -108,7 +108,7 @@ 
 
         self::$encodings = array();
 
-        foreach($encodings as $string)
+        foreach ($encodings as $string)
         {
             $withHyphen = str_replace('UTF', 'UTF-', $string);
 

src/FileHelper/FileInfo/FileSender.php

Spacing +3 added lines, -3 removed lines

@@ -35,7 +35,7 @@ 
         $this->file = $info;
     }
 
-    public function send(?string $fileName = null, bool $asAttachment=true) : void
+    public function send(?string $fileName = null, bool $asAttachment = true) : void
     {
         $this->file
             ->requireExists()
@@ -53,7 +53,7 @@ 
     {
         header("Cache-Control: public", true);
         header("Content-Description: File Transfer", true);
-        header("Content-Type: " . $this->detectMime(), true);
+        header("Content-Type: ".$this->detectMime(), true);
 
         header(sprintf(
             "Content-Disposition: %s; filename=%s",
@@ -69,7 +69,7 @@ 
 
     private function resolveDisposition(bool $asAttachment) : string
     {
-        if($asAttachment)
+        if ($asAttachment)
         {
             return 'attachment';
         }

src/FileHelper/FileInfo/LineReader.php

Spacing +12 added lines, -12 removed lines

@@ -47,15 +47,15 @@ 
 
         $file = new SplFileObject($this->file->getPath());
 
-        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;
         }
@@ -76,7 +76,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
@@ -84,13 +84,13 @@ 
             // that this is not practical 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;
     }
 
     /**
@@ -98,13 +98,13 @@ 
      * @return string[]
      * @throws FileHelper_Exception
      */
-    public function getLines(int $amount=0) : array
+    public function getLines(int $amount = 0) : array
     {
         $this->file->requireExists();
 
         $fn = fopen($this->file->getPath(), 'rb');
 
-        if($fn === false)
+        if ($fn === false)
         {
             throw new FileHelper_Exception(
                 'Could not open file for reading.',
@@ -120,19 +120,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;
@@ -140,7 +140,7 @@ 
 
             $result[] = $line;
 
-            if($amount > 0 && $counter === $amount) {
+            if ($amount > 0 && $counter === $amount) {
                 break;
             }
         }

src/FileHelper/FileInfo/NameFixer.php

Spacing +2 added lines, -2 removed lines

@@ -49,13 +49,13 @@
 
         $name = str_replace(array_keys($replaces), array_values($replaces), $name);
 
-        while(strpos($name, '  ') !== false) {
+        while (strpos($name, '  ') !== false) {
             $name = str_replace('  ', ' ', $name);
         }
 
         $name = str_replace(array_keys($replaces), array_values($replaces), $name);
 
-        while(strpos($name, '..') !== false) {
+        while (strpos($name, '..') !== false) {
             $name = str_replace('..', '.', $name);
         }
 

src/FileHelper/PathsReducer.php

Spacing +13 added lines, -13 removed lines

@@ -36,7 +36,7 @@ 
      * @param string[] $paths
      * @throws FileHelper_Exception
      */
-    public function __construct(array $paths=array())
+    public function __construct(array $paths = array())
     {
         $this->addPaths($paths);
     }
@@ -49,7 +49,7 @@ 
      */
     public function addPaths(array $paths) : PathsReducer
     {
-        foreach($paths as $path) {
+        foreach ($paths as $path) {
             $this->addPath($path);
         }
 
@@ -66,7 +66,7 @@ 
     {
         $path = FileHelper::normalizePath($path);
 
-        if(!in_array($path, $this->paths, true)) {
+        if (!in_array($path, $this->paths, true)) {
             $this->paths[] = $path;
         }
 
@@ -83,11 +83,11 @@ 
     {
         $split = $this->splitPaths();
 
-        if(empty($split)) {
+        if (empty($split)) {
             return array();
         }
 
-        while($this->shiftPart($split) === true) {}
+        while ($this->shiftPart($split) === true) {}
 
         return $this->joinPaths($split);
     }
@@ -101,7 +101,7 @@ 
         $result = array();
 
         foreach ($split as $entry) {
-            if(!empty($entry)) {
+            if (!empty($entry)) {
                 $result[] = implode('/', $entry);
             }
         }
@@ -118,22 +118,22 @@ 
         $current = null;
         $result = array();
 
-        foreach($split as $entry)
+        foreach ($split as $entry)
         {
-            if(empty($entry)) {
+            if (empty($entry)) {
                 return false;
             }
 
             $part = array_shift($entry);
-            if(empty($entry)) {
+            if (empty($entry)) {
                 return false;
             }
 
-            if($current === null) {
+            if ($current === null) {
                 $current = $part;
             }
 
-            if($part !== $current) {
+            if ($part !== $current) {
                 return false;
             }
 
@@ -152,9 +152,9 @@ 
     {
         $split = array();
 
-        foreach($this->paths as $path) {
+        foreach ($this->paths as $path) {
             $entry = ConvertHelper::explodeTrim('/', $path);
-            if(!empty($entry)) {
+            if (!empty($entry)) {
                 $split[] = $entry;
             }
         }

src/FileHelper/JSONFile.php

Spacing +2 added lines, -2 removed lines

@@ -124,7 +124,7 @@ 
 
     private function convertEncoding(string $contents) : string
     {
-        if(!empty($this->targetEncoding))
+        if (!empty($this->targetEncoding))
         {
             return mb_convert_encoding(
                 $contents,
@@ -146,7 +146,7 @@ 
     {
         $options = null;
 
-        if($pretty)
+        if ($pretty)
         {
             $options = JSON_PRETTY_PRINT;
         }

Braces +2 added lines, -4 removed lines

@@ -92,8 +92,7 @@ 
                 512,
                 JSON_THROW_ON_ERROR
             );
-        }
-        catch (JsonException $e)
+        } catch (JsonException $e)
         {
             throw new FileHelper_Exception(
                 'Cannot decode json data',
@@ -158,8 +157,7 @@ 
             $this->file->putContents($json);
 
             return $this;
-        }
-        catch (JsonException $e)
+        } catch (JsonException $e)
         {
             throw new FileHelper_Exception(
                 'An error occurred while encoding a data set to JSON.',

src/FileHelper/FileDownloader.php

Spacing +6 added lines, -6 removed lines

@@ -40,7 +40,7 @@ 
      */
     public function setTimeout(int $timeout) : FileDownloader
     {
-        if($timeout > 0)
+        if ($timeout > 0)
         {
             $this->timeout = $timeout;
         }
@@ -52,7 +52,7 @@ 
      * @param bool $enabled
      * @return FileDownloader
      */
-    public function setSSLEnabled(bool $enabled=true) : FileDownloader
+    public function setSSLEnabled(bool $enabled = true) : FileDownloader
     {
         $this->SSLEnabled = $enabled;
         return $this;
@@ -73,7 +73,7 @@ 
 
         $output = curl_exec($ch);
 
-        if($output === false)
+        if ($output === false)
         {
             throw new FileHelper_Exception(
                 'Unable to open URL',
@@ -88,7 +88,7 @@ 
 
         curl_close($ch);
 
-        if(is_string($output))
+        if (is_string($output))
         {
             return $output;
         }
@@ -108,7 +108,7 @@ 
     {
         $ch = curl_init();
 
-        if(!is_resource($ch))
+        if (!is_resource($ch))
         {
             throw new FileHelper_Exception(
                 'Could not initialize a new cURL instance.',
@@ -125,7 +125,7 @@ 
         curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
         curl_setopt($ch, CURLOPT_TIMEOUT, $this->timeout);
 
-        if(!$this->SSLEnabled)
+        if (!$this->SSLEnabled)
         {
             curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
             curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);

src/URLInfo.php

Indentation +194 added lines, -194 removed lines

@@ -37,42 +37,42 @@ 
     public const TYPE_PHONE = 'phone';
     public const TYPE_URL = 'url';
 
-   /**
-    * The original URL that was passed to the constructor.
-    * @var string
-    */
+    /**
+     * The original URL that was passed to the constructor.
+     * @var string
+     */
     protected string $rawURL;
 
-   /**
-    * @var array<string,mixed>
-    */
+    /**
+     * @var array<string,mixed>
+     */
     protected array $info;
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected array $excludedParams = array();
     
-   /**
-    * @var bool
-    * @see URLInfo::setParamExclusion()
-    */
+    /**
+     * @var bool
+     * @see URLInfo::setParamExclusion()
+     */
     protected bool $paramExclusion = false;
     
-   /**
-    * @var array<string,string>|NULL
-    * @see URLInfo::getTypeLabel()
-    */
+    /**
+     * @var array<string,string>|NULL
+     * @see URLInfo::getTypeLabel()
+     */
     protected static ?array $typeLabels = null;
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected bool $highlightExcluded = false;
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected array $infoKeys = array(
         'scheme',
         'host',
@@ -84,24 +84,24 @@ 
         'fragment'
     );
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected string $url;
     
-   /**
-    * @var URLInfo_Parser
-    */
+    /**
+     * @var URLInfo_Parser
+     */
     protected URLInfo_Parser $parser;
     
-   /**
-    * @var URLInfo_Normalizer|NULL
-    */
+    /**
+     * @var URLInfo_Normalizer|NULL
+     */
     protected ?URLInfo_Normalizer $normalizer = null;
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected bool $encodeUTFChars = false;
     
     public function __construct(string $url)
@@ -118,14 +118,14 @@ 
         $this->info = $this->parser->getInfo();
     }
 
-   /**
-    * Whether to URL encode any non-encoded UTF8 characters in the URL.
-    * Default is to leave them as-is for better readability, since 
-    * browsers handle this well.
-    * 
-    * @param bool $enabled
-    * @return URLInfo
-    */
+    /**
+     * Whether to URL encode any non-encoded UTF8 characters in the URL.
+     * Default is to leave them as-is for better readability, since 
+     * browsers handle this well.
+     * 
+     * @param bool $enabled
+     * @return URLInfo
+     */
     public function setUTFEncoding(bool $enabled=true) : URLInfo
     {
         if($this->encodeUTFChars !== $enabled)
@@ -142,13 +142,13 @@ 
         return $this->encodeUTFChars;
     }
     
-   /**
-    * Filters an URL: removes control characters and the
-    * like to have a clean URL to work with.
-    * 
-    * @param string $url
-    * @return string
-    */
+    /**
+     * Filters an URL: removes control characters and the
+     * like to have a clean URL to work with.
+     * 
+     * @param string $url
+     * @return string
+     */
     public static function filterURL(string $url)
     {
         return URLInfo_Filter::filter($url);
@@ -178,12 +178,12 @@ 
         return $this->info['type'] === self::TYPE_PHONE;
     }
     
-   /**
-    * Whether the URL is a regular URL, not one of the 
-    * other types like a phone number or email address.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether the URL is a regular URL, not one of the 
+     * other types like a phone number or email address.
+     * 
+     * @return bool
+     */
     public function isURL() : bool
     {
         $host = $this->getHost();
@@ -195,20 +195,20 @@ 
         return $this->parser->isValid();
     }
     
-   /**
-    * Retrieves the host name, or an empty string if none is present.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the host name, or an empty string if none is present.
+     * 
+     * @return string
+     */
     public function getHost() : string
     {
         return $this->getInfoKey('host');
     }
     
-   /**
-    * Retrieves the path, or an empty string if none is present.
-    * @return string
-    */
+    /**
+     * Retrieves the path, or an empty string if none is present.
+     * @return string
+     */
     public function getPath() : string
     {
         return $this->getInfoKey('path');
@@ -224,10 +224,10 @@ 
         return $this->getInfoKey('scheme');
     }
     
-   /**
-    * Retrieves the port specified in the URL, or -1 if none is preseent.
-    * @return int
-    */
+    /**
+     * Retrieves the port specified in the URL, or -1 if none is preseent.
+     * @return int
+     */
     public function getPort() : int
     {
         $port = $this->getInfoKey('port');
@@ -239,13 +239,13 @@ 
         return -1;
     }
     
-   /**
-    * Retrieves the raw query string, or an empty string if none is present.
-    * 
-    * @return string
-    * 
-    * @see URLInfo::getParams()
-    */
+    /**
+     * Retrieves the raw query string, or an empty string if none is present.
+     * 
+     * @return string
+     * 
+     * @see URLInfo::getParams()
+     */
     public function getQuery() : string
     {
         return $this->getInfoKey('query');
@@ -261,20 +261,20 @@ 
         return $this->getInfoKey('pass');
     }
     
-   /**
-    * Whether the URL contains a port number.
-    * @return bool
-    */
+    /**
+     * Whether the URL contains a port number.
+     * @return bool
+     */
     public function hasPort() : bool
     {
         return $this->getPort() !== -1;
     }
     
-   /**
-    * Alias for the hasParams() method.
-    * @return bool
-    * @see URLInfo::hasParams()
-    */
+    /**
+     * Alias for the hasParams() method.
+     * @return bool
+     * @see URLInfo::hasParams()
+     */
     public function hasQuery() : bool
     {
         return $this->hasParams();
@@ -319,23 +319,23 @@ 
         return '';
     }
 
-   /**
-    * Retrieves a normalized URL: this ensures that all parameters
-    * in the URL are always in the same order.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves a normalized URL: this ensures that all parameters
+     * in the URL are always in the same order.
+     * 
+     * @return string
+     */
     public function getNormalized() : string
     {
         return $this->normalize(true);
     }
     
-   /**
-    * Like getNormalized(), but if a username and password are present
-    * in the URL, returns the URL without them.
-    * 
-    * @return string
-    */
+    /**
+     * Like getNormalized(), but if a username and password are present
+     * in the URL, returns the URL without them.
+     * 
+     * @return string
+     */
     public function getNormalizedWithoutAuth() : string
     {
         return $this->normalize(false);
@@ -356,25 +356,25 @@ 
         return $this->normalizer->normalize();
     }
     
-   /**
-    * Creates a hash of the URL, which can be used for comparisons.
-    * Since any parameters in the URL's query are sorted alphabetically,
-    * the same links with a different parameter order will have the 
-    * same hash.
-    * 
-    * @return string
-    */
+    /**
+     * Creates a hash of the URL, which can be used for comparisons.
+     * Since any parameters in the URL's query are sorted alphabetically,
+     * the same links with a different parameter order will have the 
+     * same hash.
+     * 
+     * @return string
+     */
     public function getHash()
     {
         return \AppUtils\ConvertHelper::string2shortHash($this->getNormalized());
     }
 
-   /**
-    * Highlights the URL using HTML tags with specific highlighting
-    * class names.
-    * 
-    * @return string Will return an empty string if the URL is not valid.
-    */
+    /**
+     * Highlights the URL using HTML tags with specific highlighting
+     * class names.
+     * 
+     * @return string Will return an empty string if the URL is not valid.
+     */
     public function getHighlighted() : string
     {
         if(!$this->isValid()) {
@@ -408,15 +408,15 @@ 
         return count($params);
     }
     
-   /**
-    * Retrieves all parameters specified in the url,
-    * if any, as an associative array. 
-    * 
-    * NOTE: Ignores parameters that have been added
-    * to the excluded parameters list.
-    *
-    * @return array<string,string>
-    */
+    /**
+     * Retrieves all parameters specified in the url,
+     * if any, as an associative array. 
+     * 
+     * NOTE: Ignores parameters that have been added
+     * to the excluded parameters list.
+     *
+     * @return array<string,string>
+     */
     public function getParams() : array
     {
         if(!$this->paramExclusion || empty($this->excludedParams)) {
@@ -434,22 +434,22 @@ 
         return $keep;
     }
     
-   /**
-    * Retrieves the names of all parameters present in the URL, if any.
-    * @return string[]
-    */
+    /**
+     * Retrieves the names of all parameters present in the URL, if any.
+     * @return string[]
+     */
     public function getParamNames() : array
     {
         $params = $this->getParams();
         return array_keys($params);
     }
     
-   /**
-    * Retrieves a specific parameter value from the URL.
-    * 
-    * @param string $name
-    * @return string The parameter value, or an empty string if it does not exist.
-    */
+    /**
+     * Retrieves a specific parameter value from the URL.
+     * 
+     * @param string $name
+     * @return string The parameter value, or an empty string if it does not exist.
+     */
     public function getParam(string $name) : string
     {
         if(isset($this->info['params'][$name])) {
@@ -459,16 +459,16 @@ 
         return '';
     }
     
-   /**
-    * Excludes an URL parameter entirely if present:
-    * the parser will act as if the parameter was not
-    * even present in the source URL, effectively
-    * stripping it.
-    *
-    * @param string $name
-    * @param string $reason A human readable explanation why this is excluded - used when highlighting links.
-    * @return URLInfo
-    */
+    /**
+     * Excludes an URL parameter entirely if present:
+     * the parser will act as if the parameter was not
+     * even present in the source URL, effectively
+     * stripping it.
+     *
+     * @param string $name
+     * @param string $reason A human readable explanation why this is excluded - used when highlighting links.
+     * @return URLInfo
+     */
     public function excludeParam(string $name, string $reason='') : URLInfo
     {
         if(!isset($this->excludedParams[$name]))
@@ -521,14 +521,14 @@ 
         return self::$typeLabels[$this->getType()];
     }
 
-   /**
-    * Whether excluded parameters should be highlighted in
-    * a different color in the URL when using the
-    * {@link URLInfo::getHighlighted()} method.
-    *
-    * @param bool $highlight
-    * @return URLInfo
-    */
+    /**
+     * Whether excluded parameters should be highlighted in
+     * a different color in the URL when using the
+     * {@link URLInfo::getHighlighted()} method.
+     *
+     * @param bool $highlight
+     * @return URLInfo
+     */
     public function setHighlightExcluded(bool $highlight=true) : URLInfo
     {
         $this->highlightExcluded = $highlight;
@@ -584,24 +584,24 @@ 
         return $this;
     }
     
-   /**
-    * Whether the parameter exclusion mode is enabled:
-    * In this case, if any parameters have been added to the
-    * exclusion list, all relevant methods will exclude these.
-    *
-    * @return bool
-    */
+    /**
+     * Whether the parameter exclusion mode is enabled:
+     * In this case, if any parameters have been added to the
+     * exclusion list, all relevant methods will exclude these.
+     *
+     * @return bool
+     */
     public function isParamExclusionEnabled() : bool
     {
         return $this->paramExclusion;
     }
     
-   /**
-    * Checks whether the link contains any parameters that
-    * are on the list of excluded parameters.
-    *
-    * @return bool
-    */
+    /**
+     * Checks whether the link contains any parameters that
+     * are on the list of excluded parameters.
+     *
+     * @return bool
+     */
     public function containsExcludedParams() : bool
     {
         if(empty($this->excludedParams)) {
@@ -672,16 +672,16 @@ 
         return $this->highlightExcluded;
     }
     
-   /**
-    * Checks if the URL exists, i.e. can be connected to. Will return
-    * true if the returned HTTP status code is `200` or `302`.
-    * 
-    * NOTE: If the target URL requires HTTP authentication, the username
-    * and password should be integrated into the URL.
-    * 
-    * @return bool
-    * @throws BaseException
-    */
+    /**
+     * Checks if the URL exists, i.e. can be connected to. Will return
+     * true if the returned HTTP status code is `200` or `302`.
+     * 
+     * NOTE: If the target URL requires HTTP authentication, the username
+     * and password should be integrated into the URL.
+     * 
+     * @return bool
+     * @throws BaseException
+     */
     public function tryConnect(bool $verifySSL=true) : bool
     {
         return $this->createConnectionTester()
@@ -689,26 +689,26 @@ 
         ->canConnect();
     }
     
-   /**
-    * Creates the connection tester instance that is used
-    * to check if a URL can be connected to, and which is
-    * used in the {@see URLInfo::tryConnect()} method. It
-    * allows more settings to be used.
-    * 
-    * @return URLInfo_ConnectionTester
-    */
+    /**
+     * Creates the connection tester instance that is used
+     * to check if a URL can be connected to, and which is
+     * used in the {@see URLInfo::tryConnect()} method. It
+     * allows more settings to be used.
+     * 
+     * @return URLInfo_ConnectionTester
+     */
     public function createConnectionTester() : URLInfo_ConnectionTester
     {
         return new URLInfo_ConnectionTester($this);
     }
     
-   /**
-    * Adds/overwrites an URL parameter.
-    *  
-    * @param string $name
-    * @param string $val
-    * @return URLInfo
-    */
+    /**
+     * Adds/overwrites an URL parameter.
+     *  
+     * @param string $name
+     * @param string $val
+     * @return URLInfo
+     */
     public function setParam(string $name, string $val) : URLInfo
     {
         $this->info['params'][$name] = $val;
@@ -716,13 +716,13 @@ 
         return $this;
     }
     
-   /**
-    * Removes an URL parameter. Has no effect if the 
-    * parameter is not present to begin with.
-    * 
-    * @param string $param
-    * @return URLInfo
-    */
+    /**
+     * Removes an URL parameter. Has no effect if the 
+     * parameter is not present to begin with.
+     * 
+     * @param string $param
+     * @return URLInfo
+     */
     public function removeParam(string $param) : URLInfo
     {
         if(isset($this->info['params'][$param]))

Spacing +27 added lines, -27 removed lines

@@ -63,7 +63,7 @@ 
     * @var array<string,string>|NULL
     * @see URLInfo::getTypeLabel()
     */
-    protected static ?array $typeLabels = null;
+    protected static ? array $typeLabels = null;
     
    /**
     * @var bool
@@ -126,9 +126,9 @@ 
     * @param bool $enabled
     * @return URLInfo
     */
-    public function setUTFEncoding(bool $enabled=true) : URLInfo
+    public function setUTFEncoding(bool $enabled = true) : URLInfo
     {
-        if($this->encodeUTFChars !== $enabled)
+        if ($this->encodeUTFChars !== $enabled)
         {
             $this->encodeUTFChars = $enabled;
             $this->parse(); // re-parse the URL to apply the changes
@@ -232,7 +232,7 @@ 
     {
         $port = $this->getInfoKey('port');
         
-        if(!empty($port)) {
+        if (!empty($port)) {
             return (int)$port;
         }
         
@@ -312,7 +312,7 @@ 
     
     protected function getInfoKey(string $name) : string
     {
-        if(isset($this->info[$name])) {
+        if (isset($this->info[$name])) {
             return (string)$this->info[$name];
         }
         
@@ -341,13 +341,13 @@ 
         return $this->normalize(false);
     }
     
-    protected function normalize(bool $auth=true) : string
+    protected function normalize(bool $auth = true) : string
     {
-        if(!$this->isValid()) {
+        if (!$this->isValid()) {
             return '';
         }
         
-        if(!isset($this->normalizer)) {
+        if (!isset($this->normalizer)) {
             $this->normalizer = new URLInfo_Normalizer($this);
         }
         
@@ -377,7 +377,7 @@ 
     */
     public function getHighlighted() : string
     {
-        if(!$this->isValid()) {
+        if (!$this->isValid()) {
             return '';
         }
         
@@ -419,14 +419,14 @@ 
     */
     public function getParams() : array
     {
-        if(!$this->paramExclusion || empty($this->excludedParams)) {
+        if (!$this->paramExclusion || empty($this->excludedParams)) {
             return $this->info['params'];
         }
         
         $keep = array();
-        foreach($this->info['params'] as $name => $value) 
+        foreach ($this->info['params'] as $name => $value) 
         {
-            if(!isset($this->excludedParams[$name])) {
+            if (!isset($this->excludedParams[$name])) {
                 $keep[$name] = $value;
             }
         }
@@ -452,7 +452,7 @@ 
     */
     public function getParam(string $name) : string
     {
-        if(isset($this->info['params'][$name])) {
+        if (isset($this->info['params'][$name])) {
             return $this->info['params'][$name];
         }
         
@@ -469,9 +469,9 @@ 
     * @param string $reason A human readable explanation why this is excluded - used when highlighting links.
     * @return URLInfo
     */
-    public function excludeParam(string $name, string $reason='') : URLInfo
+    public function excludeParam(string $name, string $reason = '') : URLInfo
     {
-        if(!isset($this->excludedParams[$name]))
+        if (!isset($this->excludedParams[$name]))
         {
             $this->excludedParams[$name] = $reason;
             $this->setParamExclusion();
@@ -497,7 +497,7 @@ 
     
     public function getTypeLabel() : string
     {
-        if(!isset(self::$typeLabels))
+        if (!isset(self::$typeLabels))
         {
             self::$typeLabels = array(
                 self::TYPE_EMAIL => t('Email'),
@@ -509,7 +509,7 @@ 
         
         $type = $this->getType();
         
-        if(!isset(self::$typeLabels[$type]))
+        if (!isset(self::$typeLabels[$type]))
         {
             throw new BaseException(
                 sprintf('Unknown URL type label for type [%s].', $type),
@@ -529,7 +529,7 @@ 
     * @param bool $highlight
     * @return URLInfo
     */
-    public function setHighlightExcluded(bool $highlight=true) : URLInfo
+    public function setHighlightExcluded(bool $highlight = true) : URLInfo
     {
         $this->highlightExcluded = $highlight;
         return $this;
@@ -578,7 +578,7 @@ 
      * @see URLInfo::isParamExclusionEnabled()
      * @see URLInfo::setHighlightExcluded()
      */
-    public function setParamExclusion(bool $enabled=true) : URLInfo
+    public function setParamExclusion(bool $enabled = true) : URLInfo
     {
         $this->paramExclusion = $enabled;
         return $this;
@@ -604,13 +604,13 @@ 
     */
     public function containsExcludedParams() : bool
     {
-        if(empty($this->excludedParams)) {
+        if (empty($this->excludedParams)) {
             return false;
         }
         
         $names = array_keys($this->info['params']);
-        foreach($names as $name) {
-            if(isset($this->excludedParams[$name])) {
+        foreach ($names as $name) {
+            if (isset($this->excludedParams[$name])) {
                 return true;
             }
         }
@@ -626,7 +626,7 @@ 
 
     public function offsetSet($offset, $value) 
     {
-        if(in_array($offset, $this->infoKeys)) {
+        if (in_array($offset, $this->infoKeys)) {
             $this->info[$offset] = $value;
         }
     }
@@ -643,11 +643,11 @@ 
     
     public function offsetGet($offset)
     {
-        if($offset === 'port') {
+        if ($offset === 'port') {
             return $this->getPort();
         }
         
-        if(in_array($offset, $this->infoKeys)) {
+        if (in_array($offset, $this->infoKeys)) {
             return $this->getInfoKey($offset);
         }
         
@@ -682,7 +682,7 @@ 
     * @return bool
     * @throws BaseException
     */
-    public function tryConnect(bool $verifySSL=true) : bool
+    public function tryConnect(bool $verifySSL = true) : bool
     {
         return $this->createConnectionTester()
         ->setVerifySSL($verifySSL)
@@ -725,7 +725,7 @@ 
     */
     public function removeParam(string $param) : URLInfo
     {
-        if(isset($this->info['params'][$param]))
+        if (isset($this->info['params'][$param]))
         {
             unset($this->info['params'][$param]);
         }

src/FileHelper.php

Indentation +298 added lines, -298 removed lines

@@ -71,18 +71,18 @@ 
     public const ERROR_PATH_NOT_WRITABLE = 340039;
     public const ERROR_PATH_INVALID = 340040;
 
-   /**
-    * Opens a serialized file and returns the unserialized data.
-    *
-    * @param string $file
-    * @throws FileHelper_Exception
-    * @return array<int|string,mixed>
-    * @see SerializedFile::parse()
-    * 
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
-    * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ
-    * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED
-    */
+    /**
+     * Opens a serialized file and returns the unserialized data.
+     *
+     * @param string $file
+     * @throws FileHelper_Exception
+     * @return array<int|string,mixed>
+     * @see SerializedFile::parse()
+     * 
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
+     * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ
+     * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED
+     */
     public static function parseSerializedFile(string $file) : array
     {
         return SerializedFile::factory(self::getFileInfo($file))
@@ -101,13 +101,13 @@ 
         return FolderTree::delete($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
     {
         self::getFolderInfo($path)->create();
@@ -130,36 +130,36 @@ 
         FolderTree::copy($source, $target);
     }
     
-   /**
-    * Copies a file to the target location. Includes checks
-    * for most error sources, like the source file not being
-    * readable. Automatically creates the target folder if it
-    * does not exist yet.
-    * 
-    * @param string $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::getFileInfo($sourcePath)->copyTo($targetPath);
     }
     
-   /**
-    * 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
     {
         self::getFileInfo($filePath)->delete();
@@ -188,15 +188,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 = ';'; }
@@ -209,21 +209,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);
@@ -342,29 +342,29 @@ 
             ->download();
     }
     
-   /**
-    * 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.
-    *
-    * NOTE: A folder will return an empty string.
-    * 
-    * @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.
+     *
+     * NOTE: A folder will return an empty string.
+     * 
+     * @param string|DirectoryIterator $pathOrDirIterator
+     * @param bool $lowercase
+     * @return string
+     */
     public static function getExtension($pathOrDirIterator, bool $lowercase = true) : string
     {
         $info = self::getPathInfo($pathOrDirIterator);
@@ -377,18 +377,18 @@ 
         return '';
     }
     
-   /**
-    * 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, bool $extension = true) : string
     {
         $info = self::getPathInfo($pathOrDirIterator);
@@ -422,16 +422,16 @@ 
             ->parse();
     }
     
-   /**
-    * Corrects common formatting mistakes when users enter
-    * file names, like too many spaces, dots and the like.
-    * 
-    * NOTE: if the file name contains a path, the path is
-    * stripped, leaving only the file name.
-    * 
-    * @param string $name
-    * @return string
-    */
+    /**
+     * Corrects common formatting mistakes when users enter
+     * file names, like too many spaces, dots and the like.
+     * 
+     * NOTE: if the file name contains a path, the path is
+     * stripped, leaving only the file name.
+     * 
+     * @param string $name
+     * @return string
+     */
     public static function fixFileName(string $name) : string
     {
         return NameFixer::fixName($name);
@@ -489,20 +489,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);
@@ -532,14 +532,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
     {
         return self::getFileInfo($filename)->removeExtension($keepPath);
@@ -570,39 +570,39 @@ 
             ->detectUTFBom(self::getFileInfo($filename));
     }
 
-   /**
-    * 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>
-    * @deprecated
-    */
+    /**
+     * 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>
+     * @deprecated
+     */
     public static function getUTFBOMs() : array
     {
         return self::createUnicodeHandling()->getUTFBOMs();
     }
     
-   /**
-    * 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
-    * @deprecated Use {@see FileHelper::createUnicodeHandling()} instead.
-    */
+    /**
+     * 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
+     * @deprecated Use {@see FileHelper::createUnicodeHandling()} instead.
+     */
     public static function isValidUnicodeEncoding(string $encoding) : bool
     {
         return self::createUnicodeHandling()->isValidEncoding($encoding);
     }
     
-   /**
-    * Retrieves a list of all known unicode file encodings.
-    * @return string[]
-    * @deprecated Since v1.10.0. Use the unicode handling class instead.
-    */
+    /**
+     * Retrieves a list of all known unicode file encodings.
+     * @return string[]
+     * @deprecated Since v1.10.0. Use the unicode handling class instead.
+     */
     public static function getKnownUnicodeEncodings() : array
     {
         return self::createUnicodeHandling()->getKnownEncodings();
@@ -623,49 +623,49 @@ 
         return self::$unicodeHandling;
     }
     
-   /**
-    * Normalizes the slash style in a file or folder path,
-    * by replacing any anti-slashes with forward slashes.
-    * 
-    * @param string $path
-    * @return string
-    */
+    /**
+     * Normalizes the slash style in a file or folder path,
+     * by replacing any anti-slashes with forward slashes.
+     * 
+     * @param string $path
+     * @return string
+     */
     public static function normalizePath(string $path) : string
     {
         return str_replace(array('\\', '//'), array('/', '/'), $path);
     }
     
-   /**
-    * 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
     {
         JSONFile::factory(self::getFileInfo($file))
             ->putData($data, $pretty);
     }
    
-   /**
-    * 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
     {
         self::getFileInfo($filePath)->putContents($content);
@@ -730,14 +730,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);
@@ -777,16 +777,16 @@ 
             ->getPaths();
     }
 
-   /**
-    * Retrieves the maximum allowed upload file size, in bytes.
-    * Takes into account the PHP ini settings <code>post_max_size</code>
-    * and <code>upload_max_filesize</code>. Since these cannot
-    * be modified at runtime, they are the hard limits for uploads.
-    * 
-    * NOTE: Based on binary values, where 1KB = 1024 Bytes.
-    * 
-    * @return int Will return <code>-1</code> if no limit.
-    */
+    /**
+     * Retrieves the maximum allowed upload file size, in bytes.
+     * Takes into account the PHP ini settings <code>post_max_size</code>
+     * and <code>upload_max_filesize</code>. Since these cannot
+     * be modified at runtime, they are the hard limits for uploads.
+     * 
+     * NOTE: Based on binary values, where 1KB = 1024 Bytes.
+     * 
+     * @return int Will return <code>-1</code> if no limit.
+     */
     public static function getMaxUploadFilesize() : int
     {
         static $max_size = -1;
@@ -824,16 +824,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);
@@ -871,23 +871,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);
@@ -898,18 +898,18 @@ 
         return trim($relative, '/');
     }
     
-   /**
-    * Checks that the target file exists, and throws an exception
-    * if it does not. 
-    * 
-    * @param string|DirectoryIterator $path
-    * @param int|NULL $errorCode Optional custom error code
-    * @throws FileHelper_Exception
-    * @return string The real path to the file
-    * 
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
-    * @see FileHelper::ERROR_REAL_PATH_NOT_FOUND
-    */
+    /**
+     * Checks that the target file exists, and throws an exception
+     * if it does not. 
+     * 
+     * @param string|DirectoryIterator $path
+     * @param int|NULL $errorCode Optional custom error code
+     * @throws FileHelper_Exception
+     * @return string The real path to the file
+     * 
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
+     * @see FileHelper::ERROR_REAL_PATH_NOT_FOUND
+     */
     public static function requireFileExists($path, ?int $errorCode=null) : string
     {
         return self::getPathInfo($path)
@@ -932,18 +932,18 @@ 
             ->getPath();
     }
     
-   /**
-    * Reads a specific line number from the target file and returns its
-    * contents, if the file has such a line. Does so with little memory
-    * usage, as the file is not read entirely into memory.
-    * 
-    * @param string $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
     {
         return self::getFileInfo($path)
@@ -951,13 +951,13 @@ 
             ->getLine($lineNumber);
     }
     
-   /**
-    * 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
     {
         return self::getFileInfo($path)
@@ -965,26 +965,26 @@ 
             ->countLines();
     }
     
-   /**
-    * 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.
@@ -1017,33 +1017,33 @@ 
             ->getLines($amount);
     }
     
-   /**
-    * 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
     {
         return self::getFileInfo($filePath)->getContents();
     }
 
-   /**
-    * 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
     {
         return self::getFolderInfo($path)

Spacing +36 added lines, -36 removed lines

@@ -197,10 +197,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;
@@ -224,11 +224,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;
         }
@@ -256,7 +256,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
     {
         return self::parseCSVString(
             self::readContents($filePath),
@@ -277,7 +277,7 @@ 
     public static function detectMimeType(string $fileName) : ?string
     {
         $ext = self::getExtension($fileName);
-        if(empty($ext)) {
+        if (empty($ext)) {
             return null;
         }
 
@@ -317,7 +317,7 @@ 
      * @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::getFileInfo($filePath)->getDownloader()->send($fileName, $asAttachment);
     }
@@ -334,7 +334,7 @@ 
      * @throws FileHelper_Exception
      * @see FileHelper::ERROR_CANNOT_OPEN_URL
      */
-    public static function downloadFile(string $url, int $timeout=0, bool $SSLEnabled=false) : string
+    public static function downloadFile(string $url, int $timeout = 0, bool $SSLEnabled = false) : string
     {
         return FileDownloader::factory($url)
             ->setTimeout($timeout)
@@ -369,7 +369,7 @@ 
     {
         $info = self::getPathInfo($pathOrDirIterator);
 
-        if($info instanceof FileInfo)
+        if ($info instanceof FileInfo)
         {
             return $info->getExtension($lowercase);
         }
@@ -393,7 +393,7 @@ 
     {
         $info = self::getPathInfo($pathOrDirIterator);
 
-        if($extension === true || $info instanceof FolderInfo)
+        if ($extension === true || $info instanceof FolderInfo)
         {
             return $info->getName();
         }
@@ -414,7 +414,7 @@ 
      * @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
     {
         return JSONFile::factory(self::getFileInfo($file))
             ->setTargetEncoding($targetEncoding)
@@ -466,7 +466,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);
     }
@@ -484,7 +484,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);
     }
@@ -503,7 +503,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);
 
@@ -513,16 +513,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();
         }
@@ -540,7 +540,7 @@ 
     * @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
     {
         return self::getFileInfo($filename)->removeExtension($keepPath);
     }
@@ -615,7 +615,7 @@ 
 
     public static function createUnicodeHandling() : UnicodeHandling
     {
-        if(!isset(self::$unicodeHandling))
+        if (!isset(self::$unicodeHandling))
         {
             self::$unicodeHandling = new UnicodeHandling();
         }
@@ -648,7 +648,7 @@ 
     * @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
     {
         JSONFile::factory(self::getFileInfo($file))
             ->putData($data, $pretty);
@@ -666,7 +666,7 @@ 
     * @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
     {
         self::getFileInfo($filePath)->putContents($content);
     }
@@ -709,7 +709,7 @@ 
      */
     public static function checkPHPFileSyntax(string $path)
     {
-        if(!self::canMakePHPCalls()) {
+        if (!self::canMakePHPCalls()) {
             return true;
         }
         
@@ -720,7 +720,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;
         }
         
@@ -741,7 +741,7 @@ 
     public static function getModifiedDate(string $path) : ?DateTime
     {
         $time = filemtime($path);
-        if($time === false) {
+        if ($time === false) {
             return null;
         }
 
@@ -815,7 +815,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])));
@@ -834,7 +834,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);
         
@@ -842,17 +842,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(strpos($tokens[0], ':') !== false) {
+        if (strpos($tokens[0], ':') !== false) {
             array_shift($tokens);
         }
         
         // path was only the drive
-        if(count($tokens) === 0) {
+        if (count($tokens) === 0) {
             return '';
         }
 
@@ -861,8 +861,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
@@ -910,7 +910,7 @@ 
     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
     * @see FileHelper::ERROR_REAL_PATH_NOT_FOUND
     */
-    public static function requireFileExists($path, ?int $errorCode=null) : string
+    public static function requireFileExists($path, ?int $errorCode = null) : string
     {
         return self::getPathInfo($path)
             ->requireIsFile()
@@ -924,7 +924,7 @@ 
      * @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
     {
         return self::getPathInfo($path)
             ->requireIsFile()
@@ -1010,7 +1010,7 @@ 
      * @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
     {
         return self::getFileInfo($filePath)
             ->getLineReader()
@@ -1060,7 +1060,7 @@ 
      *
      * @throws FileHelper_Exception
      */
-    public static function createPathsReducer(array $paths=array()) : PathsReducer
+    public static function createPathsReducer(array $paths = array()) : PathsReducer
     {
         return new PathsReducer($paths);
     }

Braces +1 added lines, -2 removed lines

@@ -516,8 +516,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();
         }