Mistralys / application-utils

src/FileHelper.php

Indentation +162 added lines, -162 removed lines

@@ -73,18 +73,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|PathInfoInterface|SplFileInfo $file
-    * @throws FileHelper_Exception
-    * @return array<int|string,mixed>
-    * @see SerializedFile::parse()
-    * 
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
-    * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ
-    * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED
-    */
+    /**
+     * Opens a serialized file and returns the unserialized data.
+     *
+     * @param string|PathInfoInterface|SplFileInfo $file
+     * @throws FileHelper_Exception
+     * @return array<int|string,mixed>
+     * @see SerializedFile::parse()
+     * 
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
+     * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ
+     * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED
+     */
     public static function parseSerializedFile($file) : array
     {
         return SerializedFile::factory($file)->parse();
@@ -103,13 +103,13 @@ 
         return FolderTree::delete($rootFolder);
     }
     
-   /**
-    * Create a folder, if it does not exist yet.
-    *  
-    * @param string|PathInfoInterface $path
-    * @throws FileHelper_Exception
-    * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
-    */
+    /**
+     * Create a folder, if it does not exist yet.
+     *  
+     * @param string|PathInfoInterface $path
+     * @throws FileHelper_Exception
+     * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
+     */
     public static function createFolder($path) : FolderInfo
     {
         return self::getFolderInfo($path)->create();
@@ -138,36 +138,36 @@ 
         FolderTree::copy($source, $target);
     }
     
-   /**
-    * Copies a file to the target location. Includes checks
-    * for most error sources, like the source file not being
-    * readable. Automatically creates the target folder if it
-    * does not exist yet.
-    * 
-    * @param string|PathInfoInterface|SplFileInfo $sourcePath
-    * @param string|PathInfoInterface|SplFileInfo $targetPath
-    * @throws FileHelper_Exception
-    * 
-    * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
-    * @see FileHelper::ERROR_SOURCE_FILE_NOT_FOUND
-    * @see FileHelper::ERROR_SOURCE_FILE_NOT_READABLE
-    * @see FileHelper::ERROR_TARGET_COPY_FOLDER_NOT_WRITABLE
-    * @see FileHelper::ERROR_CANNOT_COPY_FILE
-    */
+    /**
+     * Copies a file to the target location. Includes checks
+     * for most error sources, like the source file not being
+     * readable. Automatically creates the target folder if it
+     * does not exist yet.
+     * 
+     * @param string|PathInfoInterface|SplFileInfo $sourcePath
+     * @param string|PathInfoInterface|SplFileInfo $targetPath
+     * @throws FileHelper_Exception
+     * 
+     * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
+     * @see FileHelper::ERROR_SOURCE_FILE_NOT_FOUND
+     * @see FileHelper::ERROR_SOURCE_FILE_NOT_READABLE
+     * @see FileHelper::ERROR_TARGET_COPY_FOLDER_NOT_WRITABLE
+     * @see FileHelper::ERROR_CANNOT_COPY_FILE
+     */
     public static function copyFile($sourcePath, $targetPath) : void
     {
         self::getFileInfo($sourcePath)->copyTo($targetPath);
     }
     
