Mistralys / application-utils

src/FileHelper.php

Indentation +423 added lines, -423 removed lines

@@ -78,32 +78,32 @@ 
     
     const ERROR_PATH_IS_NOT_A_FOLDER = 340034;
     
-   /**
-    * Opens a serialized file and returns the unserialized data.
-    * 
-    * @param string $file
-    * @throws FileHelper_Exception
-    * @return array
-    * @deprecated Use parseSerializedFile() instead.
-    * @see FileHelper::parseSerializedFile()
-    */
+    /**
+     * Opens a serialized file and returns the unserialized data.
+     * 
+     * @param string $file
+     * @throws FileHelper_Exception
+     * @return array
+     * @deprecated Use parseSerializedFile() instead.
+     * @see FileHelper::parseSerializedFile()
+     */
     public static function openUnserialized(string $file) : array
     {
         return self::parseSerializedFile($file);
     }
 
-   /**
-    * Opens a serialized file and returns the unserialized data.
-    *
-    * @param string $file
-    * @throws FileHelper_Exception
-    * @return array
-    * @see FileHelper::parseSerializedFile()
-    * 
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
-    * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ
-    * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED
-    */
+    /**
+     * Opens a serialized file and returns the unserialized data.
+     *
+     * @param string $file
+     * @throws FileHelper_Exception
+     * @return array
+     * @see FileHelper::parseSerializedFile()
+     * 
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
+     * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ
+     * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED
+     */
     public static function parseSerializedFile(string $file)
     {
         self::requireFileExists($file);
@@ -172,13 +172,13 @@ 
         return rmdir($rootFolder);
     }
     
