Mistralys / application-utils

src/functions.php

Spacing +7 added lines, -7 removed lines

@@ -12,9 +12,9 @@ 
  * @param bool $forceNew
  * @return NumberInfo
  */
-function parseNumber($value, bool $forceNew=false)
+function parseNumber($value, bool $forceNew = false)
 {
-    if($value instanceof NumberInfo && $forceNew !== true) {
+    if ($value instanceof NumberInfo && $forceNew !== true) {
         return $value;
     }
     
@@ -109,7 +109,7 @@ 
     $args = func_get_args();
     
     // is the localization package installed?
-    if(function_exists('\AppLocalize\t'))
+    if (function_exists('\AppLocalize\t'))
     {
         return call_user_func_array('\AppLocalize\t', $args);
     }
@@ -124,7 +124,7 @@ 
  * @param bool $initial The initial boolean value to use.
  * @return Value_Bool
  */
-function valBool(bool $initial=false) : Value_Bool
+function valBool(bool $initial = false) : Value_Bool
 {
     return new Value_Bool($initial);
 }
@@ -137,7 +137,7 @@ 
  * @param bool $initial
  * @return Value_Bool_True
  */
-function valBoolTrue(bool $initial=false) : Value_Bool_True
+function valBoolTrue(bool $initial = false) : Value_Bool_True
 {
     return new Value_Bool_True($initial);
 }
@@ -150,7 +150,7 @@ 
  * @param bool $initial
  * @return Value_Bool_False
  */
-function valBoolFalse(bool $initial=true) : Value_Bool_False
+function valBoolFalse(bool $initial = true) : Value_Bool_False
 {
     return new Value_Bool_False($initial);
 }
@@ -181,7 +181,7 @@ 
  */
 function init() : void
 {
-    if(!class_exists('\AppLocalize\Localization')) {
+    if (!class_exists('\AppLocalize\Localization')) {
         return;
     }
     

src/FileHelper.php

Indentation +233 added lines, -233 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 $file
-    * @throws FileHelper_Exception
-    * @return array<int|string,mixed>
-    * @see SerializedFile::parse()
-    * 
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
-    * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ
-    * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED
-    */
+    /**
+     * Opens a serialized file and returns the unserialized data.
+     *
+     * @param string $file
+     * @throws FileHelper_Exception
+     * @return array<int|string,mixed>
+     * @see SerializedFile::parse()
+     * 
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
+     * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ
+     * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED
+     */
     public static function parseSerializedFile(string $file) : array
     {
         return SerializedFile::factory(self::getFileInfo($file))
@@ -104,13 +104,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 $sourcePath
-    * @param string $targetPath
-    * @throws FileHelper_Exception
-    * 
-    * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
-    * @see FileHelper::ERROR_SOURCE_FILE_NOT_FOUND
-    * @see FileHelper::ERROR_SOURCE_FILE_NOT_READABLE
-    * @see FileHelper::ERROR_TARGET_COPY_FOLDER_NOT_WRITABLE
-    * @see FileHelper::ERROR_CANNOT_COPY_FILE
-    */
+    /**
+     * Copies a file to the target location. Includes checks
+     * for most error sources, like the source file not being
+     * readable. Automatically creates the target folder if it
+     * does not exist yet.
+     * 
+     * @param string $sourcePath
+     * @param string $targetPath
+     * @throws FileHelper_Exception
+     * 
+     * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
+     * @see FileHelper::ERROR_SOURCE_FILE_NOT_FOUND
+     * @see FileHelper::ERROR_SOURCE_FILE_NOT_READABLE
+     * @see FileHelper::ERROR_TARGET_COPY_FOLDER_NOT_WRITABLE
+     * @see FileHelper::ERROR_CANNOT_COPY_FILE
+     */
     public static function copyFile(string $sourcePath, string $targetPath) : void
     {
         self::getFileInfo($sourcePath)->copyTo($targetPath);
     }
     
-   /**
-    * Deletes the target file. Ignored if it cannot be found,
-    * and throws an exception if it fails.
-    * 
-    * @param string $filePath
-    * @throws FileHelper_Exception
-    * 
-    * @see FileHelper::ERROR_CANNOT_DELETE_FILE
-    */
+    /**
+     * Deletes the target file. Ignored if it cannot be found,
+     * and throws an exception if it fails.
+     * 
+     * @param string $filePath
+     * @throws FileHelper_Exception
+     * 
+     * @see FileHelper::ERROR_CANNOT_DELETE_FILE
+     */
     public static function deleteFile(string $filePath) : void
     {
         self::getFileInfo($filePath)->delete();
@@ -272,29 +272,29 @@ 
             ->download();
     }
     
-   /**
-    * Verifies whether the target file is a PHP file. The path
-    * to the file can be a path to a file as a string, or a 
-    * DirectoryIterator object instance.
-    * 
-    * @param string|DirectoryIterator $pathOrDirIterator
-    * @return boolean
-    */
+    /**
+     * Verifies whether the target file is a PHP file. The path
+     * to the file can be a path to a file as a string, or a 
+     * DirectoryIterator object instance.
+     * 
+     * @param string|DirectoryIterator $pathOrDirIterator
+     * @return boolean
+     */
     public static function isPHPFile($pathOrDirIterator) : bool
     {
-    	return self::getExtension($pathOrDirIterator) === 'php';
+        return self::getExtension($pathOrDirIterator) === 'php';
     }
     
-   /**
-    * Retrieves the extension of the specified file. Can be a path
-    * to a file as a string, or a DirectoryIterator object instance.
-    *
-    * NOTE: A folder will return an empty string.
-    * 
-    * @param string|DirectoryIterator $pathOrDirIterator
-    * @param bool $lowercase
-    * @return string
-    */
+    /**
+     * Retrieves the extension of the specified file. Can be a path
+     * to a file as a string, or a DirectoryIterator object instance.
+     *
+     * NOTE: A folder will return an empty string.
+     * 
+     * @param string|DirectoryIterator $pathOrDirIterator
+     * @param bool $lowercase
+     * @return string
+     */
     public static function getExtension($pathOrDirIterator, bool $lowercase = true) : string
     {
         $info = self::getPathInfo($pathOrDirIterator);
@@ -307,18 +307,18 @@ 
         return '';
     }
     
-   /**
-    * Retrieves the file name from a path, with or without extension.
-    * The path to the file can be a string, or a DirectoryIterator object
-    * instance.
-    * 
-    * In case of folders, behaves like the "pathinfo" function: returns
-    * the name of the folder.
-    * 
-    * @param string|DirectoryIterator $pathOrDirIterator
-    * @param bool $extension
-    * @return string
-    */
+    /**
+     * Retrieves the file name from a path, with or without extension.
+     * The path to the file can be a string, or a DirectoryIterator object
+     * instance.
+     * 
+     * In case of folders, behaves like the "pathinfo" function: returns
+     * the name of the folder.
+     * 
+     * @param string|DirectoryIterator $pathOrDirIterator
+     * @param bool $extension
+     * @return string
+     */
     public static function getFilename($pathOrDirIterator, bool $extension = true) : string
     {
         $info = self::getPathInfo($pathOrDirIterator);
@@ -352,16 +352,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);
@@ -421,23 +421,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|DirectoryIterator $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|DirectoryIterator $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);
@@ -467,14 +467,14 @@ 
         return $finder->getAll();
     }
 
-   /**
-    * Removes the extension from the specified path or file name,
-    * if any, and returns the name without the extension.
-    * 
-    * @param string $filename
-    * @param bool $keepPath Whether to keep the path component, if any. Default PHP pathinfo behavior is not to.
-    * @return string
-    */
+    /**
+     * Removes the extension from the specified path or file name,
+     * if any, and returns the name without the extension.
+     * 
+     * @param string $filename
+     * @param bool $keepPath Whether to keep the path component, if any. Default PHP pathinfo behavior is not to.
+     * @return string
+     */
     public static function removeExtension(string $filename, bool $keepPath=false) : string
     {
         return self::getFileInfo($filename)->removeExtension($keepPath);
@@ -495,49 +495,49 @@ 
         return self::$unicodeHandling;
     }
     
-   /**
-    * Normalizes the slash style in a file or folder path,
-    * by replacing any anti-slashes with forward slashes.
-    * 
-    * @param string $path
-    * @return string
-    */
+    /**
+     * Normalizes the slash style in a file or folder path,
+     * by replacing any anti-slashes with forward slashes.
+     * 
+     * @param string $path
+     * @return string
+     */
     public static function normalizePath(string $path) : string
     {
         return str_replace(array('\\', '//'), array('/', '/'), $path);
     }
     
-   /**
-    * Saves the specified data to a file, JSON encoded.
-    * 
-    * @param mixed $data
-    * @param string $file
-    * @param bool $pretty
-    * @throws FileHelper_Exception
-    * 
-    * @see FileHelper::ERROR_JSON_ENCODE_ERROR
-    * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE
-    * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
-    * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
-    */
+    /**
+     * Saves the specified data to a file, JSON encoded.
+     * 
+     * @param mixed $data
+     * @param string $file
+     * @param bool $pretty
+     * @throws FileHelper_Exception
+     * 
+     * @see FileHelper::ERROR_JSON_ENCODE_ERROR
+     * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE
+     * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
+     * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
+     */
     public static function saveAsJSON($data, string $file, bool $pretty=false) : void
     {
         JSONFile::factory(self::getFileInfo($file))
             ->putData($data, $pretty);
     }
    
-   /**
-    * Saves the specified content to the target file, creating
-    * the file and the folder as necessary.
-    * 
-    * @param string $filePath
-    * @param string $content
-    * @throws FileHelper_Exception
-    * 
-    * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE
-    * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
-    * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
-    */
+    /**
+     * Saves the specified content to the target file, creating
+     * the file and the folder as necessary.
+     * 
+     * @param string $filePath
+     * @param string $content
+     * @throws FileHelper_Exception
+     * 
+     * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE
+     * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
+     * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
+     */
     public static function saveFile(string $filePath, string $content='') : void
     {
         self::getFileInfo($filePath)->putContents($content);
@@ -602,14 +602,14 @@ 
         return $output;
     }
     
-   /**
-    * Retrieves the last modified date for the specified file or folder.
-    * 
-    * Note: If the target does not exist, returns null. 
-    * 
-    * @param string $path
-    * @return DateTime|NULL
-    */
+    /**
+     * Retrieves the last modified date for the specified file or folder.
+     * 
+     * Note: If the target does not exist, returns null. 
+     * 
+     * @param string $path
+     * @return DateTime|NULL
+     */
     public static function getModifiedDate(string $path) : ?DateTime
     {
         $time = filemtime($path);
@@ -649,70 +649,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|DirectoryIterator $path
-    * @param int|NULL $errorCode Optional custom error code
-    * @throws FileHelper_Exception
-    * @return string The real path to the file
-    * 
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
-    * @see FileHelper::ERROR_REAL_PATH_NOT_FOUND
-    */
+    /**
+     * Checks that the target file exists, and throws an exception
+     * if it does not. 
+     * 
+     * @param string|DirectoryIterator $path
+     * @param int|NULL $errorCode Optional custom error code
+     * @throws FileHelper_Exception
+     * @return string The real path to the file
+     * 
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
+     * @see FileHelper::ERROR_REAL_PATH_NOT_FOUND
+     */
     public static function requireFileExists($path, ?int $errorCode=null) : string
     {
         return self::getPathInfo($path)
@@ -735,18 +735,18 @@ 
             ->getPath();
     }
     
-   /**
-    * Reads a specific line number from the target file and returns its
-    * contents, if the file has such a line. Does so with little memory
-    * usage, as the file is not read entirely into memory.
-    * 
-    * @param string $path
-    * @param int $lineNumber Note: 1-based; the first line is number 1.
-    * @return string|NULL Will return null if the requested line does not exist.
-    * @throws FileHelper_Exception
-    * 
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
-    */
+    /**
+     * Reads a specific line number from the target file and returns its
+     * contents, if the file has such a line. Does so with little memory
+     * usage, as the file is not read entirely into memory.
+     * 
+     * @param string $path
+     * @param int $lineNumber Note: 1-based; the first line is number 1.
+     * @return string|NULL Will return null if the requested line does not exist.
+     * @throws FileHelper_Exception
+     * 
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
+     */
     public static function getLineFromFile(string $path, int $lineNumber) : ?string
     {
         return self::getFileInfo($path)
@@ -823,33 +823,33 @@ 
             ->getLines($amount);
     }
     
-   /**
-    * Reads all content from a file.
-    * 
-    * @param string $filePath
-    * @throws FileHelper_Exception
-    * @return string
-    * 
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
-    * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS
-    */
+    /**
+     * Reads all content from a file.
+     * 
+     * @param string $filePath
+     * @throws FileHelper_Exception
+     * @return string
+     * 
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
+     * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS
+     */
     public static function readContents(string $filePath) : string
     {
         return self::getFileInfo($filePath)->getContents();
     }
 
-   /**
-    * Ensures that the target path exists on disk, and is a folder.
-    * 
-    * @param string $path
-    * @return string The real path, with normalized slashes.
-    * @throws FileHelper_Exception
-    * 
-    * @see FileHelper::normalizePath()
-    * 
-    * @see FileHelper::ERROR_FOLDER_DOES_NOT_EXIST
-    * @see FileHelper::ERROR_PATH_IS_NOT_A_FOLDER
-    */
+    /**
+     * Ensures that the target path exists on disk, and is a folder.
+     * 
+     * @param string $path
+     * @return string The real path, with normalized slashes.
+     * @throws FileHelper_Exception
+     * 
+     * @see FileHelper::normalizePath()
+     * 
+     * @see FileHelper::ERROR_FOLDER_DOES_NOT_EXIST
+     * @see FileHelper::ERROR_PATH_IS_NOT_A_FOLDER
+     */
     public static function requireFolderExists(string $path) : string
     {
         return self::getFolderInfo($path)

Spacing +24 added lines, -24 removed lines

@@ -207,7 +207,7 @@ 
     public static function detectMimeType(string $fileName) : ?string
     {
         $ext = self::getExtension($fileName);
-        if(empty($ext)) {
+        if (empty($ext)) {
             return null;
         }
 
@@ -247,7 +247,7 @@ 
      * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
      * @see FileHelper::ERROR_UNKNOWN_FILE_MIME_TYPE
      */
-    public static function sendFile(string $filePath, ?string $fileName = null, bool $asAttachment=true) : void
+    public static function sendFile(string $filePath, ?string $fileName = null, bool $asAttachment = true) : void
     {
         self::getFileInfo($filePath)->getDownloader()->send($fileName, $asAttachment);
     }
@@ -264,7 +264,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)
@@ -299,7 +299,7 @@ 
     {
         $info = self::getPathInfo($pathOrDirIterator);
 
-        if($info instanceof FileInfo)
+        if ($info instanceof FileInfo)
         {
             return $info->getExtension($lowercase);
         }
@@ -323,7 +323,7 @@ 
     {
         $info = self::getPathInfo($pathOrDirIterator);
 
-        if($extension === true || $info instanceof FolderInfo)
+        if ($extension === true || $info instanceof FolderInfo)
         {
             return $info->getName();
         }
@@ -344,7 +344,7 @@ 
      * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE
      * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE
      */
-    public static function parseJSONFile(string $file, string $targetEncoding='', $sourceEncoding=null) : array
+    public static function parseJSONFile(string $file, string $targetEncoding = '', $sourceEncoding = null) : array
     {
         return JSONFile::factory(self::getFileInfo($file))
             ->setTargetEncoding($targetEncoding)
@@ -397,7 +397,7 @@ 
      * @throws FileHelper_Exception
      * @see FileHelper::createFileFinder()
      */
-    public static function findHTMLFiles(string $targetFolder, array $options=array()) : array
+    public static function findHTMLFiles(string $targetFolder, array $options = array()) : array
     {
         return self::findFiles($targetFolder, array('html'), $options);
     }
@@ -416,7 +416,7 @@ 
      * @throws FileHelper_Exception
      * @see FileHelper::createFileFinder()
      */
-    public static function findPHPFiles(string $targetFolder, array $options=array()) : array
+    public static function findPHPFiles(string $targetFolder, array $options = array()) : array
     {
         return self::findFiles($targetFolder, array('php'), $options);
     }
@@ -438,7 +438,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);
 
@@ -448,16 +448,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();
         }
@@ -475,7 +475,7 @@ 
     * @param bool $keepPath Whether to keep the path component, if any. Default PHP pathinfo behavior is not to.
     * @return string
     */
-    public static function removeExtension(string $filename, bool $keepPath=false) : string
+    public static function removeExtension(string $filename, bool $keepPath = false) : string
     {
         return self::getFileInfo($filename)->removeExtension($keepPath);
     }
@@ -487,7 +487,7 @@ 
 
     public static function createUnicodeHandling() : UnicodeHandling
     {
-        if(!isset(self::$unicodeHandling))
+        if (!isset(self::$unicodeHandling))
         {
             self::$unicodeHandling = new UnicodeHandling();
         }
@@ -520,7 +520,7 @@ 
     * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
     * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
     */
-    public static function saveAsJSON($data, string $file, bool $pretty=false) : void
+    public static function saveAsJSON($data, string $file, bool $pretty = false) : void
     {
         JSONFile::factory(self::getFileInfo($file))
             ->putData($data, $pretty);
@@ -538,7 +538,7 @@ 
     * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
     * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
     */
-    public static function saveFile(string $filePath, string $content='') : void
+    public static function saveFile(string $filePath, string $content = '') : void
     {
         self::getFileInfo($filePath)->putContents($content);
     }
@@ -581,7 +581,7 @@ 
      */
     public static function checkPHPFileSyntax(string $path)
     {
-        if(!self::canMakePHPCalls()) {
+        if (!self::canMakePHPCalls()) {
             return true;
         }
         
@@ -592,7 +592,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;
         }
         
@@ -613,7 +613,7 @@ 
     public static function getModifiedDate(string $path) : ?DateTime
     {
         $time = filemtime($path);
-        if($time === false) {
+        if ($time === false) {
             return null;
         }
 
@@ -674,7 +674,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);
     }
@@ -713,7 +713,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()
@@ -727,7 +727,7 @@ 
      * @return string
      * @throws FileHelper_Exception
      */
-    public static function requireFileReadable(string $path, ?int $errorCode=null) : string
+    public static function requireFileReadable(string $path, ?int $errorCode = null) : string
     {
         return self::getPathInfo($path)
             ->requireIsFile()
@@ -816,7 +816,7 @@ 
      * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
      * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES
      */
-    public static function readLines(string $filePath, int $amount=0) : array
+    public static function readLines(string $filePath, int $amount = 0) : array
     {
         return self::getFileInfo($filePath)
             ->getLineReader()
@@ -866,7 +866,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/ConvertHelper.php

Indentation +469 added lines, -469 removed lines

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

Spacing +24 added lines, -24 removed lines

@@ -55,7 +55,7 @@ 
      * @param int $tabSize The amount of spaces per tab.
      * @return string
      */
-    public static function tabs2spaces(string $string, int $tabSize=4) : string
+    public static function tabs2spaces(string $string, int $tabSize = 4) : string
     {
         return ConvertHelper_String::tabs2spaces($string, $tabSize);
     }
@@ -67,7 +67,7 @@ 
     * @param int $tabSize The amount of spaces per tab in the source string.
     * @return string
     */
-    public static function spaces2tabs(string $string, int $tabSize=4) : string
+    public static function spaces2tabs(string $string, int $tabSize = 4) : string
     {
         return ConvertHelper_String::spaces2tabs($string, $tabSize);
     }
@@ -140,7 +140,7 @@ 
     * @deprecated Use the Highlighter class directly instead.
     * @see Highlighter::xml()
     */
-    public static function highlight_xml(string $xml, bool $formatSource=false) : string
+    public static function highlight_xml(string $xml, bool $formatSource = false) : string
     {
         return Highlighter::xml($xml, $formatSource);
     }
@@ -206,11 +206,11 @@ 
      * @param bool $html
      * @return string
      */
-    public static function var_dump($var, bool $html=true) : string
+    public static function var_dump($var, bool $html = true) : string
     {
         $info = parseVariable($var);
         
-        if($html) {
+        if ($html) {
             return $info->toHTML();
         }
         
@@ -225,11 +225,11 @@ 
     * @param bool $html Whether to style the dump as HTML.
     * @return string
     */
-    public static function print_r($var, bool $return=false, bool $html=true) : string
+    public static function print_r($var, bool $return = false, bool $html = true) : string
     {
         $result = parseVariable($var)->enableType()->toString();
         
-        if($html) 
+        if ($html) 
         {
             $result = 
             '<pre style="background:#fff;color:#333;padding:16px;border:solid 1px #bbb;border-radius:4px">'.
@@ -237,7 +237,7 @@ 
             '</pre>';
         }
         
-        if(!$return) 
+        if (!$return) 
         {
             echo $result;
         }
@@ -419,12 +419,12 @@ 
         $output = '';
         $split = str_split($unicodeChar);
         
-        foreach($split as $octet) 
+        foreach ($split as $octet) 
         {
             $ordInt = ord($octet);
             // Convert from int (base 10) to hex (base 16), for PHP \x syntax
             $ordHex = base_convert((string)$ordInt, 10, 16);
-            $output .= '\x' . $ordHex;
+            $output .= '\x'.$ordHex;
         }
         
         return $output;
@@ -638,7 +638,7 @@ 
     * 
     * @see JSHelper::buildRegexStatement()
     */
-    public static function regex2js(string $regex, string $statementType=JSHelper::JS_REGEX_OBJECT) : string
+    public static function regex2js(string $regex, string $statementType = JSHelper::JS_REGEX_OBJECT) : string
     {
         return JSHelper::buildRegexStatement($regex, $statementType);
     }
@@ -657,11 +657,11 @@ 
     * @throws ConvertHelper_Exception
     * @see ConvertHelper::ERROR_JSON_ENCODE_FAILED
     */
-    public static function var2json($variable, int $options=0, int $depth=512) : string
+    public static function var2json($variable, int $options = 0, int $depth = 512) : string
     {
         $result = json_encode($variable, $options, $depth);
         
-        if($result !== false) {
+        if ($result !== false) {
             return $result;
         }
         
@@ -701,12 +701,12 @@ 
     {
         $boms = FileHelper::createUnicodeHandling()->getUTFBOMs();
 
-        foreach($boms as $bomChars)
+        foreach ($boms as $bomChars)
         {
             $length = mb_strlen($bomChars);
             $text = mb_substr($string, 0, $length);
 
-            if($text===$bomChars)
+            if ($text === $bomChars)
             {
                 return mb_substr($string, $length);
             }
@@ -778,7 +778,7 @@ 
     * @see ConvertHelper_TextComparer::OPTION_MAX_LEVENSHTEIN_DISTANCE
     * @see ConvertHelper_TextComparer::OPTION_PRECISION
     */
-    public static function matchString(string $source, string $target, array $options=array()) : float
+    public static function matchString(string $source, string $target, array $options = array()) : float
     {
         return (new ConvertHelper_TextComparer())
             ->setOptions($options)
@@ -856,7 +856,7 @@ 
     * @see ConvertHelper::INTERVAL_HOURS
     * @see ConvertHelper::INTERVAL_DAYS
     */
-    public static function interval2total(DateInterval $interval, string $unit=self::INTERVAL_SECONDS) : int
+    public static function interval2total(DateInterval $interval, string $unit = self::INTERVAL_SECONDS) : int
     {
         return ConvertHelper_DateInterval::toTotal($interval, $unit);
     }
@@ -868,7 +868,7 @@ 
     * @param bool $short
     * @return string|NULL
     */
-    public static function date2dayName(DateTime $date, bool $short=false) : ?string
+    public static function date2dayName(DateTime $date, bool $short = false) : ?string
     {
         return ConvertHelper_Date::toDayName($date, $short);
     }
@@ -888,7 +888,7 @@ 
     * @param bool $short
     * @return string[]
     */
-    public static function getDayNames(bool $short=false) : array
+    public static function getDayNames(bool $short = false) : array
     {
         return ConvertHelper_Date::getDayNames($short);
     }
@@ -1047,7 +1047,7 @@ 
     * @param bool $caseInsensitive
     * @return ConvertHelper_StringMatch[]
     */
-    public static function findString(string $needle, string $haystack, bool $caseInsensitive=false): array
+    public static function findString(string $needle, string $haystack, bool $caseInsensitive = false): array
     {
         return ConvertHelper_String::findString($needle, $haystack, $caseInsensitive);
     }
@@ -1097,17 +1097,17 @@ 
     */
     public static function isInteger($value) : bool
     {
-        if(is_int($value)) {
+        if (is_int($value)) {
             return true;
         }
         
         // booleans get converted to numbers, so they would
         // actually match the regex.
-        if(is_bool($value)) {
+        if (is_bool($value)) {
             return false;
         }
         
-        if(is_string($value) && $value !== '') {
+        if (is_string($value) && $value !== '') {
             return preg_match('/\A-?\d+\z/', $value) === 1;
         }
         
@@ -1173,7 +1173,7 @@ 
      * @param bool $keepKeys
      * @return array<number|string,mixed>
      */
-    public static function arrayRemoveValues(array $sourceArray, array $values, bool $keepKeys=false) : array
+    public static function arrayRemoveValues(array $sourceArray, array $values, bool $keepKeys = false) : array
     {
         return ConvertHelper_Array::removeValues($sourceArray, $values, $keepKeys);
     }

src/FileHelper/FolderTree.php

Spacing +6 added lines, -6 removed lines

@@ -22,7 +22,7 @@ 
     {
         $info = FileHelper::getFolderInfo($rootFolder);
 
-        if(!$info->exists())
+        if (!$info->exists())
         {
             return true;
         }
@@ -31,7 +31,7 @@ 
 
         foreach ($d as $item)
         {
-            if(self::processDeleteItem($item) === false)
+            if (self::processDeleteItem($item) === false)
             {
                 return false;
             }
@@ -90,11 +90,11 @@ 
     {
         $target = FileHelper::createFolder($target);
 
-        $d =  $source->requireIsFolder()->getIterator();
+        $d = $source->requireIsFolder()->getIterator();
 
         foreach ($d as $item)
         {
-            if($item->isDot())
+            if ($item->isDot())
             {
                 continue;
             }
@@ -115,9 +115,9 @@ 
 
         if ($item->isFolder())
         {
-            self::copy($item, $target . '/' . $item->getName());
+            self::copy($item, $target.'/'.$item->getName());
         }
-        else if($item->isFile())
+        else if ($item->isFile())
         {
             $item
                 ->requireIsFile()

Braces +2 added lines, -4 removed lines

@@ -69,8 +69,7 @@ 
             try
             {
                 FileHelper::deleteFile($itemPath);
-            }
-            catch (FileHelper_Exception $e)
+            } catch (FileHelper_Exception $e)
             {
                 return false;
             }
@@ -116,8 +115,7 @@ 
         if ($item->isFolder())
         {
             self::copy($item, $target . '/' . $item->getName());
-        }
-        else if($item->isFile())
+        } else if($item->isFile())
         {
             $item
                 ->requireIsFile()

src/FileHelper/UploadFileSizeInfo.php

Spacing +1 added lines, -1 removed lines

@@ -51,7 +51,7 @@
         $unit = preg_replace('/[^bkmgtpezy]/i', '', $size); // Remove the non-unit characters from the size.
         $result = (float)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 (int)round($result * (1024 ** stripos('bkmgtpezy', $unit[0])));

src/FileHelper/FileInfo.php

Spacing +14 added lines, -14 removed lines

@@ -42,7 +42,7 @@ 
     {
         $pathString = AbstractPathInfo::type2string($path);
 
-        if(!isset(self::$infoCache[$pathString]))
+        if (!isset(self::$infoCache[$pathString]))
         {
             self::$infoCache[$pathString] = new FileInfo($pathString);
         }
@@ -72,7 +72,7 @@ 
     {
         parent::__construct($path);
 
-        if(!self::is_file($this->path))
+        if (!self::is_file($this->path))
         {
             throw new FileHelper_Exception(
                 'Not a file path',
@@ -86,7 +86,7 @@ 
     {
         $path = trim($path);
 
-        if(empty($path))
+        if (empty($path))
         {
             return false;
         }
@@ -94,9 +94,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 pathinfo($this->getName(), PATHINFO_FILENAME);
         }
@@ -110,11 +110,11 @@ 
         return implode('/', $parts);
     }
 
-    public function getExtension(bool $lowercase=true) : string
+    public function getExtension(bool $lowercase = true) : string
     {
         $ext = pathinfo($this->path, PATHINFO_EXTENSION);
 
-        if($lowercase)
+        if ($lowercase)
         {
             $ext = mb_strtolower($ext);
         }
@@ -130,12 +130,12 @@ 
      */
     public function delete() : FileInfo
     {
-        if(!$this->exists())
+        if (!$this->exists())
         {
             return $this;
         }
 
-        if(unlink($this->path))
+        if (unlink($this->path))
         {
             return $this;
         }
@@ -162,7 +162,7 @@ 
     {
         $this->checkCopyPrerequisites($targetPath);
 
-        if(copy($this->path, $targetPath))
+        if (copy($this->path, $targetPath))
         {
             return self::factory($targetPath);
         }
@@ -214,7 +214,7 @@ 
      */
     public function getLineReader() : LineReader
     {
-        if(!isset($this->lineReader))
+        if (!isset($this->lineReader))
         {
             $this->lineReader = new LineReader($this);
         }
@@ -233,7 +233,7 @@ 
 
         $result = file_get_contents($this->getPath());
 
-        if($result !== false) {
+        if ($result !== false) {
             return $result;
         }
 
@@ -255,7 +255,7 @@ 
      */
     public function putContents(string $content) : FileInfo
     {
-        if($this->exists())
+        if ($this->exists())
         {
             $this->requireWritable();
         }
@@ -266,7 +266,7 @@ 
                 ->requireWritable();
         }
 
-        if(file_put_contents($this->path, $content) !== false)
+        if (file_put_contents($this->path, $content) !== false)
         {
             return $this;
         }

src/FileHelper/PathRelativizer.php

Spacing +6 added lines, -6 removed lines

@@ -18,7 +18,7 @@ 
      * @param int $depth The folder depth to reduce the path to
      * @return string
      */
-    public static function relativizeByDepth(string $path, int $depth=2) : string
+    public static function relativizeByDepth(string $path, int $depth = 2) : string
     {
         $path = FileHelper::normalizePath($path);
 
@@ -26,17 +26,17 @@ 
         $tokens = array_filter($tokens); // remove empty entries (trailing slash for example)
         $tokens = array_values($tokens); // re-index keys
 
-        if(empty($tokens)) {
+        if (empty($tokens)) {
             return '';
         }
 
         // remove the drive if present
-        if(strpos($tokens[0], ':') !== false) {
+        if (strpos($tokens[0], ':') !== false) {
             array_shift($tokens);
         }
 
         // path was only the drive
-        if(count($tokens) === 0) {
+        if (count($tokens) === 0) {
             return '';
         }
 
@@ -45,8 +45,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

src/FileHelper/FileFinder.php

Indentation +130 added lines, -130 removed lines

@@ -43,20 +43,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|DirectoryIterator $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|DirectoryIterator $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();
@@ -74,11 +74,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);
@@ -95,46 +95,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();
@@ -145,37 +145,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();
@@ -186,52 +186,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);
@@ -254,12 +254,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);
@@ -267,24 +267,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'));
@@ -355,13 +355,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);
@@ -381,12 +381,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))

Spacing +16 added lines, -16 removed lines

@@ -7,7 +7,7 @@ 
  * @see \AppUtils\FileHelper\FileFinder
  */
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 namespace AppUtils\FileHelper;
 
@@ -90,7 +90,7 @@ 
      * @param bool $enabled
      * @return FileFinder
      */
-    public function makeRecursive(bool $enabled=true) : FileFinder
+    public function makeRecursive(bool $enabled = true) : FileFinder
     {
         return $this->setOption('recursive', $enabled);
     }
@@ -295,22 +295,22 @@ 
         return $this->getAll();
     }
     
-    protected function find(string $path, bool $isRoot=false) : void
+    protected function find(string $path, bool $isRoot = false) : void
     {
-        if($isRoot) {
+        if ($isRoot) {
             $this->found = array();
         }
         
         $recursive = $this->getBoolOption('recursive');
         
         $d = new DirectoryIterator($path);
-        foreach($d as $item)
+        foreach ($d as $item)
         {
             $pathname = $item->getPathname();
             
-            if($item->isDir())
+            if ($item->isDir())
             {
-                if($recursive && !$item->isDot()) {
+                if ($recursive && !$item->isDot()) {
                     $this->find($pathname);
                 }
                 
@@ -319,7 +319,7 @@ 
             
             $file = $this->filterFile($pathname);
             
-            if($file !== null) 
+            if ($file !== null) 
             {
                 $this->found[] = $file;
             }
@@ -332,23 +332,23 @@ 
         
         $extension = FileHelper::getExtension($path);
         
-        if(!$this->filterExclusion($extension)) {
+        if (!$this->filterExclusion($extension)) {
             return null;
         }
         
         $path = $this->filterPath($path);
         
-        if($this->getOption('strip-extensions') === true)
+        if ($this->getOption('strip-extensions') === true)
         {
             $path = str_replace('.'.$extension, '', $path);
         }
         
-        if($path === '') {
+        if ($path === '') {
             return null;
         }
         
         $replace = $this->getOption('slash-replacement');
-        if(!empty($replace)) {
+        if (!empty($replace)) {
             $path = str_replace('/', $replace, $path);
         }
         
@@ -367,13 +367,13 @@ 
         $include = $this->getOption(self::OPTION_INCLUDE_EXTENSIONS);
         $exclude = $this->getOption(self::OPTION_EXCLUDE_EXTENSIONS);
         
-        if(!empty($include))
+        if (!empty($include))
         {
-            if(!in_array($extension, $include, true)) {
+            if (!in_array($extension, $include, true)) {
                 return false;
             }
         }
-        else if(!empty($exclude) && in_array($extension, $exclude, true))
+        else if (!empty($exclude) && in_array($extension, $exclude, true))
         {
             return false;
         }
@@ -389,7 +389,7 @@ 
     */
     protected function filterPath(string $path) : string
     {
-        switch($this->getStringOption(self::OPTION_PATHMODE))
+        switch ($this->getStringOption(self::OPTION_PATHMODE))
         {
             case self::PATH_MODE_STRIP:
                 return basename($path);

Braces +1 added lines, -2 removed lines

@@ -372,8 +372,7 @@
             if(!in_array($extension, $include, true)) {
                 return false;
             }
-        }
-        else if(!empty($exclude) && in_array($extension, $exclude, true))
+        } else if(!empty($exclude) && in_array($extension, $exclude, true))
         {
             return false;
         }

src/FileHelper/FolderInfo.php

Spacing +7 added lines, -7 removed lines

@@ -29,7 +29,7 @@ 
     {
         $pathString = AbstractPathInfo::type2string($path);
 
-        if(!isset(self::$infoCache[$pathString]))
+        if (!isset(self::$infoCache[$pathString]))
         {
             self::$infoCache[$pathString] = new FolderInfo($pathString);
         }
@@ -58,7 +58,7 @@ 
     {
         parent::__construct($path);
 
-        if(!self::is_dir($this->path))
+        if (!self::is_dir($this->path))
         {
             throw new FileHelper_Exception(
                 'Not a folder',
@@ -80,12 +80,12 @@ 
     {
         $path = trim($path);
 
-        if($path === '' || $path === '.' || $path === '..')
+        if ($path === '' || $path === '.' || $path === '..')
         {
             return false;
         }
 
-        if(is_dir($path))
+        if (is_dir($path))
         {
             return true;
         }
@@ -103,12 +103,12 @@ 
      */
     public function delete() : FolderInfo
     {
-        if(!$this->exists())
+        if (!$this->exists())
         {
             return $this;
         }
 
-        if(rmdir($this->path))
+        if (rmdir($this->path))
         {
             return $this;
         }
@@ -134,7 +134,7 @@ 
      */
     public function create() : FolderInfo
     {
-        if(is_dir($this->path) || mkdir($this->path, 0777, true) || is_dir($this->path))
+        if (is_dir($this->path) || mkdir($this->path, 0777, true) || is_dir($this->path))
         {
             return $this;
         }