-   /**
-    * Deletes the target file. Ignored if it cannot be found,
-    * and throws an exception if it fails.
-    * 
-    * @param string|PathInfoInterface|SplFileInfo $filePath
-    * @throws FileHelper_Exception
-    * 
-    * @see FileHelper::ERROR_CANNOT_DELETE_FILE
-    */
+    /**
+     * Deletes the target file. Ignored if it cannot be found,
+     * and throws an exception if it fails.
+     * 
+     * @param string|PathInfoInterface|SplFileInfo $filePath
+     * @throws FileHelper_Exception
+     * 
+     * @see FileHelper::ERROR_CANNOT_DELETE_FILE
+     */
     public static function deleteFile($filePath) : void
     {
         self::getFileInfo($filePath)->delete();
@@ -288,7 +288,7 @@ 
      */
     public static function isPHPFile($filePath) : bool
     {
-    	return self::getExtension($filePath) === 'php';
+        return self::getExtension($filePath) === 'php';
     }
 
     /**
@@ -354,16 +354,16 @@ 
             ->parse();
     }
     
-   /**
-    * Corrects common formatting mistakes when users enter
-    * file names, like too many spaces, dots and the like.
-    * 
-    * NOTE: if the file name contains a path, the path is
-    * stripped, leaving only the file name.
-    * 
-    * @param string $name
-    * @return string
-    */
+    /**
+     * Corrects common formatting mistakes when users enter
+     * file names, like too many spaces, dots and the like.
+     * 
+     * NOTE: if the file name contains a path, the path is
+     * stripped, leaving only the file name.
+     * 
+     * @param string $name
+     * @return string
+     */
     public static function fixFileName(string $name) : string
     {
         return NameFixer::fixName($name);
@@ -423,23 +423,23 @@ 
         return self::findFiles($targetFolder, array('php'), $options);
     }
     
-   /**
-    * Finds files according to the specified options.
-    * 
-    * NOTE: This method only exists for backwards compatibility.
-    * Use the {@see FileHelper::createFileFinder()} method instead,
-    * which offers an object-oriented interface that is much easier
-    * to use.
-    *  
-    * @param string|PathInfoInterface|SplFileInfo $targetFolder
-    * @param string[] $extensions
-    * @param array<string,mixed> $options
-    * @throws FileHelper_Exception
-    * @return string[]
-    *
-    * @see FileHelper::createFileFinder()
-    * @deprecated Use the file finder instead.
-    */
+    /**
+     * Finds files according to the specified options.
+     * 
+     * NOTE: This method only exists for backwards compatibility.
+     * Use the {@see FileHelper::createFileFinder()} method instead,
+     * which offers an object-oriented interface that is much easier
+     * to use.
+     *  
+     * @param string|PathInfoInterface|SplFileInfo $targetFolder
+     * @param string[] $extensions
+     * @param array<string,mixed> $options
+     * @throws FileHelper_Exception
+     * @return string[]
+     *
+     * @see FileHelper::createFileFinder()
+     * @deprecated Use the file finder instead.
+     */
     public static function findFiles($targetFolder, array $extensions=array(), array $options=array()) : array
     {
         $finder = self::createFileFinder($targetFolder);
@@ -498,13 +498,13 @@ 
         return self::$unicodeHandling;
     }
     
-   /**
-    * Normalizes the slash style in a file or folder path,
-    * by replacing any anti-slashes with forward slashes.
-    * 
-    * @param string $path
-    * @return string
-    */
+    /**
+     * Normalizes the slash style in a file or folder path,
+     * by replacing any anti-slashes with forward slashes.
+     * 
+     * @param string $path
+     * @return string
+     */
     public static function normalizePath(string $path) : string
     {
         return str_replace(array('\\', '//'), array('/', '/'), $path);
@@ -629,70 +629,70 @@ 
             ->getPaths();
     }
 
-   /**
-    * Retrieves the maximum allowed upload file size, in bytes.
-    * Takes into account the PHP ini settings <code>post_max_size</code>
-    * and <code>upload_max_filesize</code>. Since these cannot
-    * be modified at runtime, they are the hard limits for uploads.
-    * 
-    * NOTE: Based on binary values, where 1KB = 1024 Bytes.
-    * 
-    * @return int Will return <code>-1</code> if no limit.
-    */
+    /**
+     * Retrieves the maximum allowed upload file size, in bytes.
+     * Takes into account the PHP ini settings <code>post_max_size</code>
+     * and <code>upload_max_filesize</code>. Since these cannot
+     * be modified at runtime, they are the hard limits for uploads.
+     * 
+     * NOTE: Based on binary values, where 1KB = 1024 Bytes.
+     * 
+     * @return int Will return <code>-1</code> if no limit.
+     */
     public static function getMaxUploadFilesize() : int
     {
         return UploadFileSizeInfo::getFileSize();
     }
    
-   /**
-    * Makes a path relative using a folder depth: will reduce the
-    * length of the path so that only the amount of folders defined
-    * in the <code>$depth</code> attribute are shown below the actual
-    * folder or file in the path.
-    *  
-    * @param string  $path The absolute or relative path
-    * @param int $depth The folder depth to reduce the path to
-    * @return string
-    */
+    /**
+     * Makes a path relative using a folder depth: will reduce the
+     * length of the path so that only the amount of folders defined
+     * in the <code>$depth</code> attribute are shown below the actual
+     * folder or file in the path.
+     *  
+     * @param string  $path The absolute or relative path
+     * @param int $depth The folder depth to reduce the path to
+     * @return string
+     */
     public static function relativizePathByDepth(string $path, int $depth=2) : string
     {
         return PathRelativizer::relativizeByDepth($path, $depth);
     }
     
-   /**
-    * Makes the specified path relative to another path,
-    * by removing one from the other if found. Also 
-    * normalizes the path to use forward slashes. 
-    * 
-    * Example:
-    * 
-    * <pre>
-    * relativizePath('c:\some\folder\to\file.txt', 'c:\some\folder');
-    * </pre>
-    * 
-    * Result: <code>to/file.txt</code>
-    * 
-    * @param string $path
-    * @param string $relativeTo
-    * @return string
-    */
+    /**
+     * Makes the specified path relative to another path,
+     * by removing one from the other if found. Also 
+     * normalizes the path to use forward slashes. 
+     * 
+     * Example:
+     * 
+     * <pre>
+     * relativizePath('c:\some\folder\to\file.txt', 'c:\some\folder');
+     * </pre>
+     * 
+     * Result: <code>to/file.txt</code>
+     * 
+     * @param string $path
+     * @param string $relativeTo
+     * @return string
+     */
     public static function relativizePath(string $path, string $relativeTo) : string
     {
         return PathRelativizer::relativize($path, $relativeTo);
     }
     
-   /**
-    * Checks that the target file exists, and throws an exception
-    * if it does not. 
-    * 
-    * @param string|SplFileInfo $path
-    * @param int|NULL $errorCode Optional custom error code
-    * @throws FileHelper_Exception
-    * @return string The real path to the file
-    * 
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
-    * @see FileHelper::ERROR_REAL_PATH_NOT_FOUND
-    */
+    /**
+     * Checks that the target file exists, and throws an exception
+     * if it does not. 
+     * 
+     * @param string|SplFileInfo $path
+     * @param int|NULL $errorCode Optional custom error code
+     * @throws FileHelper_Exception
+     * @return string The real path to the file
+     * 
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
+     * @see FileHelper::ERROR_REAL_PATH_NOT_FOUND
+     */
     public static function requireFileExists($path, ?int $errorCode=null) : string
     {
         return self::getPathInfo($path)
@@ -715,18 +715,18 @@ 
             ->getPath();
     }
     
-   /**
-    * Reads a specific line number from the target file and returns its
-    * contents, if the file has such a line. Does so with little memory
-    * usage, as the file is not read entirely into memory.
-    * 
-    * @param string|PathInfoInterface|SplFileInfo $path
-    * @param int $lineNumber Note: 1-based; the first line is number 1.
-    * @return string|NULL Will return null if the requested line does not exist.
-    * @throws FileHelper_Exception
-    * 
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
-    */
+    /**
+     * Reads a specific line number from the target file and returns its
+     * contents, if the file has such a line. Does so with little memory
+     * usage, as the file is not read entirely into memory.
+     * 
+     * @param string|PathInfoInterface|SplFileInfo $path
+     * @param int $lineNumber Note: 1-based; the first line is number 1.
+     * @return string|NULL Will return null if the requested line does not exist.
+     * @throws FileHelper_Exception
+     * 
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
+     */
     public static function getLineFromFile($path, int $lineNumber) : ?string
     {
         return self::getFileInfo($path)->getLine($lineNumber);
@@ -792,33 +792,33 @@ 
             ->getLines($amount);
     }
     
-   /**
-    * Reads all content from a file.
-    * 
-    * @param string|PathInfoInterface|SplFileInfo $filePath
-    * @throws FileHelper_Exception
-    * @return string
-    * 
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
-    * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS
-    */
+    /**
+     * Reads all content from a file.
+     * 
+     * @param string|PathInfoInterface|SplFileInfo $filePath
+     * @throws FileHelper_Exception
+     * @return string
+     * 
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
+     * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS
+     */
     public static function readContents($filePath) : string
     {
         return self::getFileInfo($filePath)->getContents();
     }
 
-   /**
-    * Ensures that the target path exists on disk, and is a folder.
-    * 
-    * @param string|PathInfoInterface|SplFileInfo $path
-    * @return string The real path, with normalized slashes.
-    * @throws FileHelper_Exception
-    * 
-    * @see FileHelper::normalizePath()
-    * 
-    * @see FileHelper::ERROR_FOLDER_DOES_NOT_EXIST
-    * @see FileHelper::ERROR_PATH_IS_NOT_A_FOLDER
-    */
+    /**
+     * Ensures that the target path exists on disk, and is a folder.
+     * 
+     * @param string|PathInfoInterface|SplFileInfo $path
+     * @return string The real path, with normalized slashes.
+     * @throws FileHelper_Exception
+     * 
+     * @see FileHelper::normalizePath()
+     * 
+     * @see FileHelper::ERROR_FOLDER_DOES_NOT_EXIST
+     * @see FileHelper::ERROR_PATH_IS_NOT_A_FOLDER
+     */
     public static function requireFolderExists($path) : string
     {
         return self::getFolderInfo($path)

Spacing +20 added lines, -20 removed lines

@@ -208,7 +208,7 @@ 
     public static function detectMimeType($fileName) : ?string
     {
         $ext = self::getExtension($fileName);
-        if(empty($ext)) {
+        if (empty($ext)) {
             return null;
         }
 
@@ -252,7 +252,7 @@ 
      * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
      * @see FileHelper::ERROR_UNKNOWN_FILE_MIME_TYPE
      */
-    public static function sendFile($filePath, ?string $fileName = null, bool $asAttachment=true) : void
+    public static function sendFile($filePath, ?string $fileName = null, bool $asAttachment = true) : void
     {
         self::getFileInfo($filePath)->getDownloader()->send($fileName, $asAttachment);
     }
@@ -269,7 +269,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)
@@ -324,7 +324,7 @@ 
     {
         $info = self::getPathInfo($pathOrDirIterator);
 
-        if($extension === true || $info instanceof FolderInfo)
+        if ($extension === true || $info instanceof FolderInfo)
         {
             return $info->getName();
         }
@@ -346,7 +346,7 @@ 
      * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE
      * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE
      */
-    public static function parseJSONFile($file, string $targetEncoding='', $sourceEncoding=null) : array
+    public static function parseJSONFile($file, string $targetEncoding = '', $sourceEncoding = null) : array
     {
         return JSONFile::factory($file)
             ->setTargetEncoding($targetEncoding)
@@ -399,7 +399,7 @@ 
      * @throws FileHelper_Exception
      * @see FileHelper::createFileFinder()
      */
-    public static function findHTMLFiles($targetFolder, array $options=array()) : array
+    public static function findHTMLFiles($targetFolder, array $options = array()) : array
     {
         return self::findFiles($targetFolder, array('html'), $options);
     }
@@ -418,7 +418,7 @@ 
      * @throws FileHelper_Exception
      * @see FileHelper::createFileFinder()
      */
-    public static function findPHPFiles($targetFolder, array $options=array()) : array
+    public static function findPHPFiles($targetFolder, array $options = array()) : array
     {
         return self::findFiles($targetFolder, array('php'), $options);
     }
@@ -440,7 +440,7 @@ 
     * @see FileHelper::createFileFinder()
     * @deprecated Use the file finder instead.
     */
-    public static function findFiles($targetFolder, array $extensions=array(), array $options=array()) : array
+    public static function findFiles($targetFolder, array $extensions = array(), array $options = array()) : array
     {
         $finder = self::createFileFinder($targetFolder);
 
@@ -450,16 +450,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();
         }
@@ -478,7 +478,7 @@ 
      * @return string
      * @throws FileHelper_Exception
      */
-    public static function removeExtension($filename, bool $keepPath=false) : string
+    public static function removeExtension($filename, bool $keepPath = false) : string
     {
         return self::getFileInfo($filename)->removeExtension($keepPath);
     }
@@ -490,7 +490,7 @@ 
 
     public static function createUnicodeHandling() : UnicodeHandling
     {
-        if(!isset(self::$unicodeHandling))
+        if (!isset(self::$unicodeHandling))
         {
             self::$unicodeHandling = new UnicodeHandling();
         }
@@ -524,7 +524,7 @@ 
      * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
      * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
      */
-    public static function saveAsJSON($data, $file, bool $pretty=false) : JSONFile
+    public static function saveAsJSON($data, $file, bool $pretty = false) : JSONFile
     {
         return JSONFile::factory($file)->putData($data, $pretty);
     }
@@ -542,7 +542,7 @@ 
      * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
      * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
      */
-    public static function saveFile($filePath, string $content='') : FileInfo
+    public static function saveFile($filePath, string $content = '') : FileInfo
     {
         return self::getFileInfo($filePath)->putContents($content);
     }
@@ -654,7 +654,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
     {
         return PathRelativizer::relativizeByDepth($path, $depth);
     }
@@ -693,7 +693,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()
@@ -707,7 +707,7 @@ 
      * @return string
      * @throws FileHelper_Exception
      */
-    public static function requireFileReadable($path, ?int $errorCode=null) : string
+    public static function requireFileReadable($path, ?int $errorCode = null) : string
     {
         return self::getPathInfo($path)
             ->requireIsFile()
@@ -785,7 +785,7 @@ 
      * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
      * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES
      */
-    public static function readLines($filePath, int $amount=0) : array
+    public static function readLines($filePath, int $amount = 0) : array
     {
         return self::getFileInfo($filePath)
             ->getLineReader()
@@ -835,7 +835,7 @@ 
      *
      * @throws FileHelper_Exception
      */
-    public static function createPathsReducer(array $paths=array()) : PathsReducer
+    public static function createPathsReducer(array $paths = array()) : PathsReducer
     {
         return new PathsReducer($paths);
     }

src/FileHelper/JSONFile.php

Spacing +4 added lines, -4 removed lines

@@ -43,13 +43,13 @@ 
      */
     public static function factory($path) : JSONFile
     {
-        if($path instanceof self) {
+        if ($path instanceof self) {
             return $path;
         }
 
         $instance = self::createInstance($path);
 
-        if($instance instanceof self) {
+        if ($instance instanceof self) {
             return $instance;
         }
 
@@ -128,7 +128,7 @@ 
 
     private function convertEncoding(string $contents) : string
     {
-        if(!empty($this->targetEncoding))
+        if (!empty($this->targetEncoding))
         {
             return (string)mb_convert_encoding(
                 $contents,
@@ -150,7 +150,7 @@ 
     {
         $options = null;
 
-        if($pretty)
+        if ($pretty)
         {
             $options = JSON_PRETTY_PRINT;
         }

Braces +2 added lines, -4 removed lines

@@ -101,8 +101,7 @@ 
                 512,
                 JSON_THROW_ON_ERROR
             );
-        }
-        catch (JsonException $e)
+        } catch (JsonException $e)
         {
             throw new FileHelper_Exception(
                 'Cannot decode json data',
@@ -162,8 +161,7 @@ 
             $this->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/AbstractPathInfo.php

Spacing +15 added lines, -15 removed lines

@@ -96,7 +96,7 @@ 
 
         $path = realpath($this->path);
 
-        if($path !== false)
+        if ($path !== false)
         {
             return FileHelper::normalizePath($path);
         }
@@ -115,14 +115,14 @@ 
      * @return $this
      * @throws FileHelper_Exception
      */
-    private function requireTrue(bool $condition, string $conditionLabel, ?int $errorCode=null) : self
+    private function requireTrue(bool $condition, string $conditionLabel, ?int $errorCode = null) : self
     {
-        if($condition === true)
+        if ($condition === true)
         {
             return $this;
         }
 
-        if($errorCode === null)
+        if ($errorCode === null)
         {
             $errorCode = FileHelper::ERROR_FILE_DOES_NOT_EXIST;
         }
@@ -139,7 +139,7 @@ 
      * @return $this
      * @throws FileHelper_Exception
      */
-    public function requireExists(?int $errorCode=null) : self
+    public function requireExists(?int $errorCode = null) : self
     {
         return $this->requireTrue(
             !empty($this->path) && realpath($this->path) !== false,
@@ -153,7 +153,7 @@ 
      * @return $this
      * @throws FileHelper_Exception
      */
-    public function requireReadable(?int $errorCode=null) : self
+    public function requireReadable(?int $errorCode = null) : self
     {
         $this->requireExists($errorCode);
 
@@ -169,7 +169,7 @@ 
      * @return $this
      * @throws FileHelper_Exception
      */
-    public function requireWritable(?int $errorCode=null) : self
+    public function requireWritable(?int $errorCode = null) : self
     {
         return $this->requireTrue(
             $this->isWritable(),
@@ -186,7 +186,7 @@ 
      */
     public function requireIsFile() : FileInfo
     {
-        if($this instanceof FileInfo)
+        if ($this instanceof FileInfo)
         {
             return $this;
         }
@@ -209,7 +209,7 @@ 
      */
     public function requireIsFolder() : FolderInfo
     {
-        if($this instanceof FolderInfo)
+        if ($this instanceof FolderInfo)
         {
             return $this;
         }
@@ -230,12 +230,12 @@ 
      */
     public static function type2string($path) : string
     {
-        if($path instanceof PathInfoInterface)
+        if ($path instanceof PathInfoInterface)
         {
             return $path->getPath();
         }
 
-        if($path instanceof SplFileInfo)
+        if ($path instanceof SplFileInfo)
         {
             return $path->getPathname();
         }
@@ -257,19 +257,19 @@ 
      */
     public static function resolveType($path) : PathInfoInterface
     {
-        if($path instanceof PathInfoInterface)
+        if ($path instanceof PathInfoInterface)
         {
             return $path;
         }
 
         $path = self::type2string($path);
 
-        if(FolderInfo::is_dir($path))
+        if (FolderInfo::is_dir($path))
         {
             return FolderInfo::factory($path);
         }
 
-        if(FileInfo::is_file($path))
+        if (FileInfo::is_file($path))
         {
             return FileInfo::factory($path);
         }
@@ -327,7 +327,7 @@ 
     public function getModifiedDate() : ?DateTime
     {
         $time = filemtime($this->getPath());
-        if($time === false) {
+        if ($time === false) {
             return null;
         }
 

src/FileHelper/FileFinder.php

Indentation +130 added lines, -130 removed lines

@@ -44,20 +44,20 @@ 
 
     protected FolderInfo $path;
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected array $found = array();
     
-   /**
-    * The path must exist when the class is instantiated: its
-    * real path will be determined to work with.
-    * 
-    * @param string|PathInfoInterface|SplFileInfo $path The absolute path to the target folder.
-    *
-    * @throws FileHelper_Exception
-    * @see FileHelper::ERROR_PATH_IS_NOT_A_FOLDER
-    */
+    /**
+     * The path must exist when the class is instantiated: its
+     * real path will be determined to work with.
+     * 
+     * @param string|PathInfoInterface|SplFileInfo $path The absolute path to the target folder.
+     *
+     * @throws FileHelper_Exception
+     * @see FileHelper::ERROR_PATH_IS_NOT_A_FOLDER
+     */
     public function __construct($path)
     {
         $this->path = AbstractPathInfo::resolveType($path)->requireExists()->requireIsFolder();
@@ -75,11 +75,11 @@ 
         );
     }
     
-   /**
-    * Enables extension stripping, to return file names without extension.
-    * 
-    * @return FileFinder
-    */
+    /**
+     * Enables extension stripping, to return file names without extension.
+     * 
+     * @return FileFinder
+     */
     public function stripExtensions() : FileFinder
     {
         return $this->setOption('strip-extensions', true);
@@ -96,46 +96,46 @@ 
         return $this->setOption('recursive', $enabled);
     }
     
-   /**
-    * Retrieves all extensions that were added to
-    * the list of included extensions.
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves all extensions that were added to
+     * the list of included extensions.
+     * 
+     * @return string[]
+     */
     public function getIncludeExtensions() : array
     {
         return $this->getArrayOption(self::OPTION_INCLUDE_EXTENSIONS);
     }
     
-   /**
-    * Includes a single extension in the file search: only
-    * files with this extension will be used in the results.
-    * 
-    * NOTE: Included extensions take precedence before excluded
-    * extensions. If any excluded extensions are specified, they
-    * will be ignored.
-    * 
-    * @param string $extension Extension name, without dot (`php` for example).
-    * @return FileFinder
-    * @see FileFinder::includeExtensions()
-    */
+    /**
+     * Includes a single extension in the file search: only
+     * files with this extension will be used in the results.
+     * 
+     * NOTE: Included extensions take precedence before excluded
+     * extensions. If any excluded extensions are specified, they
+     * will be ignored.
+     * 
+     * @param string $extension Extension name, without dot (`php` for example).
+     * @return FileFinder
+     * @see FileFinder::includeExtensions()
+     */
     public function includeExtension(string $extension) : FileFinder
     {
         return $this->includeExtensions(array($extension));
     }
     
-   /**
-    * Includes several extensions in the file search: only
-    * files with these extensions wil be used in the results.
-    * 
-    * NOTE: Included extensions take precedence before excluded
-    * extensions. If any excluded extensions are specified, they
-    * will be ignored.
-    * 
-    * @param string[] $extensions Extension names, without dot (`php` for example).
-    * @return FileFinder
-    * @see FileFinder::includeExtension()
-    */
+    /**
+     * Includes several extensions in the file search: only
+     * files with these extensions wil be used in the results.
+     * 
+     * NOTE: Included extensions take precedence before excluded
+     * extensions. If any excluded extensions are specified, they
+     * will be ignored.
+     * 
+     * @param string[] $extensions Extension names, without dot (`php` for example).
+     * @return FileFinder
+     * @see FileFinder::includeExtension()
+     */
     public function includeExtensions(array $extensions) : FileFinder
     {
         $items = $this->getIncludeExtensions();
@@ -146,37 +146,37 @@ 
         return $this;
     }
 
-   /**
-    * Retrieves a list of all extensions currently set as 
-    * excluded from the search.
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves a list of all extensions currently set as 
+     * excluded from the search.
+     * 
+     * @return string[]
+     */
     public function getExcludeExtensions() : array
     {
         return $this->getArrayOption(self::OPTION_EXCLUDE_EXTENSIONS);
     }
     
-   /**
-    * Excludes a single extension from the search.
-    * 
-    * @param string $extension Extension name, without dot (`php` for example).
-    * @return FileFinder
-    * @see FileFinder::excludeExtensions()
-    */
+    /**
+     * Excludes a single extension from the search.
+     * 
+     * @param string $extension Extension name, without dot (`php` for example).
+     * @return FileFinder
+     * @see FileFinder::excludeExtensions()
+     */
     public function excludeExtension(string $extension) : FileFinder
     {
         return $this->excludeExtensions(array($extension));
     }
 
-   /**
-    * Add several extensions to the list of extensions to
-    * exclude from the file search.
-    *  
-    * @param string[] $extensions Extension names, without dot (`php` for example).
-    * @return FileFinder
-    * @see FileFinder::excludeExtension()
-    */
+    /**
+     * Add several extensions to the list of extensions to
+     * exclude from the file search.
+     *  
+     * @param string[] $extensions Extension names, without dot (`php` for example).
+     * @return FileFinder
+     * @see FileFinder::excludeExtension()
+     */
     public function excludeExtensions(array $extensions) : FileFinder
     {
         $items = $this->getExcludeExtensions();
@@ -187,52 +187,52 @@ 
         return $this;
     }
     
-   /**
-    * In this mode, the entire path to the file will be stripped,
-    * leaving only the file name in the files list.
-    * 
-    * @return FileFinder
-    */
+    /**
+     * In this mode, the entire path to the file will be stripped,
+     * leaving only the file name in the files list.
+     * 
+     * @return FileFinder
+     */
     public function setPathmodeStrip() : FileFinder
     {
         return $this->setPathmode(self::PATH_MODE_STRIP);
     }
     
-   /**
-    * In this mode, only the path relative to the source folder
-    * will be included in the files list.
-    * 
-    * @return FileFinder
-    */
+    /**
+     * In this mode, only the path relative to the source folder
+     * will be included in the files list.
+     * 
+     * @return FileFinder
+     */
     public function setPathmodeRelative() : FileFinder
     {
         return $this->setPathmode(self::PATH_MODE_RELATIVE);
     }
     
-   /**
-    * In this mode, the full, absolute paths to the files will
-    * be included in the files list.
-    * 
-    * @return FileFinder
-    */
+    /**
+     * In this mode, the full, absolute paths to the files will
+     * be included in the files list.
+     * 
+     * @return FileFinder
+     */
     public function setPathmodeAbsolute() : FileFinder
     {
         return $this->setPathmode(self::PATH_MODE_ABSOLUTE);
     }
     
-   /**
-    * This sets a character or string to replace the slashes
-    * in the paths with. 
-    * 
-    * This is used for example in the `getPHPClassNames()` 
-    * method, to return files from subfolders as class names
-    * using the "_" character:
-    * 
-    * Subfolder/To/File.php => Subfolder_To_File.php
-    * 
-    * @param string $character
-    * @return FileFinder
-    */
+    /**
+     * This sets a character or string to replace the slashes
+     * in the paths with. 
+     * 
+     * This is used for example in the `getPHPClassNames()` 
+     * method, to return files from subfolders as class names
+     * using the "_" character:
+     * 
+     * Subfolder/To/File.php => Subfolder_To_File.php
+     * 
+     * @param string $character
+     * @return FileFinder
+     */
     public function setSlashReplacement(string $character) : FileFinder
     {
         return $this->setOption('slash-replacement', $character);
@@ -255,12 +255,12 @@ 
         return $this->setOption(self::OPTION_PATHMODE, $mode);
     }
     
-   /**
-    * Retrieves a list of all matching file names/paths,
-    * depending on the selected options.
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves a list of all matching file names/paths,
+     * depending on the selected options.
+     * 
+     * @return string[]
+     */
     public function getAll() : array
     {
         $this->find((string)$this->path, true);
@@ -268,24 +268,24 @@ 
         return $this->found;
     }
     
-   /**
-    * Retrieves only PHP files. Can be combined with other
-    * options like enabling recursion into sub-folders.
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves only PHP files. Can be combined with other
+     * options like enabling recursion into sub-folders.
+     * 
+     * @return string[]
+     */
     public function getPHPFiles() : array
     {
         $this->includeExtensions(array('php'));
         return $this->getAll();
     }
     
-   /**
-    * Generates PHP class names from file paths: it replaces
-    * slashes with underscores, and removes file extensions.
-    * 
-    * @return string[] An array of PHP file names without extension.
-    */
+    /**
+     * Generates PHP class names from file paths: it replaces
+     * slashes with underscores, and removes file extensions.
+     * 
+     * @return string[] An array of PHP file names without extension.
+     */
     public function getPHPClassNames() : array
     {
         $this->includeExtensions(array('php'));
@@ -356,13 +356,13 @@ 
         return $path;
     }
     
-   /**
-    * Checks whether the specified extension is allowed 
-    * with the current settings.
-    * 
-    * @param string $extension
-    * @return bool
-    */
+    /**
+     * Checks whether the specified extension is allowed 
+     * with the current settings.
+     * 
+     * @param string $extension
+     * @return bool
+     */
     protected function filterExclusion(string $extension) : bool
     {
         $include = $this->getOption(self::OPTION_INCLUDE_EXTENSIONS);
@@ -382,12 +382,12 @@ 
         return true;
     }
     
-   /**
-    * Adjusts the path according to the selected path mode.
-    * 
-    * @param string $path
-    * @return string
-    */
+    /**
+     * Adjusts the path according to the selected path mode.
+     * 
+     * @param string $path
+     * @return string
+     */
     protected function filterPath(string $path) : string
     {
         switch($this->getStringOption(self::OPTION_PATHMODE))

src/FileHelper/PHPClassInfo.php

Indentation +39 added lines, -39 removed lines

@@ -35,11 +35,11 @@ 
      */
     protected $classes = array();
     
-   /**
-    * @param PHPFile $path The path to the PHP file to parse.
-    * @throws FileHelper_Exception
-    * @see FileHelper::findPHPClasses()
-    */
+    /**
+     * @param PHPFile $path The path to the PHP file to parse.
+     * @throws FileHelper_Exception
+     * @see FileHelper::findPHPClasses()
+     */
     public function __construct(PHPFile $path)
     {
         $this->file = $path
@@ -49,58 +49,58 @@ 
         $this->parseFile();
     }
     
-   /**
-    * The name of the namespace of the classes in the file, if any.
-    * @return string
-    */
+    /**
+     * The name of the namespace of the classes in the file, if any.
+     * @return string
+     */
     public function getNamespace() : string
     {
         return $this->namespace;
     }
     
-   /**
-    * Whether the file contains a namespace.
-    * @return bool
-    */
+    /**
+     * Whether the file contains a namespace.
+     * @return bool
+     */
     public function hasNamespace() : bool
     {
         return !empty($this->namespace);
     }
     
-   /**
-    * The absolute path to the file.
-    * @return string
-    */
+    /**
+     * The absolute path to the file.
+     * @return string
+     */
     public function getPath() : string
     {
         return $this->file->getPath();
     }
    
-   /**
-    * Whether any classes were found in the file.
-    * @return bool
-    */
+    /**
+     * Whether any classes were found in the file.
+     * @return bool
+     */
     public function hasClasses() : bool
     {
         return !empty($this->classes);
     }
     
-   /**
-    * The names of the classes that were found in the file (with namespace if any).
-    * @return string[]
-    */
+    /**
+     * The names of the classes that were found in the file (with namespace if any).
+     * @return string[]
+     */
     public function getClassNames() : array
     {
         return array_keys($this->classes);
     }
     
-   /**
-    * Retrieves all classes that were detected in the file,
-    * which can be used to retrieve more information about
-    * them.
-    * 
-    * @return FileHelper_PHPClassInfo_Class[]
-    */
+    /**
+     * Retrieves all classes that were detected in the file,
+     * which can be used to retrieve more information about
+     * them.
+     * 
+     * @return FileHelper_PHPClassInfo_Class[]
+     */
     public function getClasses() : array
     {
         return array_values($this->classes);
@@ -146,13 +146,13 @@ 
         }
     }
 
-   /**
-    * Strips all whitespace from the string, replacing it with 
-    * regular spaces (newlines, tabs, etc.).
-    * 
-    * @param string $string
-    * @return string
-    */
+    /**
+     * Strips all whitespace from the string, replacing it with 
+     * regular spaces (newlines, tabs, etc.).
+     * 
+     * @param string $string
+     * @return string
+     */
     protected function stripWhitespace(string $string) : string 
     {
         return preg_replace('/\s/', ' ', $string);

Spacing +4 added lines, -4 removed lines

@@ -112,25 +112,25 @@
 
         $result = array();
         preg_match_all('/namespace\s+([^;]+);/ix', $code, $result, PREG_PATTERN_ORDER);
-        if(isset($result[0][0])) {
+        if (isset($result[0][0])) {
             $this->namespace = trim($result[1][0]);
         }
         
         $result = array();
         preg_match_all('/(abstract|final)\s+(class|trait)\s+([\sa-z\d\\\\_,]+){|(class|trait)\s+([\sa-z\d\\\\_,]+){/ix', $code, $result, PREG_PATTERN_ORDER);
 
-        if(!isset($result[0][0])) {
+        if (!isset($result[0][0])) {
             return;
         }
         
         $indexes = array_keys($result[0]);
         
-        foreach($indexes as $idx)
+        foreach ($indexes as $idx)
         {
             $keyword = $result[1][$idx];
             $declaration = $result[3][$idx];
             $type = $result[2][$idx];
-            if(empty($keyword)) {
+            if (empty($keyword)) {
                 $type = $result[4][$idx];
                 $declaration = $result[5][$idx];
             }

src/FileHelper/PathInfoInterface.php

Spacing +1 added lines, -1 removed lines

@@ -24,7 +24,7 @@
 interface PathInfoInterface
 {
     public function getName() : string;
-    public function getExtension(bool $lowercase=true) : string;
+    public function getExtension(bool $lowercase = true) : string;
     public function getPath() : string;
     public function getFolderPath() : string;
     public function exists() : bool;

src/FileHelper/FileInfo.php

Spacing +17 added lines, -17 removed lines

@@ -50,7 +50,7 @@ 
      */
     public static function factory($path) : FileInfo
     {
-        if($path instanceof self) {
+        if ($path instanceof self) {
             return $path;
         }
 
@@ -67,12 +67,12 @@ 
         $pathString = AbstractPathInfo::type2string($path);
         $key = $pathString.';'.static::class;
 
-        if(!isset(self::$infoCache[$key]))
+        if (!isset(self::$infoCache[$key]))
         {
             $class = static::class;
             $instance = new $class($pathString);
 
-            if(!$instance instanceof self) {
+            if (!$instance instanceof self) {
                 throw new FileHelper_Exception(
                     'Invalid class'
                 );
@@ -106,7 +106,7 @@ 
     {
         parent::__construct($path);
 
-        if(!self::is_file($this->path))
+        if (!self::is_file($this->path))
         {
             throw new FileHelper_Exception(
                 'Not a file path',
@@ -120,7 +120,7 @@ 
     {
         $path = trim($path);
 
-        if(empty($path))
+        if (empty($path))
         {
             return false;
         }
@@ -128,9 +128,9 @@ 
         return is_file($path) || pathinfo($path, PATHINFO_EXTENSION) !== '';
     }
 
-    public function removeExtension(bool $keepPath=false) : string
+    public function removeExtension(bool $keepPath = false) : string
     {
-        if(!$keepPath)
+        if (!$keepPath)
         {
             return (string)pathinfo($this->getName(), PATHINFO_FILENAME);
         }
@@ -144,11 +144,11 @@ 
         return implode('/', $parts);
     }
 
-    public function getExtension(bool $lowercase=true) : string
+    public function getExtension(bool $lowercase = true) : string
     {
         $ext = (string)pathinfo($this->path, PATHINFO_EXTENSION);
 
-        if($lowercase)
+        if ($lowercase)
         {
             $ext = mb_strtolower($ext);
         }
@@ -169,12 +169,12 @@ 
      */
     public function delete() : FileInfo
     {
-        if(!$this->exists())
+        if (!$this->exists())
         {
             return $this;
         }
 
-        if(unlink($this->path))
+        if (unlink($this->path))
         {
             return $this;
         }
@@ -201,7 +201,7 @@ 
     {
         $target = $this->checkCopyPrerequisites($targetPath);
 
-        if(copy($this->path, (string)$target))
+        if (copy($this->path, (string)$target))
         {
             return $target;
         }
@@ -253,7 +253,7 @@ 
      */
     public function getLineReader() : LineReader
     {
-        if($this->lineReader !== null)
+        if ($this->lineReader !== null)
         {
             $this->lineReader = new LineReader($this);
         }
@@ -272,7 +272,7 @@ 
 
         $result = file_get_contents($this->getPath());
 
-        if($result !== false) {
+        if ($result !== false) {
             return $result;
         }
 
@@ -294,7 +294,7 @@ 
      */
     public function putContents(string $content) : FileInfo
     {
-        if($this->exists())
+        if ($this->exists())
         {
             $this->requireWritable();
         }
@@ -305,7 +305,7 @@ 
                 ->requireWritable();
         }
 
-        if(file_put_contents($this->path, $content) !== false)
+        if (file_put_contents($this->path, $content) !== false)
         {
             return $this;
         }
@@ -335,7 +335,7 @@ 
      */
     private function createFolder() : FileInfo
     {
-        if(!$this->exists())
+        if (!$this->exists())
         {
             FolderInfo::factory($this->getFolderPath())
                 ->create()

src/FileHelper/FolderTree.php

Braces +3 added lines, -6 removed lines

@@ -42,8 +42,7 @@ 
         {
             $info->delete();
             return true;
-        }
-        catch (FileHelper_Exception $e)
+        } catch (FileHelper_Exception $e)
         {
 
         }
@@ -78,8 +77,7 @@ 
             try
             {
                 FileHelper::deleteFile($item);
-            }
-            catch (FileHelper_Exception $e)
+            } catch (FileHelper_Exception $e)
             {
                 return false;
             }
@@ -125,8 +123,7 @@ 
         if ($item->isFolder())
         {
             self::copy($item, $target . '/' . $item->getName());
-        }
-        else if($item->isFile())
+        } else if($item->isFile())
         {
             $item
                 ->requireIsFile()

src/FileHelper/SerializedFile.php

Spacing +3 added lines, -3 removed lines

@@ -32,13 +32,13 @@ 
      */
     public static function factory($path) : SerializedFile
     {
-        if($path instanceof self) {
+        if ($path instanceof self) {
             return $path;
         }
 
         $instance = self::createInstance($path);
 
-        if($instance instanceof self) {
+        if ($instance instanceof self) {
             return $instance;
         }
 
@@ -73,7 +73,7 @@ 
             )
         );
 
-        if($result !== false) {
+        if ($result !== false) {
             return $result;
         }