-   /**
-    * Create a folder, if it does not exist yet.
-    *  
-    * @param string $path
-    * @throws FileHelper_Exception
-    * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
-    */
+    /**
+     * Create a folder, if it does not exist yet.
+     *  
+     * @param string $path
+     * @throws FileHelper_Exception
+     * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
+     */
     public static function createFolder($path)
     {
         if(is_dir($path) || mkdir($path, 0777, true)) {
@@ -225,22 +225,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($sourcePath, $targetPath)
     {
         self::requireFileExists($sourcePath, self::ERROR_SOURCE_FILE_NOT_FOUND);
@@ -291,15 +291,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)) {
@@ -321,15 +321,15 @@ 
     }
 
     /**
-    * Creates a new CSV parser instance and returns it.
-    * 
-    * @param string $delimiter
-    * @param string $enclosure
-    * @param string $escape
-    * @param bool $heading
-    * @return \parseCSV
-    * @todo Move this to the CSV helper.
-    */
+     * Creates a new CSV parser instance and returns it.
+     * 
+     * @param string $delimiter
+     * @param string $enclosure
+     * @param string $escape
+     * @param bool $heading
+     * @return \parseCSV
+     * @todo Move this to the CSV helper.
+     */
     public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : \parseCSV
     {
         if($delimiter==='') { $delimiter = ';'; }
@@ -344,23 +344,23 @@ 
         return $parser;
     }
 
-   /**
-    * Parses all lines in the specified string and returns an
-    * indexed array with all csv values in each line.
-    *
-    * @param string $csv
-    * @param string $delimiter
-    * @param string $enclosure
-    * @param string $escape
-    * @param bool $heading
-    * @return array
-    * @throws FileHelper_Exception
-    * 
-    * @todo Move this to the CSVHelper.
-    *
-    * @see parseCSVFile()
-    * @see FileHelper::ERROR_PARSING_CSV
-    */
+    /**
+     * Parses all lines in the specified string and returns an
+     * indexed array with all csv values in each line.
+     *
+     * @param string $csv
+     * @param string $delimiter
+     * @param string $enclosure
+     * @param string $escape
+     * @param bool $heading
+     * @return array
+     * @throws FileHelper_Exception
+     * 
+     * @todo Move this to the CSVHelper.
+     *
+     * @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, $escape, $heading);
@@ -532,31 +532,31 @@ 
         );
     }
     
-   /**
-    * Verifies whether the target file is a PHP file. The path
-    * to the file can be a path to a file as a string, or a 
-    * DirectoryIterator object instance.
-    * 
-    * @param string|\DirectoryIterator $pathOrDirIterator
-    * @return boolean
-    */
+    /**
+     * Verifies whether the target file is a PHP file. The path
+     * to the file can be a path to a file as a string, or a 
+     * DirectoryIterator object instance.
+     * 
+     * @param string|\DirectoryIterator $pathOrDirIterator
+     * @return boolean
+     */
     public static function isPHPFile($pathOrDirIterator)
     {
-    	if(self::getExtension($pathOrDirIterator) == 'php') {
-    		return true;
-    	}
+        if(self::getExtension($pathOrDirIterator) == 'php') {
+            return true;
+        }
     	
-    	return false;
+        return false;
     }
     
-   /**
-    * Retrieves the extension of the specified file. Can be a path
-    * to a file as a string, or a DirectoryIterator object instance.
-    * 
-    * @param string|\DirectoryIterator $pathOrDirIterator
-    * @param bool $lowercase
-    * @return string
-    */
+    /**
+     * Retrieves the extension of the specified file. Can be a path
+     * to a file as a string, or a DirectoryIterator object instance.
+     * 
+     * @param string|\DirectoryIterator $pathOrDirIterator
+     * @param bool $lowercase
+     * @return string
+     */
     public static function getExtension($pathOrDirIterator, bool $lowercase = true) : string
     {
         if($pathOrDirIterator instanceof \DirectoryIterator) {
@@ -567,51 +567,51 @@ 
          
         $ext = pathinfo($filename, PATHINFO_EXTENSION);
         if($lowercase) {
-        	$ext = mb_strtolower($ext);
+            $ext = mb_strtolower($ext);
         }
         
         return $ext;
     }
     
-   /**
-    * Retrieves the file name from a path, with or without extension.
-    * The path to the file can be a string, or a DirectoryIterator object
-    * instance.
-    * 
-    * In case of folders, behaves like the pathinfo function: returns
-    * the name of the folder.
-    * 
-    * @param string|\DirectoryIterator $pathOrDirIterator
-    * @param bool $extension
-    * @return string
-    */
+    /**
+     * Retrieves the file name from a path, with or without extension.
+     * The path to the file can be a string, or a DirectoryIterator object
+     * instance.
+     * 
+     * In case of folders, behaves like the pathinfo function: returns
+     * the name of the folder.
+     * 
+     * @param string|\DirectoryIterator $pathOrDirIterator
+     * @param bool $extension
+     * @return string
+     */
     public static function getFilename($pathOrDirIterator, $extension = true)
     {
         $path = $pathOrDirIterator;
-    	if($pathOrDirIterator instanceof \DirectoryIterator) {
-    		$path = $pathOrDirIterator->getFilename();
-    	}
+        if($pathOrDirIterator instanceof \DirectoryIterator) {
+            $path = $pathOrDirIterator->getFilename();
+        }
     	
-    	$path = self::normalizePath($path);
+        $path = self::normalizePath($path);
     	
-    	if(!$extension) {
-    	    return pathinfo($path, PATHINFO_FILENAME);
-    	}
+        if(!$extension) {
+            return pathinfo($path, PATHINFO_FILENAME);
+        }
     	
-    	return pathinfo($path, PATHINFO_BASENAME); 
+        return pathinfo($path, PATHINFO_BASENAME); 
     }
    
-   /**
-    * Tries to read the contents of the target file and
-    * treat it as JSON to return the decoded JSON data.
-    * 
-    * @param string $file
-    * @throws FileHelper_Exception
-    * @return array
-    * 
-    * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE
-    * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE
-    */ 
+    /**
+     * Tries to read the contents of the target file and
+     * treat it as JSON to return the decoded JSON data.
+     * 
+     * @param string $file
+     * @throws FileHelper_Exception
+     * @return array
+     * 
+     * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE
+     * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE
+     */ 
     public static function parseJSONFile(string $file, $targetEncoding=null, $sourceEncoding=null)
     {
         self::requireFileExists($file, self::ERROR_CANNOT_FIND_JSON_FILE);
@@ -647,16 +647,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);
@@ -686,68 +686,68 @@ 
         return $name;
     }
     
-   /**
-    * Creates an instance of the file finder, which is an easier
-    * alternative to the other manual findFile methods, since all
-    * options can be set by chaining.
-    * 
-    * @param string $path
-    * @return FileHelper_FileFinder
-    */
+    /**
+     * Creates an instance of the file finder, which is an easier
+     * alternative to the other manual findFile methods, since all
+     * options can be set by chaining.
+     * 
+     * @param string $path
+     * @return FileHelper_FileFinder
+     */
     public static function createFileFinder(string $path) : FileHelper_FileFinder
     {
         return new FileHelper_FileFinder($path);
     }
     
-   /**
-    * Searches for all HTML files in the target folder.
-    * 
-    * NOTE: This method only exists for backwards compatibility.
-    * Use the `createFileFinder()` method instead, which offers
-    * an object oriented interface that is much easier to use.
-    * 
-    * @param string $targetFolder
-    * @param array $options
-    * @return array An indexed array with files.
-    * @see FileHelper::createFileFinder()
-    */
+    /**
+     * Searches for all HTML files in the target folder.
+     * 
+     * NOTE: This method only exists for backwards compatibility.
+     * Use the `createFileFinder()` method instead, which offers
+     * an object oriented interface that is much easier to use.
+     * 
+     * @param string $targetFolder
+     * @param array $options
+     * @return array An indexed array with files.
+     * @see FileHelper::createFileFinder()
+     */
     public static function findHTMLFiles(string $targetFolder, array $options=array()) : array
     {
         return self::findFiles($targetFolder, array('html'), $options);
     }
 
-   /**
-    * Searches for all PHP files in the target folder.
-    * 
-    * NOTE: This method only exists for backwards compatibility.
-    * Use the `createFileFinder()` method instead, which offers
-    * an object oriented interface that is much easier to use.
-    * 
-    * @param string $targetFolder
-    * @param array $options
-    * @return array An indexed array of PHP files.
-    * @see FileHelper::createFileFinder()
-    */
+    /**
+     * Searches for all PHP files in the target folder.
+     * 
+     * NOTE: This method only exists for backwards compatibility.
+     * Use the `createFileFinder()` method instead, which offers
+     * an object oriented interface that is much easier to use.
+     * 
+     * @param string $targetFolder
+     * @param array $options
+     * @return array An indexed array of PHP files.
+     * @see FileHelper::createFileFinder()
+     */
     public static function findPHPFiles(string $targetFolder, array $options=array()) : array
     {
         return self::findFiles($targetFolder, array('php'), $options);
     }
     
-   /**
-    * Finds files according to the specified options.
-    * 
-    * NOTE: This method only exists for backwards compatibility.
-    * Use the `createFileFinder()` method instead, which offers
-    * an object oriented interface that is much easier to use.
-    *  
-    * @param string $targetFolder
-    * @param array $extensions
-    * @param array $options
-    * @param array $files
-    * @throws FileHelper_Exception
-    * @return array
-    * @see FileHelper::createFileFinder()
-    */
+    /**
+     * Finds files according to the specified options.
+     * 
+     * NOTE: This method only exists for backwards compatibility.
+     * Use the `createFileFinder()` method instead, which offers
+     * an object oriented interface that is much easier to use.
+     *  
+     * @param string $targetFolder
+     * @param array $extensions
+     * @param array $options
+     * @param array $files
+     * @throws FileHelper_Exception
+     * @return array
+     * @see FileHelper::createFileFinder()
+     */
     public static function findFiles(string $targetFolder, array $extensions=array(), array $options=array(), array $files=array()) : array
     {
         $finder = self::createFileFinder($targetFolder);
@@ -773,14 +773,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
@@ -800,22 +800,22 @@ 
         return implode('/', $parts);
     }
     
-   /**
-    * Detects the UTF BOM in the target file, if any. Returns
-    * the encoding matching the BOM, which can be any of the
-    * following:
-    * 
-    * <ul>
-    * <li>UTF32-BE</li>
-    * <li>UTF32-LE</li>
-    * <li>UTF16-BE</li>
-    * <li>UTF16-LE</li>
-    * <li>UTF8</li>
-    * </ul>
-    * 
-    * @param string $filename
-    * @return string|NULL
-    */
+    /**
+     * Detects the UTF BOM in the target file, if any. Returns
+     * the encoding matching the BOM, which can be any of the
+     * following:
+     * 
+     * <ul>
+     * <li>UTF32-BE</li>
+     * <li>UTF32-LE</li>
+     * <li>UTF16-BE</li>
+     * <li>UTF16-LE</li>
+     * <li>UTF8</li>
+     * </ul>
+     * 
+     * @param string $filename
+     * @return string|NULL
+     */
     public static function detectUTFBom(string $filename) : ?string
     {
         $fp = fopen($filename, 'r');
@@ -847,13 +847,13 @@ 
     
     protected static $utfBoms;
     
-   /**
-    * Retrieves a list of all UTF byte order mark character
-    * sequences, as an assocative array with UTF encoding => bom sequence
-    * pairs.
-    * 
-    * @return array
-    */
+    /**
+     * Retrieves a list of all UTF byte order mark character
+     * sequences, as an assocative array with UTF encoding => bom sequence
+     * pairs.
+     * 
+     * @return array
+     */
     public static function getUTFBOMs()
     {
         if(!isset(self::$utfBoms)) {
@@ -869,15 +869,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();
@@ -896,40 +896,40 @@ 
         return in_array($encoding, $keep);
     }
     
-   /**
-    * Retrieves a list of all known unicode file encodings.
-    * @return array
-    */
+    /**
+     * Retrieves a list of all known unicode file encodings.
+     * @return array
+     */
     public static function getKnownUnicodeEncodings()
     {
         return array_keys(self::getUTFBOMs());
     }
     
-   /**
-    * Normalizes the slash style in a file or folder path,
-    * by replacing any antislashes with forward slashes.
-    * 
-    * @param string $path
-    * @return string
-    */
+    /**
+     * Normalizes the slash style in a file or folder path,
+     * by replacing any antislashes with forward slashes.
+     * 
+     * @param string $path
+     * @return string
+     */
     public static function normalizePath(string $path) : string
     {
         return str_replace(array('\\', '//'), array('/', '/'), $path);
     }
     
-   /**
-    * Saves the specified data to a file, JSON encoded.
-    * 
-    * @param mixed $data
-    * @param string $file
-    * @param bool $pretty
-    * @throws FileHelper_Exception
-    * 
-    * @see FileHelper::ERROR_JSON_ENCODE_ERROR
-    * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE
-    * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
-    * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
-    */
+    /**
+     * Saves the specified data to a file, JSON encoded.
+     * 
+     * @param mixed $data
+     * @param string $file
+     * @param bool $pretty
+     * @throws FileHelper_Exception
+     * 
+     * @see FileHelper::ERROR_JSON_ENCODE_ERROR
+     * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE
+     * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
+     * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
+     */
     public static function saveAsJSON($data, string $file, bool $pretty=false)
     {
         $options = null;
@@ -953,18 +953,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
     {
         // target file already exists
@@ -1017,12 +1017,12 @@ 
         );
     }
     
-   /**
-    * Checks whether it is possible to run PHP command 
-    * line commands.
-    * 
-    * @return boolean
-    */
+    /**
+     * Checks whether it is possible to run PHP command 
+     * line commands.
+     * 
+     * @return boolean
+     */
     public static function canMakePHPCalls() : bool
     {
         return self::cliCommandExists('php');
@@ -1099,16 +1099,16 @@ 
         return $result;
     }
     
-   /**
-    * Validates a PHP file's syntax.
-    * 
-    * NOTE: This will fail silently if the PHP command line
-    * is not available. Use {@link FileHelper::canMakePHPCalls()}
-    * to check this beforehand as needed.
-    * 
-    * @param string $path
-    * @return boolean|array A boolean true if the file is valid, an array with validation messages otherwise.
-    */
+    /**
+     * Validates a PHP file's syntax.
+     * 
+     * NOTE: This will fail silently if the PHP command line
+     * is not available. Use {@link FileHelper::canMakePHPCalls()}
+     * to check this beforehand as needed.
+     * 
+     * @param string $path
+     * @return boolean|array A boolean true if the file is valid, an array with validation messages otherwise.
+     */
     public static function checkPHPFileSyntax($path)
     {
         if(!self::canMakePHPCalls()) {
@@ -1132,14 +1132,14 @@ 
         return $output;
     }
     
-   /**
-    * Retrieves the last modified date for the specified file or folder.
-    * 
-    * Note: If the target does not exist, returns null. 
-    * 
-    * @param string $path
-    * @return \DateTime|NULL
-    */
+    /**
+     * Retrieves the last modified date for the specified file or folder.
+     * 
+     * Note: If the target does not exist, returns null. 
+     * 
+     * @param string $path
+     * @return \DateTime|NULL
+     */
     public static function getModifiedDate($path)
     {
         $time = filemtime($path);
@@ -1152,24 +1152,24 @@ 
         return null; 
     }
     
-   /**
-    * Retrieves the names of all subfolders in the specified path.
-    * 
-    * Available options:
-    * 
-    * - recursive: true/false
-    *   Whether to search for subfolders recursively. 
-    *   
-    * - absolute-paths: true/false
-    *   Whether to return a list of absolute paths.
-    * 
-    * @param string $targetFolder
-    * @param array $options
-    * @throws FileHelper_Exception
-    * @return string[]
-    * 
-    * @todo Move this to a separate class.
-    */
+    /**
+     * Retrieves the names of all subfolders in the specified path.
+     * 
+     * Available options:
+     * 
+     * - recursive: true/false
+     *   Whether to search for subfolders recursively. 
+     *   
+     * - absolute-paths: true/false
+     *   Whether to return a list of absolute paths.
+     * 
+     * @param string $targetFolder
+     * @param array $options
+     * @throws FileHelper_Exception
+     * @return string[]
+     * 
+     * @todo Move this to a separate class.
+     */
     public static function getSubfolders($targetFolder, $options = array())
     {
         if(!is_dir($targetFolder)) 
@@ -1230,16 +1230,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;
@@ -1277,16 +1277,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);
@@ -1324,23 +1324,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);
@@ -1352,17 +1352,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, $errorCode=null) : string
     {
         $result = realpath($path);
@@ -1381,18 +1381,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);
@@ -1408,19 +1408,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);
@@ -1450,26 +1450,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.
@@ -1482,18 +1482,18 @@ 
         return ConvertHelper::detectEOLCharacter($string);
     }
     
