Mistralys / application-utils

src/FileHelper.php

Spacing +102 added lines, -102 removed lines

@@ -110,7 +110,7 @@ 
         
         $contents = file_get_contents($file);
         
-        if($contents === false) 
+        if ($contents === false) 
         {
             throw new FileHelper_Exception(
                 'Cannot load serialized content from file.',
@@ -124,7 +124,7 @@ 
         
         $result = @unserialize($contents);
         
-        if($result !== false) {
+        if ($result !== false) {
             return $result;
         }
         
@@ -140,7 +140,7 @@ 
     
     public static function deleteTree($rootFolder)
     {
-        if(!file_exists($rootFolder)) {
+        if (!file_exists($rootFolder)) {
             return true;
         }
         
@@ -181,7 +181,7 @@ 
     */
     public static function createFolder($path)
     {
-        if(is_dir($path) || mkdir($path, 0777, true)) {
+        if (is_dir($path) || mkdir($path, 0777, true)) {
             return;
         }
         
@@ -216,11 +216,11 @@ 
 
             if ($item->isDir()) 
             {
-                FileHelper::copyTree(str_replace('\\', '/', $itemPath), $target . '/' . $baseName);
+                FileHelper::copyTree(str_replace('\\', '/', $itemPath), $target.'/'.$baseName);
             } 
-            else if($item->isFile()) 
+            else if ($item->isFile()) 
             {
-                self::copyFile($itemPath, $target . '/' . $baseName);
+                self::copyFile($itemPath, $target.'/'.$baseName);
             }
         }
     }
@@ -245,7 +245,7 @@ 
     {
         self::requireFileExists($sourcePath, self::ERROR_SOURCE_FILE_NOT_FOUND);
         
-        if(!is_readable($sourcePath))
+        if (!is_readable($sourcePath))
         {
             throw new FileHelper_Exception(
                 sprintf('Source file [%s] to copy is not readable.', basename($sourcePath)),
@@ -259,11 +259,11 @@ 
         
         $targetFolder = dirname($targetPath);
         
-        if(!file_exists($targetFolder))
+        if (!file_exists($targetFolder))
         {
             self::createFolder($targetFolder);
         }
-        else if(!is_writable($targetFolder)) 
+        else if (!is_writable($targetFolder)) 
         {
             throw new FileHelper_Exception(
                 sprintf('Target folder [%s] is not writable.', basename($targetFolder)),
@@ -275,7 +275,7 @@ 
             );
         }
         
-        if(copy($sourcePath, $targetPath)) {
+        if (copy($sourcePath, $targetPath)) {
             return;
         }
         
@@ -302,11 +302,11 @@ 
     */
     public static function deleteFile(string $filePath) : void
     {
-        if(!file_exists($filePath)) {
+        if (!file_exists($filePath)) {
             return;
         }
         
-        if(unlink($filePath)) {
+        if (unlink($filePath)) {
             return;
         }
         
@@ -330,10 +330,10 @@ 
     * @return \parseCSV
     * @todo Move this to the CSV helper.
     */
-    public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : \parseCSV
+    public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : \parseCSV
     {
-        if($delimiter==='') { $delimiter = ';'; }
-        if($enclosure==='') { $enclosure = '"'; }
+        if ($delimiter === '') { $delimiter = ';'; }
+        if ($enclosure === '') { $enclosure = '"'; }
         
         $parser = new \parseCSV(null, null, null, array());
 
@@ -361,11 +361,11 @@ 
     * @see parseCSVFile()
     * @see FileHelper::ERROR_PARSING_CSV
     */
-    public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array
+    public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : array
     {
         $parser = self::createCSVParser($delimiter, $enclosure, $escape, $heading);
         $result = $parser->parse_string(/** @scrutinizer ignore-type */ $csv);
-        if(is_array($result)) {
+        if (is_array($result)) {
             return $result;
         }
         
@@ -394,7 +394,7 @@ 
      * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
      * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS
      */
-    public static function parseCSVFile(string $filePath, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array
+    public static function parseCSVFile(string $filePath, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : array
     {
         $content = self::readContents($filePath);
 
@@ -411,7 +411,7 @@ 
     public static function detectMimeType(string $fileName) : ?string
     {
         $ext = self::getExtension($fileName);
-        if(empty($ext)) {
+        if (empty($ext)) {
             return null;
         }
 
@@ -432,11 +432,11 @@ 
      * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
      * @see FileHelper::ERROR_UNKNOWN_FILE_MIME_TYPE
      */
-    public static function sendFile(string $filePath, $fileName = null, bool $asAttachment=true)
+    public static function sendFile(string $filePath, $fileName = null, bool $asAttachment = true)
     {
         self::requireFileExists($filePath);
         
-        if(empty($fileName)) {
+        if (empty($fileName)) {
             $fileName = basename($filePath);
         }
 
@@ -454,10 +454,10 @@ 
         
         header("Cache-Control: public", true);
         header("Content-Description: File Transfer", true);
-        header("Content-Type: " . $mime, true);
+        header("Content-Type: ".$mime, true);
 
         $disposition = 'inline';
-        if($asAttachment) {
+        if ($asAttachment) {
             $disposition = 'attachment';
         }
         
@@ -485,7 +485,7 @@ 
         requireCURL();
         
         $ch = curl_init();
-        if(!is_resource($ch)) 
+        if (!is_resource($ch)) 
         {
             throw new FileHelper_Exception(
                 'Could not initialize a new cURL instance.',
@@ -506,7 +506,7 @@ 
         
         $output = curl_exec($ch);
 
-        if($output === false) {
+        if ($output === false) {
             throw new FileHelper_Exception(
                 'Unable to open URL',
                 sprintf(
@@ -520,7 +520,7 @@ 
 
         curl_close($ch);
 
-        if(is_string($output)) 
+        if (is_string($output)) 
         {
             return $output;
         }
@@ -542,7 +542,7 @@ 
     */
     public static function isPHPFile($pathOrDirIterator)
     {
-    	if(self::getExtension($pathOrDirIterator) == 'php') {
+    	if (self::getExtension($pathOrDirIterator) == 'php') {
     		return true;
     	}
     	
@@ -559,14 +559,14 @@ 
     */
     public static function getExtension($pathOrDirIterator, bool $lowercase = true) : string
     {
-        if($pathOrDirIterator instanceof \DirectoryIterator) {
+        if ($pathOrDirIterator instanceof \DirectoryIterator) {
             $filename = $pathOrDirIterator->getFilename();
         } else {
             $filename = basename($pathOrDirIterator);
         }
          
         $ext = pathinfo($filename, PATHINFO_EXTENSION);
-        if($lowercase) {
+        if ($lowercase) {
         	$ext = mb_strtolower($ext);
         }
         
@@ -588,13 +588,13 @@ 
     public static function getFilename($pathOrDirIterator, $extension = true)
     {
         $path = $pathOrDirIterator;
-    	if($pathOrDirIterator instanceof \DirectoryIterator) {
+    	if ($pathOrDirIterator instanceof \DirectoryIterator) {
     		$path = $pathOrDirIterator->getFilename();
     	}
     	
     	$path = self::normalizePath($path);
     	
-    	if(!$extension) {
+    	if (!$extension) {
     	    return pathinfo($path, PATHINFO_FILENAME);
     	}
     	
@@ -612,12 +612,12 @@ 
     * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE
     * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE
     */ 
-    public static function parseJSONFile(string $file, $targetEncoding=null, $sourceEncoding=null)
+    public static function parseJSONFile(string $file, $targetEncoding = null, $sourceEncoding = null)
     {
         self::requireFileExists($file, self::ERROR_CANNOT_FIND_JSON_FILE);
         
         $content = file_get_contents($file);
-        if(!$content) {
+        if (!$content) {
             throw new FileHelper_Exception(
                 'Cannot get file contents',
                 sprintf(
@@ -628,12 +628,12 @@ 
             );
         }
         
-        if(isset($targetEncoding)) {
+        if (isset($targetEncoding)) {
             $content = mb_convert_encoding($content, $targetEncoding, $sourceEncoding);
         }
         
         $json = json_decode($content, true);
-        if($json === false || $json === NULL) {
+        if ($json === false || $json === NULL) {
             throw new FileHelper_Exception(
                 'Cannot decode json data',
                 sprintf(
@@ -673,13 +673,13 @@ 
         
         $name = str_replace(array_keys($replaces), array_values($replaces), $name);
         
-        while(strstr($name, '  ')) {
+        while (strstr($name, '  ')) {
             $name = str_replace('  ', ' ', $name);
         }
 
         $name = str_replace(array_keys($replaces), array_values($replaces), $name);
         
-        while(strstr($name, '..')) {
+        while (strstr($name, '..')) {
             $name = str_replace('..', '.', $name);
         }
         
@@ -711,7 +711,7 @@ 
     * @return array An indexed array with files.
     * @see FileHelper::createFileFinder()
     */
-    public static function findHTMLFiles(string $targetFolder, array $options=array()) : array
+    public static function findHTMLFiles(string $targetFolder, array $options = array()) : array
     {
         return self::findFiles($targetFolder, array('html'), $options);
     }
@@ -728,7 +728,7 @@ 
     * @return array An indexed array of PHP files.
     * @see FileHelper::createFileFinder()
     */
-    public static function findPHPFiles(string $targetFolder, array $options=array()) : array
+    public static function findPHPFiles(string $targetFolder, array $options = array()) : array
     {
         return self::findFiles($targetFolder, array('php'), $options);
     }
@@ -748,22 +748,22 @@ 
     * @return array
     * @see FileHelper::createFileFinder()
     */
-    public static function findFiles(string $targetFolder, array $extensions=array(), array $options=array(), array $files=array()) : array
+    public static function findFiles(string $targetFolder, array $extensions = array(), array $options = array(), array $files = array()) : array
     {
         $finder = self::createFileFinder($targetFolder);
 
         $finder->setPathmodeStrip();
         
-        if(isset($options['relative-path']) && $options['relative-path'] === true) 
+        if (isset($options['relative-path']) && $options['relative-path'] === true) 
         {
             $finder->setPathmodeRelative();
         } 
-        else if(isset($options['absolute-path']) && $options['absolute-path'] === true)
+        else if (isset($options['absolute-path']) && $options['absolute-path'] === true)
         {
             $finder->setPathmodeAbsolute();
         }
         
-        if(isset($options['strip-extension'])) 
+        if (isset($options['strip-extension'])) 
         {
             $finder->stripExtensions();
         }
@@ -781,12 +781,12 @@ 
     * @param bool $keepPath Whether to keep the path component, if any. Default PHP pathinfo behavior is not to.
     * @return string
     */
-    public static function removeExtension(string $filename, bool $keepPath=false) : string
+    public static function removeExtension(string $filename, bool $keepPath = false) : string
     {
         // normalize paths to allow windows style slashes even on nix servers
         $filename = self::normalizePath($filename);
         
-        if(!$keepPath) 
+        if (!$keepPath) 
         {
             return pathinfo($filename, PATHINFO_FILENAME);
         }
@@ -819,7 +819,7 @@ 
     public static function detectUTFBom(string $filename) : ?string
     {
         $fp = fopen($filename, 'r');
-        if($fp === false) 
+        if ($fp === false) 
         {
             throw new FileHelper_Exception(
                 'Cannot open file for reading',
@@ -834,10 +834,10 @@ 
 
         $boms = self::getUTFBOMs();
         
-        foreach($boms as $bom => $value) 
+        foreach ($boms as $bom => $value) 
         {
             $length = mb_strlen($value);
-            if(mb_substr($text, 0, $length) == $value) {
+            if (mb_substr($text, 0, $length) == $value) {
                 return $bom;
             }
         }
@@ -856,13 +856,13 @@ 
     */
     public static function getUTFBOMs()
     {
-        if(!isset(self::$utfBoms)) {
+        if (!isset(self::$utfBoms)) {
             self::$utfBoms = array(
-                'UTF32-BE' => chr(0x00) . chr(0x00) . chr(0xFE) . chr(0xFF),
-                'UTF32-LE' => chr(0xFF) . chr(0xFE) . chr(0x00) . chr(0x00),
-                'UTF16-BE' => chr(0xFE) . chr(0xFF),
-                'UTF16-LE' => chr(0xFF) . chr(0xFE),
-                'UTF8' => chr(0xEF) . chr(0xBB) . chr(0xBF)
+                'UTF32-BE' => chr(0x00).chr(0x00).chr(0xFE).chr(0xFF),
+                'UTF32-LE' => chr(0xFF).chr(0xFE).chr(0x00).chr(0x00),
+                'UTF16-BE' => chr(0xFE).chr(0xFF),
+                'UTF16-LE' => chr(0xFF).chr(0xFE),
+                'UTF8' => chr(0xEF).chr(0xBB).chr(0xBF)
             );
         }
         
@@ -883,7 +883,7 @@ 
         $encodings = self::getKnownUnicodeEncodings();
 
         $keep = array();
-        foreach($encodings as $string) 
+        foreach ($encodings as $string) 
         {
             $withHyphen = str_replace('UTF', 'UTF-', $string);
             
@@ -930,16 +930,16 @@ 
     * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
     * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
     */
-    public static function saveAsJSON($data, string $file, bool $pretty=false)
+    public static function saveAsJSON($data, string $file, bool $pretty = false)
     {
         $options = null;
-        if($pretty) {
+        if ($pretty) {
             $options = JSON_PRETTY_PRINT;
         }
         
         $json = json_encode($data, $options);
         
-        if($json===false) 
+        if ($json === false) 
         {
             $errorCode = json_last_error();
             
@@ -965,12 +965,12 @@ 
     * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
     * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
     */
-    public static function saveFile(string $filePath, string $content='') : void
+    public static function saveFile(string $filePath, string $content = '') : void
     {
         // target file already exists
-        if(file_exists($filePath))
+        if (file_exists($filePath))
         {
-            if(!is_writable($filePath))
+            if (!is_writable($filePath))
             {
                 throw new FileHelper_Exception(
                     sprintf('Cannot save file: target file [%s] exists, but is not writable.', basename($filePath)),
@@ -990,7 +990,7 @@ 
             // create the folder as needed
             self::createFolder($targetFolder);
             
-            if(!is_writable($targetFolder)) 
+            if (!is_writable($targetFolder)) 
             {
                 throw new FileHelper_Exception(
                     sprintf('Cannot save file: target folder [%s] is not writable.', basename($targetFolder)),
@@ -1003,7 +1003,7 @@ 
             }
         }
         
-        if(file_put_contents($filePath, $content) !== false) {
+        if (file_put_contents($filePath, $content) !== false) {
             return;
         }
         
@@ -1041,7 +1041,7 @@ 
     {
         static $checked = array();
         
-        if(isset($checked[$command])) {
+        if (isset($checked[$command])) {
             return $checked[$command];
         }
         
@@ -1054,7 +1054,7 @@ 
         
         $os = strtolower(PHP_OS_FAMILY);
         
-        if(!isset($osCommands[$os])) 
+        if (!isset($osCommands[$os])) 
         {
             throw new FileHelper_Exception(
                 'Unsupported OS for CLI commands',
@@ -1080,7 +1080,7 @@ 
             $pipes
         );
         
-        if($process === false) {
+        if ($process === false) {
             $checked[$command] = false;
             return false;
         }
@@ -1111,7 +1111,7 @@ 
     */
     public static function checkPHPFileSyntax($path)
     {
-        if(!self::canMakePHPCalls()) {
+        if (!self::canMakePHPCalls()) {
             return true;
         }
         
@@ -1122,7 +1122,7 @@ 
         // when the validation is successful, the first entry
         // in the array contains the success message. When it
         // is invalid, the first entry is always empty.
-        if(!empty($output[0])) {
+        if (!empty($output[0])) {
             return true;
         }
         
@@ -1143,7 +1143,7 @@ 
     public static function getModifiedDate($path)
     {
         $time = filemtime($path);
-        if($time !== false) {
+        if ($time !== false) {
             $date = new \DateTime();
             $date->setTimestamp($time);
             return $date;
@@ -1172,7 +1172,7 @@ 
     */
     public static function getSubfolders($targetFolder, $options = array())
     {
-        if(!is_dir($targetFolder)) 
+        if (!is_dir($targetFolder)) 
         {
             throw new FileHelper_Exception(
                 'Target folder does not exist',
@@ -1196,29 +1196,29 @@ 
         
         $d = new \DirectoryIterator($targetFolder);
         
-        foreach($d as $item) 
+        foreach ($d as $item) 
         {
-            if($item->isDir() && !$item->isDot()) 
+            if ($item->isDir() && !$item->isDot()) 
             {
                 $name = $item->getFilename();
                 
-                if(!$options['absolute-path']) {
+                if (!$options['absolute-path']) {
                     $result[] = $name;
                 } else {
                     $result[] = $targetFolder.'/'.$name;
                 }
                 
-                if(!$options['recursive']) 
+                if (!$options['recursive']) 
                 {
                     continue;
                 }
                 
                 $subs = self::getSubfolders($targetFolder.'/'.$name, $options);
-                foreach($subs as $sub) 
+                foreach ($subs as $sub) 
                 {
                     $relative = $name.'/'.$sub;
                     
-                    if(!$options['absolute-path']) {
+                    if (!$options['absolute-path']) {
                         $result[] = $relative;
                     } else {
                         $result[] = $targetFolder.'/'.$relative;
@@ -1268,7 +1268,7 @@ 
         $unit = preg_replace('/[^bkmgtpezy]/i', '', $size); // Remove the non-unit characters from the size.
         $size = floatval(preg_replace('/[^0-9\.]/', '', $size)); // Remove the non-numeric characters from the size.
         
-        if($unit) 
+        if ($unit) 
         {
             // Find the position of the unit in the ordered string which is the power of magnitude to multiply a kilobyte by.
             return round($size * pow(1024, stripos('bkmgtpezy', $unit[0])));
@@ -1287,7 +1287,7 @@ 
     * @param int $depth The folder depth to reduce the path to
     * @return string
     */
-    public static function relativizePathByDepth(string $path, int $depth=2) : string
+    public static function relativizePathByDepth(string $path, int $depth = 2) : string
     {
         $path = self::normalizePath($path);
         
@@ -1295,17 +1295,17 @@ 
         $tokens = array_filter($tokens); // remove empty entries (trailing slash for example)
         $tokens = array_values($tokens); // re-index keys
         
-        if(empty($tokens)) {
+        if (empty($tokens)) {
             return '';
         }
         
         // remove the drive if present
-        if(strstr($tokens[0], ':')) {
+        if (strstr($tokens[0], ':')) {
             array_shift($tokens);
         }
         
         // path was only the drive
-        if(count($tokens) == 0) {
+        if (count($tokens) == 0) {
             return '';
         }
 
@@ -1314,8 +1314,8 @@ 
         
         // reduce the path to the specified depth
         $length = count($tokens);
-        if($length > $depth) {
-            $tokens = array_slice($tokens, $length-$depth);
+        if ($length > $depth) {
+            $tokens = array_slice($tokens, $length - $depth);
         }
 
         // append the last element again
@@ -1363,14 +1363,14 @@ 
     * 
     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
     */
-    public static function requireFileExists(string $path, $errorCode=null) : string
+    public static function requireFileExists(string $path, $errorCode = null) : string
     {
         $result = realpath($path);
-        if($result !== false) {
+        if ($result !== false) {
             return $result;
         }
         
-        if($errorCode === null) {
+        if ($errorCode === null) {
             $errorCode = self::ERROR_FILE_DOES_NOT_EXIST;
         }
         
@@ -1399,15 +1399,15 @@ 
         
         $file = new \SplFileObject($path);
         
-        if($file->eof()) {
+        if ($file->eof()) {
             return '';
         }
         
-        $targetLine = $lineNumber-1;
+        $targetLine = $lineNumber - 1;
         
         $file->seek($targetLine);
         
-        if($file->key() !== $targetLine) {
+        if ($file->key() !== $targetLine) {
              return null;
         }
         
@@ -1433,7 +1433,7 @@ 
         $number = $spl->key();
         
         // if seeking to the end the cursor is still at 0, there are no lines. 
-        if($number === 0) 
+        if ($number === 0) 
         {
             // since it's a very small file, to get reliable results,
             // we read its contents and use that to determine what
@@ -1441,13 +1441,13 @@ 
             // that this is not pactical to solve with the SplFileObject.
             $content = file_get_contents($path);
             
-            if(empty($content)) {
+            if (empty($content)) {
                 return 0;
             }
         }
         
         // return the line number we were able to reach + 1 (key is zero-based)
-        return $number+1;
+        return $number + 1;
     }
     
    /**
@@ -1494,13 +1494,13 @@ 
     * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES
     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
     */
-    public static function readLines(string $filePath, int $amount=0) : array
+    public static function readLines(string $filePath, int $amount = 0) : array
     {
         self::requireFileExists($filePath);
         
         $fn = fopen($filePath, "r");
         
-        if($fn === false) 
+        if ($fn === false) 
         {
             throw new FileHelper_Exception(
                 'Could not open file for reading.',
@@ -1516,19 +1516,19 @@ 
         $counter = 0;
         $first = true;
         
-        while(!feof($fn)) 
+        while (!feof($fn)) 
         {
             $counter++;
             
             $line = fgets($fn);
             
             // can happen with zero length files
-            if($line === false) {
+            if ($line === false) {
                 continue;
             }
             
             // the first line may contain a unicode BOM marker.
-            if($first) 
+            if ($first) 
             {
                 $line = ConvertHelper::stripUTFBom($line);
                 $first = false;
@@ -1536,7 +1536,7 @@ 
             
             $result[] = $line;
             
-            if($amount > 0 && $counter == $amount) {
+            if ($amount > 0 && $counter == $amount) {
                 break;
             }
         }
@@ -1562,7 +1562,7 @@ 
         
         $result = file_get_contents($filePath);
         
-        if($result !== false) {
+        if ($result !== false) {
             return $result;
         }
         
@@ -1592,7 +1592,7 @@ 
     {
         $actual = realpath($path);
         
-        if($actual === false) 
+        if ($actual === false) 
         {
             throw new FileHelper_Exception(
                 'Folder does not exist',
@@ -1604,7 +1604,7 @@ 
             );
         }
         
-        if(is_dir($path)) 
+        if (is_dir($path)) 
         {
             return self::normalizePath($actual);
         }