-   /**
-    * Reads the specified amount of lines from the target file.
-    * Unicode BOM compatible: any byte order marker is stripped
-    * from the resulting lines.
-    * 
-    * @param string $filePath
-    * @param int $amount Set to 0 to read all lines.
-    * @return array
-    * 
-    * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
-    */
+    /**
+     * Reads the specified amount of lines from the target file.
+     * Unicode BOM compatible: any byte order marker is stripped
+     * from the resulting lines.
+     * 
+     * @param string $filePath
+     * @param int $amount Set to 0 to read all lines.
+     * @return array
+     * 
+     * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
+     */
     public static function readLines(string $filePath, int $amount=0) : array
     {
         self::requireFileExists($filePath);
@@ -1546,16 +1546,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);
@@ -1576,18 +1576,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 +102 added lines, -102 removed lines

@@ -110,7 +110,7 @@ 
         
         $contents = file_get_contents($file);
         
-        if($contents === false) 
+        if ($contents === false) 
         {
             throw new FileHelper_Exception(
                 'Cannot load serialized content from file.',
@@ -124,7 +124,7 @@ 
         
         $result = @unserialize($contents);
         
-        if($result !== false) {
+        if ($result !== false) {
             return $result;
         }
         
@@ -140,7 +140,7 @@ 
     
     public static function deleteTree($rootFolder)
     {
-        if(!file_exists($rootFolder)) {
+        if (!file_exists($rootFolder)) {
             return true;
         }
         
@@ -181,7 +181,7 @@ 
     */
     public static function createFolder($path)
     {
-        if(is_dir($path) || mkdir($path, 0777, true)) {
+        if (is_dir($path) || mkdir($path, 0777, true)) {
             return;
         }
         
@@ -216,11 +216,11 @@ 
 
             if ($item->isDir()) 
             {
-                FileHelper::copyTree(str_replace('\\', '/', $itemPath), $target . '/' . $baseName);
+                FileHelper::copyTree(str_replace('\\', '/', $itemPath), $target.'/'.$baseName);
             } 
-            else if($item->isFile()) 
+            else if ($item->isFile()) 
             {
-                self::copyFile($itemPath, $target . '/' . $baseName);
+                self::copyFile($itemPath, $target.'/'.$baseName);
             }
         }
     }
@@ -245,7 +245,7 @@ 
     {
         self::requireFileExists($sourcePath, self::ERROR_SOURCE_FILE_NOT_FOUND);
         
-        if(!is_readable($sourcePath))
+        if (!is_readable($sourcePath))
         {
             throw new FileHelper_Exception(
                 sprintf('Source file [%s] to copy is not readable.', basename($sourcePath)),
@@ -259,11 +259,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)),
@@ -275,7 +275,7 @@ 
             );
         }
         
-        if(copy($sourcePath, $targetPath)) {
+        if (copy($sourcePath, $targetPath)) {
             return;
         }
         
@@ -302,11 +302,11 @@ 
     */
     public static function deleteFile(string $filePath) : void
     {
-        if(!file_exists($filePath)) {
+        if (!file_exists($filePath)) {
             return;
         }
         
-        if(unlink($filePath)) {
+        if (unlink($filePath)) {
             return;
         }
         
@@ -330,10 +330,10 @@ 
     * @return \parseCSV
     * @todo Move this to the CSV helper.
     */
-    public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : \parseCSV
+    public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : \parseCSV
     {
-        if($delimiter==='') { $delimiter = ';'; }
-        if($enclosure==='') { $enclosure = '"'; }
+        if ($delimiter === '') { $delimiter = ';'; }
+        if ($enclosure === '') { $enclosure = '"'; }
         
         $parser = new \parseCSV(null, null, null, array());
 
@@ -361,11 +361,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, $escape, $heading);
         $result = $parser->parse_string(/** @scrutinizer ignore-type */ $csv);
-        if(is_array($result)) {
+        if (is_array($result)) {
             return $result;
         }
         
@@ -394,7 +394,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);
 
@@ -411,7 +411,7 @@ 
     public static function detectMimeType(string $fileName) : ?string
     {
         $ext = self::getExtension($fileName);
-        if(empty($ext)) {
+        if (empty($ext)) {
             return null;
         }
 
@@ -432,11 +432,11 @@ 
      * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
      * @see FileHelper::ERROR_UNKNOWN_FILE_MIME_TYPE
      */
-    public static function sendFile(string $filePath, $fileName = null, bool $asAttachment=true)
+    public static function sendFile(string $filePath, $fileName = null, bool $asAttachment = true)
     {
         self::requireFileExists($filePath);
         
-        if(empty($fileName)) {
+        if (empty($fileName)) {
             $fileName = basename($filePath);
         }
 
@@ -454,10 +454,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';
         }
         
@@ -485,7 +485,7 @@ 
         requireCURL();
         
         $ch = curl_init();
-        if(!is_resource($ch)) 
+        if (!is_resource($ch)) 
         {
             throw new FileHelper_Exception(
                 'Could not initialize a new cURL instance.',
@@ -506,7 +506,7 @@ 
         
         $output = curl_exec($ch);
 
-        if($output === false) {
+        if ($output === false) {
             throw new FileHelper_Exception(
                 'Unable to open URL',
                 sprintf(
@@ -520,7 +520,7 @@ 
 
         curl_close($ch);
 
-        if(is_string($output)) 
+        if (is_string($output)) 
         {
             return $output;
         }
@@ -542,7 +542,7 @@ 
     */
     public static function isPHPFile($pathOrDirIterator)
     {
-    	if(self::getExtension($pathOrDirIterator) == 'php') {
+    	if (self::getExtension($pathOrDirIterator) == 'php') {
     		return true;
     	}
     	
@@ -559,14 +559,14 @@ 
     */
     public static function getExtension($pathOrDirIterator, bool $lowercase = true) : string
     {
-        if($pathOrDirIterator instanceof \DirectoryIterator) {
+        if ($pathOrDirIterator instanceof \DirectoryIterator) {
             $filename = $pathOrDirIterator->getFilename();
         } else {
             $filename = basename($pathOrDirIterator);
         }
          
         $ext = pathinfo($filename, PATHINFO_EXTENSION);
-        if($lowercase) {
+        if ($lowercase) {
         	$ext = mb_strtolower($ext);
         }
         
@@ -588,13 +588,13 @@ 
     public static function getFilename($pathOrDirIterator, $extension = true)
     {
         $path = $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);
     	}
     	
@@ -612,12 +612,12 @@ 
     * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE
     * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE
     */ 
-    public static function parseJSONFile(string $file, $targetEncoding=null, $sourceEncoding=null)
+    public static function parseJSONFile(string $file, $targetEncoding = null, $sourceEncoding = null)
     {
         self::requireFileExists($file, self::ERROR_CANNOT_FIND_JSON_FILE);
         
         $content = file_get_contents($file);
-        if(!$content) {
+        if (!$content) {
             throw new FileHelper_Exception(
                 'Cannot get file contents',
                 sprintf(
@@ -628,12 +628,12 @@ 
             );
         }
         
-        if(isset($targetEncoding)) {
+        if (isset($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(
@@ -673,13 +673,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);
         }
         
@@ -711,7 +711,7 @@ 
     * @return array An indexed array with files.
     * @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);
     }
@@ -728,7 +728,7 @@ 
     * @return array An indexed array of PHP files.
     * @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);
     }
@@ -748,22 +748,22 @@ 
     * @return array
     * @see FileHelper::createFileFinder()
     */
-    public static function findFiles(string $targetFolder, array $extensions=array(), array $options=array(), array $files=array()) : array
+    public static function findFiles(string $targetFolder, array $extensions = array(), array $options = array(), array $files = array()) : array
     {
         $finder = self::createFileFinder($targetFolder);
 
         $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();
         }
@@ -781,12 +781,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);
         }
@@ -819,7 +819,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',
@@ -834,10 +834,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;
             }
         }
@@ -856,13 +856,13 @@ 
     */
     public static function getUTFBOMs()
     {
-        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)
             );
         }
         
@@ -883,7 +883,7 @@ 
         $encodings = self::getKnownUnicodeEncodings();
 
         $keep = array();
-        foreach($encodings as $string) 
+        foreach ($encodings as $string) 
         {
             $withHyphen = str_replace('UTF', 'UTF-', $string);
             
@@ -930,16 +930,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)
+    public static function saveAsJSON($data, string $file, bool $pretty = false)
     {
         $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();
             
@@ -965,12 +965,12 @@ 
     * @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
     {
         // 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)),
@@ -990,7 +990,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)),
@@ -1003,7 +1003,7 @@ 
             }
         }
         
-        if(file_put_contents($filePath, $content) !== false) {
+        if (file_put_contents($filePath, $content) !== false) {
             return;
         }
         
@@ -1041,7 +1041,7 @@ 
     {
         static $checked = array();
         
-        if(isset($checked[$command])) {
+        if (isset($checked[$command])) {
             return $checked[$command];
         }
         
@@ -1054,7 +1054,7 @@ 
         
         $os = strtolower(PHP_OS_FAMILY);
         
-        if(!isset($osCommands[$os])) 
+        if (!isset($osCommands[$os])) 
         {
             throw new FileHelper_Exception(
                 'Unsupported OS for CLI commands',
@@ -1080,7 +1080,7 @@ 
             $pipes
         );
         
-        if($process === false) {
+        if ($process === false) {
             $checked[$command] = false;
             return false;
         }
@@ -1111,7 +1111,7 @@ 
     */
     public static function checkPHPFileSyntax($path)
     {
-        if(!self::canMakePHPCalls()) {
+        if (!self::canMakePHPCalls()) {
             return true;
         }
         
@@ -1122,7 +1122,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;
         }
         
@@ -1143,7 +1143,7 @@ 
     public static function getModifiedDate($path)
     {
         $time = filemtime($path);
-        if($time !== false) {
+        if ($time !== false) {
             $date = new \DateTime();
             $date->setTimestamp($time);
             return $date;
@@ -1172,7 +1172,7 @@ 
     */
     public static function getSubfolders($targetFolder, $options = array())
     {
-        if(!is_dir($targetFolder)) 
+        if (!is_dir($targetFolder)) 
         {
             throw new FileHelper_Exception(
                 'Target folder does not exist',
@@ -1196,29 +1196,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;
@@ -1268,7 +1268,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])));
@@ -1287,7 +1287,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);
         
@@ -1295,17 +1295,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 '';
         }
 
@@ -1314,8 +1314,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
@@ -1363,14 +1363,14 @@ 
     * 
     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
     */
-    public static function requireFileExists(string $path, $errorCode=null) : string
+    public static function requireFileExists(string $path, $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;
         }
         
@@ -1399,15 +1399,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;
         }
         
@@ -1433,7 +1433,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
@@ -1441,13 +1441,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;
     }
     
    /**
@@ -1494,13 +1494,13 @@ 
     * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES
     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
     */
-    public static function readLines(string $filePath, int $amount=0) : array
+    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.',
@@ -1516,19 +1516,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;
@@ -1536,7 +1536,7 @@ 
             
             $result[] = $line;
             
-            if($amount > 0 && $counter == $amount) {
+            if ($amount > 0 && $counter == $amount) {
                 break;
             }
         }
@@ -1562,7 +1562,7 @@ 
         
         $result = file_get_contents($filePath);
         
-        if($result !== false) {
+        if ($result !== false) {
             return $result;
         }
         
@@ -1592,7 +1592,7 @@ 
     {
         $actual = realpath($path);
         
-        if($actual === false) 
+        if ($actual === false) 
         {
             throw new FileHelper_Exception(
                 'Folder does not exist',
@@ -1604,7 +1604,7 @@ 
             );
         }
         
-        if(is_dir($path)) 
+        if (is_dir($path)) 
         {
             return self::normalizePath($actual);
         }