Passed
Push — master ( 9adcd8...42367a )
by Sebastian
02:21
created
src/FileHelper.php 3 patches
Indentation   +410 added lines, -410 removed lines patch added patch discarded remove patch
@@ -76,32 +76,32 @@  discard block
 block discarded – undo
76 76
     
77 77
     const ERROR_CANNOT_OPEN_FILE_TO_DETECT_BOM = 340032;
78 78
     
79
-   /**
80
-    * Opens a serialized file and returns the unserialized data.
81
-    * 
82
-    * @param string $file
83
-    * @throws FileHelper_Exception
84
-    * @return array
85
-    * @deprecated Use parseSerializedFile() instead.
86
-    * @see FileHelper::parseSerializedFile()
87
-    */
79
+    /**
80
+     * Opens a serialized file and returns the unserialized data.
81
+     * 
82
+     * @param string $file
83
+     * @throws FileHelper_Exception
84
+     * @return array
85
+     * @deprecated Use parseSerializedFile() instead.
86
+     * @see FileHelper::parseSerializedFile()
87
+     */
88 88
     public static function openUnserialized(string $file) : array
89 89
     {
90 90
         return self::parseSerializedFile($file);
91 91
     }
92 92
 
93
-   /**
94
-    * Opens a serialized file and returns the unserialized data.
95
-    *
96
-    * @param string $file
97
-    * @throws FileHelper_Exception
98
-    * @return array
99
-    * @see FileHelper::parseSerializedFile()
100
-    * 
101
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
102
-    * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ
103
-    * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED
104
-    */
93
+    /**
94
+     * Opens a serialized file and returns the unserialized data.
95
+     *
96
+     * @param string $file
97
+     * @throws FileHelper_Exception
98
+     * @return array
99
+     * @see FileHelper::parseSerializedFile()
100
+     * 
101
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
102
+     * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ
103
+     * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED
104
+     */
105 105
     public static function parseSerializedFile(string $file)
106 106
     {
107 107
         self::requireFileExists($file);
@@ -170,13 +170,13 @@  discard block
 block discarded – undo
170 170
         return rmdir($rootFolder);
171 171
     }
172 172
     
173
-   /**
174
-    * Create a folder, if it does not exist yet.
175
-    *  
176
-    * @param string $path
177
-    * @throws FileHelper_Exception
178
-    * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
179
-    */
173
+    /**
174
+     * Create a folder, if it does not exist yet.
175
+     *  
176
+     * @param string $path
177
+     * @throws FileHelper_Exception
178
+     * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
179
+     */
180 180
     public static function createFolder($path)
181 181
     {
182 182
         if(is_dir($path) || mkdir($path, 0777, true)) {
@@ -223,22 +223,22 @@  discard block
 block discarded – undo
223 223
         }
224 224
     }
225 225
     
226
-   /**
227
-    * Copies a file to the target location. Includes checks
228
-    * for most error sources, like the source file not being
229
-    * readable. Automatically creates the target folder if it
230
-    * does not exist yet.
231
-    * 
232
-    * @param string $sourcePath
233
-    * @param string $targetPath
234
-    * @throws FileHelper_Exception
235
-    * 
236
-    * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
237
-    * @see FileHelper::ERROR_SOURCE_FILE_NOT_FOUND
238
-    * @see FileHelper::ERROR_SOURCE_FILE_NOT_READABLE
239
-    * @see FileHelper::ERROR_TARGET_COPY_FOLDER_NOT_WRITABLE
240
-    * @see FileHelper::ERROR_CANNOT_COPY_FILE
241
-    */
226
+    /**
227
+     * Copies a file to the target location. Includes checks
228
+     * for most error sources, like the source file not being
229
+     * readable. Automatically creates the target folder if it
230
+     * does not exist yet.
231
+     * 
232
+     * @param string $sourcePath
233
+     * @param string $targetPath
234
+     * @throws FileHelper_Exception
235
+     * 
236
+     * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
237
+     * @see FileHelper::ERROR_SOURCE_FILE_NOT_FOUND
238
+     * @see FileHelper::ERROR_SOURCE_FILE_NOT_READABLE
239
+     * @see FileHelper::ERROR_TARGET_COPY_FOLDER_NOT_WRITABLE
240
+     * @see FileHelper::ERROR_CANNOT_COPY_FILE
241
+     */
242 242
     public static function copyFile($sourcePath, $targetPath)
243 243
     {
244 244
         self::requireFileExists($sourcePath, self::ERROR_SOURCE_FILE_NOT_FOUND);
@@ -289,15 +289,15 @@  discard block
 block discarded – undo
289 289
         );
290 290
     }
291 291
     
292
-   /**
293
-    * Deletes the target file. Ignored if it cannot be found,
294
-    * and throws an exception if it fails.
295
-    * 
296
-    * @param string $filePath
297
-    * @throws FileHelper_Exception
298
-    * 
299
-    * @see FileHelper::ERROR_CANNOT_DELETE_FILE
300
-    */
292
+    /**
293
+     * Deletes the target file. Ignored if it cannot be found,
294
+     * and throws an exception if it fails.
295
+     * 
296
+     * @param string $filePath
297
+     * @throws FileHelper_Exception
298
+     * 
299
+     * @see FileHelper::ERROR_CANNOT_DELETE_FILE
300
+     */
301 301
     public static function deleteFile(string $filePath) : void
302 302
     {
303 303
         if(!file_exists($filePath)) {
@@ -319,15 +319,15 @@  discard block
 block discarded – undo
319 319
     }
320 320
 
321 321
     /**
322
-    * Creates a new CSV parser instance and returns it.
323
-    * 
324
-    * @param string $delimiter
325
-    * @param string $enclosure
326
-    * @param string $escape
327
-    * @param bool $heading
328
-    * @return \parseCSV
329
-    * @todo Move this to the CSV helper.
330
-    */
322
+     * Creates a new CSV parser instance and returns it.
323
+     * 
324
+     * @param string $delimiter
325
+     * @param string $enclosure
326
+     * @param string $escape
327
+     * @param bool $heading
328
+     * @return \parseCSV
329
+     * @todo Move this to the CSV helper.
330
+     */
331 331
     public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : \parseCSV
332 332
     {
333 333
         if($delimiter==='') { $delimiter = ';'; }
@@ -342,23 +342,23 @@  discard block
 block discarded – undo
342 342
         return $parser;
343 343
     }
344 344
 
345
-   /**
346
-    * Parses all lines in the specified string and returns an
347
-    * indexed array with all csv values in each line.
348
-    *
349
-    * @param string $csv
350
-    * @param string $delimiter
351
-    * @param string $enclosure
352
-    * @param string $escape
353
-    * @param bool $heading
354
-    * @return array
355
-    * @throws FileHelper_Exception
356
-    * 
357
-    * @todo Move this to the CSVHelper.
358
-    *
359
-    * @see parseCSVFile()
360
-    * @see FileHelper::ERROR_PARSING_CSV
361
-    */
345
+    /**
346
+     * Parses all lines in the specified string and returns an
347
+     * indexed array with all csv values in each line.
348
+     *
349
+     * @param string $csv
350
+     * @param string $delimiter
351
+     * @param string $enclosure
352
+     * @param string $escape
353
+     * @param bool $heading
354
+     * @return array
355
+     * @throws FileHelper_Exception
356
+     * 
357
+     * @todo Move this to the CSVHelper.
358
+     *
359
+     * @see parseCSVFile()
360
+     * @see FileHelper::ERROR_PARSING_CSV
361
+     */
362 362
     public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array
363 363
     {
364 364
         $parser = self::createCSVParser($delimiter, $enclosure, $escape, $heading);
@@ -537,31 +537,31 @@  discard block
 block discarded – undo
537 537
         );
538 538
     }
539 539
     
540
-   /**
541
-    * Verifies whether the target file is a PHP file. The path
542
-    * to the file can be a path to a file as a string, or a 
543
-    * DirectoryIterator object instance.
544
-    * 
545
-    * @param string|\DirectoryIterator $pathOrDirIterator
546
-    * @return boolean
547
-    */
540
+    /**
541
+     * Verifies whether the target file is a PHP file. The path
542
+     * to the file can be a path to a file as a string, or a 
543
+     * DirectoryIterator object instance.
544
+     * 
545
+     * @param string|\DirectoryIterator $pathOrDirIterator
546
+     * @return boolean
547
+     */
548 548
     public static function isPHPFile($pathOrDirIterator)
549 549
     {
550
-    	if(self::getExtension($pathOrDirIterator) == 'php') {
551
-    		return true;
552
-    	}
550
+        if(self::getExtension($pathOrDirIterator) == 'php') {
551
+            return true;
552
+        }
553 553
     	
554
-    	return false;
554
+        return false;
555 555
     }
556 556
     
557
-   /**
558
-    * Retrieves the extension of the specified file. Can be a path
559
-    * to a file as a string, or a DirectoryIterator object instance.
560
-    * 
561
-    * @param string|\DirectoryIterator $pathOrDirIterator
562
-    * @param bool $lowercase
563
-    * @return string
564
-    */
557
+    /**
558
+     * Retrieves the extension of the specified file. Can be a path
559
+     * to a file as a string, or a DirectoryIterator object instance.
560
+     * 
561
+     * @param string|\DirectoryIterator $pathOrDirIterator
562
+     * @param bool $lowercase
563
+     * @return string
564
+     */
565 565
     public static function getExtension($pathOrDirIterator, bool $lowercase = true) : string
566 566
     {
567 567
         if($pathOrDirIterator instanceof \DirectoryIterator) {
@@ -572,51 +572,51 @@  discard block
 block discarded – undo
572 572
          
573 573
         $ext = pathinfo($filename, PATHINFO_EXTENSION);
574 574
         if($lowercase) {
575
-        	$ext = mb_strtolower($ext);
575
+            $ext = mb_strtolower($ext);
576 576
         }
577 577
         
578 578
         return $ext;
579 579
     }
580 580
     
581
-   /**
582
-    * Retrieves the file name from a path, with or without extension.
583
-    * The path to the file can be a string, or a DirectoryIterator object
584
-    * instance.
585
-    * 
586
-    * In case of folders, behaves like the pathinfo function: returns
587
-    * the name of the folder.
588
-    * 
589
-    * @param string|\DirectoryIterator $pathOrDirIterator
590
-    * @param bool $extension
591
-    * @return string
592
-    */
581
+    /**
582
+     * Retrieves the file name from a path, with or without extension.
583
+     * The path to the file can be a string, or a DirectoryIterator object
584
+     * instance.
585
+     * 
586
+     * In case of folders, behaves like the pathinfo function: returns
587
+     * the name of the folder.
588
+     * 
589
+     * @param string|\DirectoryIterator $pathOrDirIterator
590
+     * @param bool $extension
591
+     * @return string
592
+     */
593 593
     public static function getFilename($pathOrDirIterator, $extension = true)
594 594
     {
595 595
         $path = $pathOrDirIterator;
596
-    	if($pathOrDirIterator instanceof \DirectoryIterator) {
597
-    		$path = $pathOrDirIterator->getFilename();
598
-    	}
596
+        if($pathOrDirIterator instanceof \DirectoryIterator) {
597
+            $path = $pathOrDirIterator->getFilename();
598
+        }
599 599
     	
600
-    	$path = self::normalizePath($path);
600
+        $path = self::normalizePath($path);
601 601
     	
602
-    	if(!$extension) {
603
-    	    return pathinfo($path, PATHINFO_FILENAME);
604
-    	}
602
+        if(!$extension) {
603
+            return pathinfo($path, PATHINFO_FILENAME);
604
+        }
605 605
     	
606
-    	return pathinfo($path, PATHINFO_BASENAME); 
606
+        return pathinfo($path, PATHINFO_BASENAME); 
607 607
     }
608 608
    
609
-   /**
610
-    * Tries to read the contents of the target file and
611
-    * treat it as JSON to return the decoded JSON data.
612
-    * 
613
-    * @param string $file
614
-    * @throws FileHelper_Exception
615
-    * @return array
616
-    * 
617
-    * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE
618
-    * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE
619
-    */ 
609
+    /**
610
+     * Tries to read the contents of the target file and
611
+     * treat it as JSON to return the decoded JSON data.
612
+     * 
613
+     * @param string $file
614
+     * @throws FileHelper_Exception
615
+     * @return array
616
+     * 
617
+     * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE
618
+     * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE
619
+     */ 
620 620
     public static function parseJSONFile(string $file, $targetEncoding=null, $sourceEncoding=null)
621 621
     {
622 622
         self::requireFileExists($file, self::ERROR_CANNOT_FIND_JSON_FILE);
@@ -652,16 +652,16 @@  discard block
 block discarded – undo
652 652
         return $json;
653 653
     }
654 654
     
655
-   /**
656
-    * Corrects common formatting mistakes when users enter
657
-    * file names, like too many spaces, dots and the like.
658
-    * 
659
-    * NOTE: if the file name contains a path, the path is
660
-    * stripped, leaving only the file name.
661
-    * 
662
-    * @param string $name
663
-    * @return string
664
-    */
655
+    /**
656
+     * Corrects common formatting mistakes when users enter
657
+     * file names, like too many spaces, dots and the like.
658
+     * 
659
+     * NOTE: if the file name contains a path, the path is
660
+     * stripped, leaving only the file name.
661
+     * 
662
+     * @param string $name
663
+     * @return string
664
+     */
665 665
     public static function fixFileName(string $name) : string
666 666
     {
667 667
         $name = trim($name);
@@ -691,68 +691,68 @@  discard block
 block discarded – undo
691 691
         return $name;
692 692
     }
693 693
     
694
-   /**
695
-    * Creates an instance of the file finder, which is an easier
696
-    * alternative to the other manual findFile methods, since all
697
-    * options can be set by chaining.
698
-    * 
699
-    * @param string $path
700
-    * @return FileHelper_FileFinder
701
-    */
694
+    /**
695
+     * Creates an instance of the file finder, which is an easier
696
+     * alternative to the other manual findFile methods, since all
697
+     * options can be set by chaining.
698
+     * 
699
+     * @param string $path
700
+     * @return FileHelper_FileFinder
701
+     */
702 702
     public static function createFileFinder(string $path) : FileHelper_FileFinder
703 703
     {
704 704
         return new FileHelper_FileFinder($path);
705 705
     }
706 706
     
707
-   /**
708
-    * Searches for all HTML files in the target folder.
709
-    * 
710
-    * NOTE: This method only exists for backwards compatibility.
711
-    * Use the `createFileFinder()` method instead, which offers
712
-    * an object oriented interface that is much easier to use.
713
-    * 
714
-    * @param string $targetFolder
715
-    * @param array $options
716
-    * @return array An indexed array with files.
717
-    * @see FileHelper::createFileFinder()
718
-    */
707
+    /**
708
+     * Searches for all HTML files in the target folder.
709
+     * 
710
+     * NOTE: This method only exists for backwards compatibility.
711
+     * Use the `createFileFinder()` method instead, which offers
712
+     * an object oriented interface that is much easier to use.
713
+     * 
714
+     * @param string $targetFolder
715
+     * @param array $options
716
+     * @return array An indexed array with files.
717
+     * @see FileHelper::createFileFinder()
718
+     */
719 719
     public static function findHTMLFiles(string $targetFolder, array $options=array()) : array
720 720
     {
721 721
         return self::findFiles($targetFolder, array('html'), $options);
722 722
     }
723 723
 
724
-   /**
725
-    * Searches for all PHP files in the target folder.
726
-    * 
727
-    * NOTE: This method only exists for backwards compatibility.
728
-    * Use the `createFileFinder()` method instead, which offers
729
-    * an object oriented interface that is much easier to use.
730
-    * 
731
-    * @param string $targetFolder
732
-    * @param array $options
733
-    * @return array An indexed array of PHP files.
734
-    * @see FileHelper::createFileFinder()
735
-    */
724
+    /**
725
+     * Searches for all PHP files in the target folder.
726
+     * 
727
+     * NOTE: This method only exists for backwards compatibility.
728
+     * Use the `createFileFinder()` method instead, which offers
729
+     * an object oriented interface that is much easier to use.
730
+     * 
731
+     * @param string $targetFolder
732
+     * @param array $options
733
+     * @return array An indexed array of PHP files.
734
+     * @see FileHelper::createFileFinder()
735
+     */
736 736
     public static function findPHPFiles(string $targetFolder, array $options=array()) : array
737 737
     {
738 738
         return self::findFiles($targetFolder, array('php'), $options);
739 739
     }
740 740
     
741
-   /**
742
-    * Finds files according to the specified options.
743
-    * 
744
-    * NOTE: This method only exists for backwards compatibility.
745
-    * Use the `createFileFinder()` method instead, which offers
746
-    * an object oriented interface that is much easier to use.
747
-    *  
748
-    * @param string $targetFolder
749
-    * @param array $extensions
750
-    * @param array $options
751
-    * @param array $files
752
-    * @throws FileHelper_Exception
753
-    * @return array
754
-    * @see FileHelper::createFileFinder()
755
-    */
741
+    /**
742
+     * Finds files according to the specified options.
743
+     * 
744
+     * NOTE: This method only exists for backwards compatibility.
745
+     * Use the `createFileFinder()` method instead, which offers
746
+     * an object oriented interface that is much easier to use.
747
+     *  
748
+     * @param string $targetFolder
749
+     * @param array $extensions
750
+     * @param array $options
751
+     * @param array $files
752
+     * @throws FileHelper_Exception
753
+     * @return array
754
+     * @see FileHelper::createFileFinder()
755
+     */
756 756
     public static function findFiles(string $targetFolder, array $extensions=array(), array $options=array(), array $files=array()) : array
757 757
     {
758 758
         $finder = self::createFileFinder($targetFolder);
@@ -776,13 +776,13 @@  discard block
 block discarded – undo
776 776
         return $files;
777 777
     }
778 778
 
779
-   /**
780
-    * Removes the extension from the specified path or file name,
781
-    * if any, and returns the name without the extension.
782
-    * 
783
-    * @param string $filename
784
-    * @return sTring
785
-    */
779
+    /**
780
+     * Removes the extension from the specified path or file name,
781
+     * if any, and returns the name without the extension.
782
+     * 
783
+     * @param string $filename
784
+     * @return sTring
785
+     */
786 786
     public static function removeExtension(string $filename) : string
787 787
     {
788 788
         // normalize paths to allow windows style slashes even on nix servers
@@ -791,22 +791,22 @@  discard block
 block discarded – undo
791 791
         return pathinfo($filename, PATHINFO_FILENAME);
792 792
     }
793 793
     
794
-   /**
795
-    * Detects the UTF BOM in the target file, if any. Returns
796
-    * the encoding matching the BOM, which can be any of the
797
-    * following:
798
-    * 
799
-    * <ul>
800
-    * <li>UTF32-BE</li>
801
-    * <li>UTF32-LE</li>
802
-    * <li>UTF16-BE</li>
803
-    * <li>UTF16-LE</li>
804
-    * <li>UTF8</li>
805
-    * </ul>
806
-    * 
807
-    * @param string $filename
808
-    * @return string|NULL
809
-    */
794
+    /**
795
+     * Detects the UTF BOM in the target file, if any. Returns
796
+     * the encoding matching the BOM, which can be any of the
797
+     * following:
798
+     * 
799
+     * <ul>
800
+     * <li>UTF32-BE</li>
801
+     * <li>UTF32-LE</li>
802
+     * <li>UTF16-BE</li>
803
+     * <li>UTF16-LE</li>
804
+     * <li>UTF8</li>
805
+     * </ul>
806
+     * 
807
+     * @param string $filename
808
+     * @return string|NULL
809
+     */
810 810
     public static function detectUTFBom(string $filename) : ?string
811 811
     {
812 812
         $fp = fopen($filename, 'r');
@@ -838,13 +838,13 @@  discard block
 block discarded – undo
838 838
     
839 839
     protected static $utfBoms;
840 840
     
841
-   /**
842
-    * Retrieves a list of all UTF byte order mark character
843
-    * sequences, as an assocative array with UTF encoding => bom sequence
844
-    * pairs.
845
-    * 
846
-    * @return array
847
-    */
841
+    /**
842
+     * Retrieves a list of all UTF byte order mark character
843
+     * sequences, as an assocative array with UTF encoding => bom sequence
844
+     * pairs.
845
+     * 
846
+     * @return array
847
+     */
848 848
     public static function getUTFBOMs()
849 849
     {
850 850
         if(!isset(self::$utfBoms)) {
@@ -860,15 +860,15 @@  discard block
 block discarded – undo
860 860
         return self::$utfBoms;
861 861
     }
862 862
     
863
-   /**
864
-    * Checks whether the specified encoding is a valid
865
-    * unicode encoding, for example "UTF16-LE" or "UTF8".
866
-    * Also accounts for alternate way to write the, like
867
-    * "UTF-8", and omitting little/big endian suffixes.
868
-    * 
869
-    * @param string $encoding
870
-    * @return boolean
871
-    */
863
+    /**
864
+     * Checks whether the specified encoding is a valid
865
+     * unicode encoding, for example "UTF16-LE" or "UTF8".
866
+     * Also accounts for alternate way to write the, like
867
+     * "UTF-8", and omitting little/big endian suffixes.
868
+     * 
869
+     * @param string $encoding
870
+     * @return boolean
871
+     */
872 872
     public static function isValidUnicodeEncoding(string $encoding) : bool
873 873
     {
874 874
         $encodings = self::getKnownUnicodeEncodings();
@@ -887,40 +887,40 @@  discard block
 block discarded – undo
887 887
         return in_array($encoding, $keep);
888 888
     }
889 889
     
890
-   /**
891
-    * Retrieves a list of all known unicode file encodings.
892
-    * @return array
893
-    */
890
+    /**
891
+     * Retrieves a list of all known unicode file encodings.
892
+     * @return array
893
+     */
894 894
     public static function getKnownUnicodeEncodings()
895 895
     {
896 896
         return array_keys(self::getUTFBOMs());
897 897
     }
898 898
     
899
-   /**
900
-    * Normalizes the slash style in a file or folder path,
901
-    * by replacing any antislashes with forward slashes.
902
-    * 
903
-    * @param string $path
904
-    * @return string
905
-    */
899
+    /**
900
+     * Normalizes the slash style in a file or folder path,
901
+     * by replacing any antislashes with forward slashes.
902
+     * 
903
+     * @param string $path
904
+     * @return string
905
+     */
906 906
     public static function normalizePath(string $path) : string
907 907
     {
908 908
         return str_replace(array('\\', '//'), array('/', '/'), $path);
909 909
     }
910 910
     
911
-   /**
912
-    * Saves the specified data to a file, JSON encoded.
913
-    * 
914
-    * @param mixed $data
915
-    * @param string $file
916
-    * @param bool $pretty
917
-    * @throws FileHelper_Exception
918
-    * 
919
-    * @see FileHelper::ERROR_JSON_ENCODE_ERROR
920
-    * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE
921
-    * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
922
-    * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
923
-    */
911
+    /**
912
+     * Saves the specified data to a file, JSON encoded.
913
+     * 
914
+     * @param mixed $data
915
+     * @param string $file
916
+     * @param bool $pretty
917
+     * @throws FileHelper_Exception
918
+     * 
919
+     * @see FileHelper::ERROR_JSON_ENCODE_ERROR
920
+     * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE
921
+     * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
922
+     * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
923
+     */
924 924
     public static function saveAsJSON($data, string $file, bool $pretty=false)
925 925
     {
926 926
         $options = null;
@@ -944,18 +944,18 @@  discard block
 block discarded – undo
944 944
         self::saveFile($file, $json);
945 945
     }
946 946
    
947
-   /**
948
-    * Saves the specified content to the target file, creating
949
-    * the file and the folder as necessary.
950
-    * 
951
-    * @param string $filePath
952
-    * @param string $content
953
-    * @throws FileHelper_Exception
954
-    * 
955
-    * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE
956
-    * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
957
-    * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
958
-    */
947
+    /**
948
+     * Saves the specified content to the target file, creating
949
+     * the file and the folder as necessary.
950
+     * 
951
+     * @param string $filePath
952
+     * @param string $content
953
+     * @throws FileHelper_Exception
954
+     * 
955
+     * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE
956
+     * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
957
+     * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
958
+     */
959 959
     public static function saveFile(string $filePath, string $content='') : void
960 960
     {
961 961
         // target file already exists
@@ -1008,12 +1008,12 @@  discard block
 block discarded – undo
1008 1008
         );
1009 1009
     }
1010 1010
     
1011
-   /**
1012
-    * Checks whether it is possible to run PHP command 
1013
-    * line commands.
1014
-    * 
1015
-    * @return boolean
1016
-    */
1011
+    /**
1012
+     * Checks whether it is possible to run PHP command 
1013
+     * line commands.
1014
+     * 
1015
+     * @return boolean
1016
+     */
1017 1017
     public static function canMakePHPCalls() : bool
1018 1018
     {
1019 1019
         return self::cliCommandExists('php');
@@ -1090,16 +1090,16 @@  discard block
 block discarded – undo
1090 1090
         return $result;
1091 1091
     }
1092 1092
     
1093
-   /**
1094
-    * Validates a PHP file's syntax.
1095
-    * 
1096
-    * NOTE: This will fail silently if the PHP command line
1097
-    * is not available. Use {@link FileHelper::canMakePHPCalls()}
1098
-    * to check this beforehand as needed.
1099
-    * 
1100
-    * @param string $path
1101
-    * @return boolean|array A boolean true if the file is valid, an array with validation messages otherwise.
1102
-    */
1093
+    /**
1094
+     * Validates a PHP file's syntax.
1095
+     * 
1096
+     * NOTE: This will fail silently if the PHP command line
1097
+     * is not available. Use {@link FileHelper::canMakePHPCalls()}
1098
+     * to check this beforehand as needed.
1099
+     * 
1100
+     * @param string $path
1101
+     * @return boolean|array A boolean true if the file is valid, an array with validation messages otherwise.
1102
+     */
1103 1103
     public static function checkPHPFileSyntax($path)
1104 1104
     {
1105 1105
         if(!self::canMakePHPCalls()) {
@@ -1123,14 +1123,14 @@  discard block
 block discarded – undo
1123 1123
         return $output;
1124 1124
     }
1125 1125
     
1126
-   /**
1127
-    * Retrieves the last modified date for the specified file or folder.
1128
-    * 
1129
-    * Note: If the target does not exist, returns null. 
1130
-    * 
1131
-    * @param string $path
1132
-    * @return \DateTime|NULL
1133
-    */
1126
+    /**
1127
+     * Retrieves the last modified date for the specified file or folder.
1128
+     * 
1129
+     * Note: If the target does not exist, returns null. 
1130
+     * 
1131
+     * @param string $path
1132
+     * @return \DateTime|NULL
1133
+     */
1134 1134
     public static function getModifiedDate($path)
1135 1135
     {
1136 1136
         $time = filemtime($path);
@@ -1143,24 +1143,24 @@  discard block
 block discarded – undo
1143 1143
         return null; 
1144 1144
     }
1145 1145
     
1146
-   /**
1147
-    * Retrieves the names of all subfolders in the specified path.
1148
-    * 
1149
-    * Available options:
1150
-    * 
1151
-    * - recursive: true/false
1152
-    *   Whether to search for subfolders recursively. 
1153
-    *   
1154
-    * - absolute-paths: true/false
1155
-    *   Whether to return a list of absolute paths.
1156
-    * 
1157
-    * @param string $targetFolder
1158
-    * @param array $options
1159
-    * @throws FileHelper_Exception
1160
-    * @return string[]
1161
-    * 
1162
-    * @todo Move this to a separate class.
1163
-    */
1146
+    /**
1147
+     * Retrieves the names of all subfolders in the specified path.
1148
+     * 
1149
+     * Available options:
1150
+     * 
1151
+     * - recursive: true/false
1152
+     *   Whether to search for subfolders recursively. 
1153
+     *   
1154
+     * - absolute-paths: true/false
1155
+     *   Whether to return a list of absolute paths.
1156
+     * 
1157
+     * @param string $targetFolder
1158
+     * @param array $options
1159
+     * @throws FileHelper_Exception
1160
+     * @return string[]
1161
+     * 
1162
+     * @todo Move this to a separate class.
1163
+     */
1164 1164
     public static function getSubfolders($targetFolder, $options = array())
1165 1165
     {
1166 1166
         if(!is_dir($targetFolder)) 
@@ -1221,16 +1221,16 @@  discard block
 block discarded – undo
1221 1221
         return $result;
1222 1222
     }
1223 1223
 
1224
-   /**
1225
-    * Retrieves the maximum allowed upload file size, in bytes.
1226
-    * Takes into account the PHP ini settings <code>post_max_size</code>
1227
-    * and <code>upload_max_filesize</code>. Since these cannot
1228
-    * be modified at runtime, they are the hard limits for uploads.
1229
-    * 
1230
-    * NOTE: Based on binary values, where 1KB = 1024 Bytes.
1231
-    * 
1232
-    * @return int Will return <code>-1</code> if no limit.
1233
-    */
1224
+    /**
1225
+     * Retrieves the maximum allowed upload file size, in bytes.
1226
+     * Takes into account the PHP ini settings <code>post_max_size</code>
1227
+     * and <code>upload_max_filesize</code>. Since these cannot
1228
+     * be modified at runtime, they are the hard limits for uploads.
1229
+     * 
1230
+     * NOTE: Based on binary values, where 1KB = 1024 Bytes.
1231
+     * 
1232
+     * @return int Will return <code>-1</code> if no limit.
1233
+     */
1234 1234
     public static function getMaxUploadFilesize() : int
1235 1235
     {
1236 1236
         static $max_size = -1;
@@ -1267,16 +1267,16 @@  discard block
 block discarded – undo
1267 1267
         return round($size);
1268 1268
     }
1269 1269
    
1270
-   /**
1271
-    * Makes a path relative using a folder depth: will reduce the
1272
-    * length of the path so that only the amount of folders defined
1273
-    * in the <code>$depth</code> attribute are shown below the actual
1274
-    * folder or file in the path.
1275
-    *  
1276
-    * @param string  $path The absolute or relative path
1277
-    * @param int $depth The folder depth to reduce the path to
1278
-    * @return string
1279
-    */
1270
+    /**
1271
+     * Makes a path relative using a folder depth: will reduce the
1272
+     * length of the path so that only the amount of folders defined
1273
+     * in the <code>$depth</code> attribute are shown below the actual
1274
+     * folder or file in the path.
1275
+     *  
1276
+     * @param string  $path The absolute or relative path
1277
+     * @param int $depth The folder depth to reduce the path to
1278
+     * @return string
1279
+     */
1280 1280
     public static function relativizePathByDepth(string $path, int $depth=2) : string
1281 1281
     {
1282 1282
         $path = self::normalizePath($path);
@@ -1314,23 +1314,23 @@  discard block
 block discarded – undo
1314 1314
         return trim(implode('/', $tokens), '/');
1315 1315
     }
1316 1316
     
1317
-   /**
1318
-    * Makes the specified path relative to another path,
1319
-    * by removing one from the other if found. Also 
1320
-    * normalizes the path to use forward slashes. 
1321
-    * 
1322
-    * Example:
1323
-    * 
1324
-    * <pre>
1325
-    * relativizePath('c:\some\folder\to\file.txt', 'c:\some\folder');
1326
-    * </pre>
1327
-    * 
1328
-    * Result: <code>to/file.txt</code>
1329
-    * 
1330
-    * @param string $path
1331
-    * @param string $relativeTo
1332
-    * @return string
1333
-    */
1317
+    /**
1318
+     * Makes the specified path relative to another path,
1319
+     * by removing one from the other if found. Also 
1320
+     * normalizes the path to use forward slashes. 
1321
+     * 
1322
+     * Example:
1323
+     * 
1324
+     * <pre>
1325
+     * relativizePath('c:\some\folder\to\file.txt', 'c:\some\folder');
1326
+     * </pre>
1327
+     * 
1328
+     * Result: <code>to/file.txt</code>
1329
+     * 
1330
+     * @param string $path
1331
+     * @param string $relativeTo
1332
+     * @return string
1333
+     */
1334 1334
     public static function relativizePath(string $path, string $relativeTo) : string
1335 1335
     {
1336 1336
         $path = self::normalizePath($path);
@@ -1342,17 +1342,17 @@  discard block
 block discarded – undo
1342 1342
         return $relative;
1343 1343
     }
1344 1344
     
1345
-   /**
1346
-    * Checks that the target file exists, and throws an exception
1347
-    * if it does not. 
1348
-    * 
1349
-    * @param string $path
1350
-    * @param int|NULL $errorCode Optional custom error code
1351
-    * @throws FileHelper_Exception
1352
-    * @return string The real path to the file
1353
-    * 
1354
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1355
-    */
1345
+    /**
1346
+     * Checks that the target file exists, and throws an exception
1347
+     * if it does not. 
1348
+     * 
1349
+     * @param string $path
1350
+     * @param int|NULL $errorCode Optional custom error code
1351
+     * @throws FileHelper_Exception
1352
+     * @return string The real path to the file
1353
+     * 
1354
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1355
+     */
1356 1356
     public static function requireFileExists(string $path, $errorCode=null) : string
1357 1357
     {
1358 1358
         $result = realpath($path);
@@ -1371,18 +1371,18 @@  discard block
 block discarded – undo
1371 1371
         );
1372 1372
     }
1373 1373
     
1374
-   /**
1375
-    * Reads a specific line number from the target file and returns its
1376
-    * contents, if the file has such a line. Does so with little memory
1377
-    * usage, as the file is not read entirely into memory.
1378
-    * 
1379
-    * @param string $path
1380
-    * @param int $lineNumber Note: 1-based; the first line is number 1.
1381
-    * @return string|NULL Will return null if the requested line does not exist.
1382
-    * @throws FileHelper_Exception
1383
-    * 
1384
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1385
-    */
1374
+    /**
1375
+     * Reads a specific line number from the target file and returns its
1376
+     * contents, if the file has such a line. Does so with little memory
1377
+     * usage, as the file is not read entirely into memory.
1378
+     * 
1379
+     * @param string $path
1380
+     * @param int $lineNumber Note: 1-based; the first line is number 1.
1381
+     * @return string|NULL Will return null if the requested line does not exist.
1382
+     * @throws FileHelper_Exception
1383
+     * 
1384
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1385
+     */
1386 1386
     public static function getLineFromFile(string $path, int $lineNumber) : ?string
1387 1387
     {
1388 1388
         self::requireFileExists($path);
@@ -1398,19 +1398,19 @@  discard block
 block discarded – undo
1398 1398
         $file->seek($targetLine);
1399 1399
         
1400 1400
         if($file->key() !== $targetLine) {
1401
-             return null;
1401
+                return null;
1402 1402
         }
1403 1403
         
1404 1404
         return $file->current(); 
1405 1405
     }
1406 1406
     
1407
-   /**
1408
-    * Retrieves the total amount of lines in the file, without 
1409
-    * reading the whole file into memory.
1410
-    * 
1411
-    * @param string $path
1412
-    * @return int
1413
-    */
1407
+    /**
1408
+     * Retrieves the total amount of lines in the file, without 
1409
+     * reading the whole file into memory.
1410
+     * 
1411
+     * @param string $path
1412
+     * @return int
1413
+     */
1414 1414
     public static function countFileLines(string $path) : int
1415 1415
     {
1416 1416
         self::requireFileExists($path);
@@ -1440,26 +1440,26 @@  discard block
 block discarded – undo
1440 1440
         return $number+1;
1441 1441
     }
1442 1442
     
1443
-   /**
1444
-    * Parses the target file to detect any PHP classes contained
1445
-    * within, and retrieve information on them. Does not use the 
1446
-    * PHP reflection API.
1447
-    * 
1448
-    * @param string $filePath
1449
-    * @return FileHelper_PHPClassInfo
1450
-    */
1443
+    /**
1444
+     * Parses the target file to detect any PHP classes contained
1445
+     * within, and retrieve information on them. Does not use the 
1446
+     * PHP reflection API.
1447
+     * 
1448
+     * @param string $filePath
1449
+     * @return FileHelper_PHPClassInfo
1450
+     */
1451 1451
     public static function findPHPClasses(string $filePath) : FileHelper_PHPClassInfo
1452 1452
     {
1453 1453
         return new FileHelper_PHPClassInfo($filePath);
1454 1454
     }
1455 1455
     
1456
-   /**
1457
-    * Detects the end of line style used in the target file, if any.
1458
-    * Can be used with large files, because it only reads part of it.
1459
-    * 
1460
-    * @param string $filePath The path to the file.
1461
-    * @return NULL|ConvertHelper_EOL The end of line character information, or NULL if none is found.
1462
-    */
1456
+    /**
1457
+     * Detects the end of line style used in the target file, if any.
1458
+     * Can be used with large files, because it only reads part of it.
1459
+     * 
1460
+     * @param string $filePath The path to the file.
1461
+     * @return NULL|ConvertHelper_EOL The end of line character information, or NULL if none is found.
1462
+     */
1463 1463
     public static function detectEOLCharacter(string $filePath) : ?ConvertHelper_EOL
1464 1464
     {
1465 1465
         // 20 lines is enough to get a good picture of the newline style in the file.
@@ -1472,18 +1472,18 @@  discard block
 block discarded – undo
1472 1472
         return ConvertHelper::detectEOLCharacter($string);
1473 1473
     }
1474 1474
     
1475
-   /**
1476
-    * Reads the specified amount of lines from the target file.
1477
-    * Unicode BOM compatible: any byte order marker is stripped
1478
-    * from the resulting lines.
1479
-    * 
1480
-    * @param string $filePath
1481
-    * @param int $amount Set to 0 to read all lines.
1482
-    * @return array
1483
-    * 
1484
-    * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES
1485
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1486
-    */
1475
+    /**
1476
+     * Reads the specified amount of lines from the target file.
1477
+     * Unicode BOM compatible: any byte order marker is stripped
1478
+     * from the resulting lines.
1479
+     * 
1480
+     * @param string $filePath
1481
+     * @param int $amount Set to 0 to read all lines.
1482
+     * @return array
1483
+     * 
1484
+     * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES
1485
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1486
+     */
1487 1487
     public static function readLines(string $filePath, int $amount=0) : array
1488 1488
     {
1489 1489
         self::requireFileExists($filePath);
@@ -1534,16 +1534,16 @@  discard block
 block discarded – undo
1534 1534
         return $result;
1535 1535
     }
1536 1536
     
1537
-   /**
1538
-    * Reads all content from a file.
1539
-    * 
1540
-    * @param string $filePath
1541
-    * @throws FileHelper_Exception
1542
-    * @return string
1543
-    * 
1544
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1545
-    * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS
1546
-    */
1537
+    /**
1538
+     * Reads all content from a file.
1539
+     * 
1540
+     * @param string $filePath
1541
+     * @throws FileHelper_Exception
1542
+     * @return string
1543
+     * 
1544
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1545
+     * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS
1546
+     */
1547 1547
     public static function readContents(string $filePath) : string
1548 1548
     {
1549 1549
         self::requireFileExists($filePath);
Please login to merge, or discard this patch.
Spacing   +98 added lines, -98 removed lines patch added patch discarded remove patch
@@ -108,7 +108,7 @@  discard block
 block discarded – undo
108 108
         
109 109
         $contents = file_get_contents($file);
110 110
         
111
-        if($contents === false) 
111
+        if ($contents === false) 
112 112
         {
113 113
             throw new FileHelper_Exception(
114 114
                 'Cannot load serialized content from file.',
@@ -122,7 +122,7 @@  discard block
 block discarded – undo
122 122
         
123 123
         $result = @unserialize($contents);
124 124
         
125
-        if($result !== false) {
125
+        if ($result !== false) {
126 126
             return $result;
127 127
         }
128 128
         
@@ -138,7 +138,7 @@  discard block
 block discarded – undo
138 138
     
139 139
     public static function deleteTree($rootFolder)
140 140
     {
141
-        if(!file_exists($rootFolder)) {
141
+        if (!file_exists($rootFolder)) {
142 142
             return true;
143 143
         }
144 144
         
@@ -179,7 +179,7 @@  discard block
 block discarded – undo
179 179
     */
180 180
     public static function createFolder($path)
181 181
     {
182
-        if(is_dir($path) || mkdir($path, 0777, true)) {
182
+        if (is_dir($path) || mkdir($path, 0777, true)) {
183 183
             return;
184 184
         }
185 185
         
@@ -214,11 +214,11 @@  discard block
 block discarded – undo
214 214
 
215 215
             if ($item->isDir()) 
216 216
             {
217
-                FileHelper::copyTree(str_replace('\\', '/', $itemPath), $target . '/' . $baseName);
217
+                FileHelper::copyTree(str_replace('\\', '/', $itemPath), $target.'/'.$baseName);
218 218
             } 
219
-            else if($item->isFile()) 
219
+            else if ($item->isFile()) 
220 220
             {
221
-                self::copyFile($itemPath, $target . '/' . $baseName);
221
+                self::copyFile($itemPath, $target.'/'.$baseName);
222 222
             }
223 223
         }
224 224
     }
@@ -243,7 +243,7 @@  discard block
 block discarded – undo
243 243
     {
244 244
         self::requireFileExists($sourcePath, self::ERROR_SOURCE_FILE_NOT_FOUND);
245 245
         
246
-        if(!is_readable($sourcePath))
246
+        if (!is_readable($sourcePath))
247 247
         {
248 248
             throw new FileHelper_Exception(
249 249
                 sprintf('Source file [%s] to copy is not readable.', basename($sourcePath)),
@@ -257,11 +257,11 @@  discard block
 block discarded – undo
257 257
         
258 258
         $targetFolder = dirname($targetPath);
259 259
         
260
-        if(!file_exists($targetFolder))
260
+        if (!file_exists($targetFolder))
261 261
         {
262 262
             self::createFolder($targetFolder);
263 263
         }
264
-        else if(!is_writable($targetFolder)) 
264
+        else if (!is_writable($targetFolder)) 
265 265
         {
266 266
             throw new FileHelper_Exception(
267 267
                 sprintf('Target folder [%s] is not writable.', basename($targetFolder)),
@@ -273,7 +273,7 @@  discard block
 block discarded – undo
273 273
             );
274 274
         }
275 275
         
276
-        if(copy($sourcePath, $targetPath)) {
276
+        if (copy($sourcePath, $targetPath)) {
277 277
             return;
278 278
         }
279 279
         
@@ -300,11 +300,11 @@  discard block
 block discarded – undo
300 300
     */
301 301
     public static function deleteFile(string $filePath) : void
302 302
     {
303
-        if(!file_exists($filePath)) {
303
+        if (!file_exists($filePath)) {
304 304
             return;
305 305
         }
306 306
         
307
-        if(unlink($filePath)) {
307
+        if (unlink($filePath)) {
308 308
             return;
309 309
         }
310 310
         
@@ -328,10 +328,10 @@  discard block
 block discarded – undo
328 328
     * @return \parseCSV
329 329
     * @todo Move this to the CSV helper.
330 330
     */
331
-    public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : \parseCSV
331
+    public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : \parseCSV
332 332
     {
333
-        if($delimiter==='') { $delimiter = ';'; }
334
-        if($enclosure==='') { $enclosure = '"'; }
333
+        if ($delimiter === '') { $delimiter = ';'; }
334
+        if ($enclosure === '') { $enclosure = '"'; }
335 335
         
336 336
         $parser = new \parseCSV(null, null, null, array());
337 337
 
@@ -359,11 +359,11 @@  discard block
 block discarded – undo
359 359
     * @see parseCSVFile()
360 360
     * @see FileHelper::ERROR_PARSING_CSV
361 361
     */
362
-    public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array
362
+    public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : array
363 363
     {
364 364
         $parser = self::createCSVParser($delimiter, $enclosure, $escape, $heading);
365 365
         $result = $parser->parse_string(/** @scrutinizer ignore-type */ $csv);
366
-        if(is_array($result)) {
366
+        if (is_array($result)) {
367 367
             return $result;
368 368
         }
369 369
         
@@ -391,7 +391,7 @@  discard block
 block discarded – undo
391 391
      * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
392 392
      * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS
393 393
      */
394
-    public static function parseCSVFile(string $filePath, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array
394
+    public static function parseCSVFile(string $filePath, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : array
395 395
     {
396 396
         $content = self::readContents($filePath);
397 397
 
@@ -408,7 +408,7 @@  discard block
 block discarded – undo
408 408
     public static function detectMimeType(string $fileName) : ?string
409 409
     {
410 410
         $ext = self::getExtension($fileName);
411
-        if(empty($ext)) {
411
+        if (empty($ext)) {
412 412
             return null;
413 413
         }
414 414
 
@@ -429,11 +429,11 @@  discard block
 block discarded – undo
429 429
      * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
430 430
      * @see FileHelper::ERROR_UNKNOWN_FILE_MIME_TYPE
431 431
      */
432
-    public static function sendFile(string $filePath, $fileName = null, bool $asAttachment=true)
432
+    public static function sendFile(string $filePath, $fileName = null, bool $asAttachment = true)
433 433
     {
434 434
         self::requireFileExists($filePath);
435 435
         
436
-        if(empty($fileName)) {
436
+        if (empty($fileName)) {
437 437
             $fileName = basename($filePath);
438 438
         }
439 439
 
@@ -451,10 +451,10 @@  discard block
 block discarded – undo
451 451
         
452 452
         header("Cache-Control: public", true);
453 453
         header("Content-Description: File Transfer", true);
454
-        header("Content-Type: " . $mime, true);
454
+        header("Content-Type: ".$mime, true);
455 455
 
456 456
         $disposition = 'inline';
457
-        if($asAttachment) {
457
+        if ($asAttachment) {
458 458
             $disposition = 'attachment';
459 459
         }
460 460
         
@@ -480,7 +480,7 @@  discard block
 block discarded – undo
480 480
      */
481 481
     public static function downloadFile($url)
482 482
     {
483
-        if(!function_exists('curl_init')) 
483
+        if (!function_exists('curl_init')) 
484 484
         {
485 485
             throw new FileHelper_Exception(
486 486
                 'The cURL extension is not installed.',
@@ -490,7 +490,7 @@  discard block
 block discarded – undo
490 490
         }
491 491
 
492 492
         $ch = curl_init();
493
-        if($ch === false) 
493
+        if ($ch === false) 
494 494
         {
495 495
             throw new FileHelper_Exception(
496 496
                 'Could not initialize a new cURL instance.',
@@ -511,7 +511,7 @@  discard block
 block discarded – undo
511 511
         
512 512
         $output = curl_exec($ch);
513 513
 
514
-        if($output === false) {
514
+        if ($output === false) {
515 515
             throw new FileHelper_Exception(
516 516
                 'Unable to open URL',
517 517
                 sprintf(
@@ -525,7 +525,7 @@  discard block
 block discarded – undo
525 525
 
526 526
         curl_close($ch);
527 527
 
528
-        if(is_string($output)) 
528
+        if (is_string($output)) 
529 529
         {
530 530
             return $output;
531 531
         }
@@ -547,7 +547,7 @@  discard block
 block discarded – undo
547 547
     */
548 548
     public static function isPHPFile($pathOrDirIterator)
549 549
     {
550
-    	if(self::getExtension($pathOrDirIterator) == 'php') {
550
+    	if (self::getExtension($pathOrDirIterator) == 'php') {
551 551
     		return true;
552 552
     	}
553 553
     	
@@ -564,14 +564,14 @@  discard block
 block discarded – undo
564 564
     */
565 565
     public static function getExtension($pathOrDirIterator, bool $lowercase = true) : string
566 566
     {
567
-        if($pathOrDirIterator instanceof \DirectoryIterator) {
567
+        if ($pathOrDirIterator instanceof \DirectoryIterator) {
568 568
             $filename = $pathOrDirIterator->getFilename();
569 569
         } else {
570 570
             $filename = basename($pathOrDirIterator);
571 571
         }
572 572
          
573 573
         $ext = pathinfo($filename, PATHINFO_EXTENSION);
574
-        if($lowercase) {
574
+        if ($lowercase) {
575 575
         	$ext = mb_strtolower($ext);
576 576
         }
577 577
         
@@ -593,13 +593,13 @@  discard block
 block discarded – undo
593 593
     public static function getFilename($pathOrDirIterator, $extension = true)
594 594
     {
595 595
         $path = $pathOrDirIterator;
596
-    	if($pathOrDirIterator instanceof \DirectoryIterator) {
596
+    	if ($pathOrDirIterator instanceof \DirectoryIterator) {
597 597
     		$path = $pathOrDirIterator->getFilename();
598 598
     	}
599 599
     	
600 600
     	$path = self::normalizePath($path);
601 601
     	
602
-    	if(!$extension) {
602
+    	if (!$extension) {
603 603
     	    return pathinfo($path, PATHINFO_FILENAME);
604 604
     	}
605 605
     	
@@ -617,12 +617,12 @@  discard block
 block discarded – undo
617 617
     * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE
618 618
     * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE
619 619
     */ 
620
-    public static function parseJSONFile(string $file, $targetEncoding=null, $sourceEncoding=null)
620
+    public static function parseJSONFile(string $file, $targetEncoding = null, $sourceEncoding = null)
621 621
     {
622 622
         self::requireFileExists($file, self::ERROR_CANNOT_FIND_JSON_FILE);
623 623
         
624 624
         $content = file_get_contents($file);
625
-        if(!$content) {
625
+        if (!$content) {
626 626
             throw new FileHelper_Exception(
627 627
                 'Cannot get file contents',
628 628
                 sprintf(
@@ -633,12 +633,12 @@  discard block
 block discarded – undo
633 633
             );
634 634
         }
635 635
         
636
-        if(isset($targetEncoding)) {
636
+        if (isset($targetEncoding)) {
637 637
             $content = mb_convert_encoding($content, $targetEncoding, $sourceEncoding);
638 638
         }
639 639
         
640 640
         $json = json_decode($content, true);
641
-        if($json === false || $json === NULL) {
641
+        if ($json === false || $json === NULL) {
642 642
             throw new FileHelper_Exception(
643 643
                 'Cannot decode json data',
644 644
                 sprintf(
@@ -678,13 +678,13 @@  discard block
 block discarded – undo
678 678
         
679 679
         $name = str_replace(array_keys($replaces), array_values($replaces), $name);
680 680
         
681
-        while(strstr($name, '  ')) {
681
+        while (strstr($name, '  ')) {
682 682
             $name = str_replace('  ', ' ', $name);
683 683
         }
684 684
 
685 685
         $name = str_replace(array_keys($replaces), array_values($replaces), $name);
686 686
         
687
-        while(strstr($name, '..')) {
687
+        while (strstr($name, '..')) {
688 688
             $name = str_replace('..', '.', $name);
689 689
         }
690 690
         
@@ -716,7 +716,7 @@  discard block
 block discarded – undo
716 716
     * @return array An indexed array with files.
717 717
     * @see FileHelper::createFileFinder()
718 718
     */
719
-    public static function findHTMLFiles(string $targetFolder, array $options=array()) : array
719
+    public static function findHTMLFiles(string $targetFolder, array $options = array()) : array
720 720
     {
721 721
         return self::findFiles($targetFolder, array('html'), $options);
722 722
     }
@@ -733,7 +733,7 @@  discard block
 block discarded – undo
733 733
     * @return array An indexed array of PHP files.
734 734
     * @see FileHelper::createFileFinder()
735 735
     */
736
-    public static function findPHPFiles(string $targetFolder, array $options=array()) : array
736
+    public static function findPHPFiles(string $targetFolder, array $options = array()) : array
737 737
     {
738 738
         return self::findFiles($targetFolder, array('php'), $options);
739 739
     }
@@ -753,20 +753,20 @@  discard block
 block discarded – undo
753 753
     * @return array
754 754
     * @see FileHelper::createFileFinder()
755 755
     */
756
-    public static function findFiles(string $targetFolder, array $extensions=array(), array $options=array(), array $files=array()) : array
756
+    public static function findFiles(string $targetFolder, array $extensions = array(), array $options = array(), array $files = array()) : array
757 757
     {
758 758
         $finder = self::createFileFinder($targetFolder);
759 759
 
760
-        if(isset($options['relative-path']) && $options['relative-path'] === true) 
760
+        if (isset($options['relative-path']) && $options['relative-path'] === true) 
761 761
         {
762 762
             $finder->setPathmodeRelative();
763 763
         } 
764
-        else if(isset($options['absolute-path']) && $options['absolute-path'] === true)
764
+        else if (isset($options['absolute-path']) && $options['absolute-path'] === true)
765 765
         {
766 766
             $finder->setPathmodeAbsolute();
767 767
         }
768 768
         
769
-        if(isset($options['strip-extension'])) 
769
+        if (isset($options['strip-extension'])) 
770 770
         {
771 771
             $finder->stripExtensions();
772 772
         }
@@ -810,7 +810,7 @@  discard block
 block discarded – undo
810 810
     public static function detectUTFBom(string $filename) : ?string
811 811
     {
812 812
         $fp = fopen($filename, 'r');
813
-        if($fp === false) 
813
+        if ($fp === false) 
814 814
         {
815 815
             throw new FileHelper_Exception(
816 816
                 'Cannot open file for reading',
@@ -825,10 +825,10 @@  discard block
 block discarded – undo
825 825
 
826 826
         $boms = self::getUTFBOMs();
827 827
         
828
-        foreach($boms as $bom => $value) 
828
+        foreach ($boms as $bom => $value) 
829 829
         {
830 830
             $length = mb_strlen($value);
831
-            if(mb_substr($text, 0, $length) == $value) {
831
+            if (mb_substr($text, 0, $length) == $value) {
832 832
                 return $bom;
833 833
             }
834 834
         }
@@ -847,13 +847,13 @@  discard block
 block discarded – undo
847 847
     */
848 848
     public static function getUTFBOMs()
849 849
     {
850
-        if(!isset(self::$utfBoms)) {
850
+        if (!isset(self::$utfBoms)) {
851 851
             self::$utfBoms = array(
852
-                'UTF32-BE' => chr(0x00) . chr(0x00) . chr(0xFE) . chr(0xFF),
853
-                'UTF32-LE' => chr(0xFF) . chr(0xFE) . chr(0x00) . chr(0x00),
854
-                'UTF16-BE' => chr(0xFE) . chr(0xFF),
855
-                'UTF16-LE' => chr(0xFF) . chr(0xFE),
856
-                'UTF8' => chr(0xEF) . chr(0xBB) . chr(0xBF)
852
+                'UTF32-BE' => chr(0x00).chr(0x00).chr(0xFE).chr(0xFF),
853
+                'UTF32-LE' => chr(0xFF).chr(0xFE).chr(0x00).chr(0x00),
854
+                'UTF16-BE' => chr(0xFE).chr(0xFF),
855
+                'UTF16-LE' => chr(0xFF).chr(0xFE),
856
+                'UTF8' => chr(0xEF).chr(0xBB).chr(0xBF)
857 857
             );
858 858
         }
859 859
         
@@ -874,7 +874,7 @@  discard block
 block discarded – undo
874 874
         $encodings = self::getKnownUnicodeEncodings();
875 875
 
876 876
         $keep = array();
877
-        foreach($encodings as $string) 
877
+        foreach ($encodings as $string) 
878 878
         {
879 879
             $withHyphen = str_replace('UTF', 'UTF-', $string);
880 880
             
@@ -921,16 +921,16 @@  discard block
 block discarded – undo
921 921
     * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
922 922
     * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
923 923
     */
924
-    public static function saveAsJSON($data, string $file, bool $pretty=false)
924
+    public static function saveAsJSON($data, string $file, bool $pretty = false)
925 925
     {
926 926
         $options = null;
927
-        if($pretty) {
927
+        if ($pretty) {
928 928
             $options = JSON_PRETTY_PRINT;
929 929
         }
930 930
         
931 931
         $json = json_encode($data, $options);
932 932
         
933
-        if($json===false) 
933
+        if ($json === false) 
934 934
         {
935 935
             $errorCode = json_last_error();
936 936
             
@@ -956,12 +956,12 @@  discard block
 block discarded – undo
956 956
     * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
957 957
     * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
958 958
     */
959
-    public static function saveFile(string $filePath, string $content='') : void
959
+    public static function saveFile(string $filePath, string $content = '') : void
960 960
     {
961 961
         // target file already exists
962
-        if(file_exists($filePath))
962
+        if (file_exists($filePath))
963 963
         {
964
-            if(!is_writable($filePath))
964
+            if (!is_writable($filePath))
965 965
             {
966 966
                 throw new FileHelper_Exception(
967 967
                     sprintf('Cannot save file: target file [%s] exists, but is not writable.', basename($filePath)),
@@ -981,7 +981,7 @@  discard block
 block discarded – undo
981 981
             // create the folder as needed
982 982
             self::createFolder($targetFolder);
983 983
             
984
-            if(!is_writable($targetFolder)) 
984
+            if (!is_writable($targetFolder)) 
985 985
             {
986 986
                 throw new FileHelper_Exception(
987 987
                     sprintf('Cannot save file: target folder [%s] is not writable.', basename($targetFolder)),
@@ -994,7 +994,7 @@  discard block
 block discarded – undo
994 994
             }
995 995
         }
996 996
         
997
-        if(file_put_contents($filePath, $content) !== false) {
997
+        if (file_put_contents($filePath, $content) !== false) {
998 998
             return;
999 999
         }
1000 1000
         
@@ -1032,7 +1032,7 @@  discard block
 block discarded – undo
1032 1032
     {
1033 1033
         static $checked = array();
1034 1034
         
1035
-        if(isset($checked[$command])) {
1035
+        if (isset($checked[$command])) {
1036 1036
             return $checked[$command];
1037 1037
         }
1038 1038
         
@@ -1045,7 +1045,7 @@  discard block
 block discarded – undo
1045 1045
         
1046 1046
         $os = strtolower(PHP_OS_FAMILY);
1047 1047
         
1048
-        if(!isset($osCommands[$os])) 
1048
+        if (!isset($osCommands[$os])) 
1049 1049
         {
1050 1050
             throw new FileHelper_Exception(
1051 1051
                 'Unsupported OS for CLI commands',
@@ -1071,7 +1071,7 @@  discard block
 block discarded – undo
1071 1071
             $pipes
1072 1072
         );
1073 1073
         
1074
-        if($process === false) {
1074
+        if ($process === false) {
1075 1075
             $checked[$command] = false;
1076 1076
             return false;
1077 1077
         }
@@ -1102,7 +1102,7 @@  discard block
 block discarded – undo
1102 1102
     */
1103 1103
     public static function checkPHPFileSyntax($path)
1104 1104
     {
1105
-        if(!self::canMakePHPCalls()) {
1105
+        if (!self::canMakePHPCalls()) {
1106 1106
             return true;
1107 1107
         }
1108 1108
         
@@ -1113,7 +1113,7 @@  discard block
 block discarded – undo
1113 1113
         // when the validation is successful, the first entry
1114 1114
         // in the array contains the success message. When it
1115 1115
         // is invalid, the first entry is always empty.
1116
-        if(!empty($output[0])) {
1116
+        if (!empty($output[0])) {
1117 1117
             return true;
1118 1118
         }
1119 1119
         
@@ -1134,7 +1134,7 @@  discard block
 block discarded – undo
1134 1134
     public static function getModifiedDate($path)
1135 1135
     {
1136 1136
         $time = filemtime($path);
1137
-        if($time !== false) {
1137
+        if ($time !== false) {
1138 1138
             $date = new \DateTime();
1139 1139
             $date->setTimestamp($time);
1140 1140
             return $date;
@@ -1163,7 +1163,7 @@  discard block
 block discarded – undo
1163 1163
     */
1164 1164
     public static function getSubfolders($targetFolder, $options = array())
1165 1165
     {
1166
-        if(!is_dir($targetFolder)) 
1166
+        if (!is_dir($targetFolder)) 
1167 1167
         {
1168 1168
             throw new FileHelper_Exception(
1169 1169
                 'Target folder does not exist',
@@ -1187,29 +1187,29 @@  discard block
 block discarded – undo
1187 1187
         
1188 1188
         $d = new \DirectoryIterator($targetFolder);
1189 1189
         
1190
-        foreach($d as $item) 
1190
+        foreach ($d as $item) 
1191 1191
         {
1192
-            if($item->isDir() && !$item->isDot()) 
1192
+            if ($item->isDir() && !$item->isDot()) 
1193 1193
             {
1194 1194
                 $name = $item->getFilename();
1195 1195
                 
1196
-                if(!$options['absolute-path']) {
1196
+                if (!$options['absolute-path']) {
1197 1197
                     $result[] = $name;
1198 1198
                 } else {
1199 1199
                     $result[] = $targetFolder.'/'.$name;
1200 1200
                 }
1201 1201
                 
1202
-                if(!$options['recursive']) 
1202
+                if (!$options['recursive']) 
1203 1203
                 {
1204 1204
                     continue;
1205 1205
                 }
1206 1206
                 
1207 1207
                 $subs = self::getSubfolders($targetFolder.'/'.$name, $options);
1208
-                foreach($subs as $sub) 
1208
+                foreach ($subs as $sub) 
1209 1209
                 {
1210 1210
                     $relative = $name.'/'.$sub;
1211 1211
                     
1212
-                    if(!$options['absolute-path']) {
1212
+                    if (!$options['absolute-path']) {
1213 1213
                         $result[] = $relative;
1214 1214
                     } else {
1215 1215
                         $result[] = $targetFolder.'/'.$relative;
@@ -1277,7 +1277,7 @@  discard block
 block discarded – undo
1277 1277
     * @param int $depth The folder depth to reduce the path to
1278 1278
     * @return string
1279 1279
     */
1280
-    public static function relativizePathByDepth(string $path, int $depth=2) : string
1280
+    public static function relativizePathByDepth(string $path, int $depth = 2) : string
1281 1281
     {
1282 1282
         $path = self::normalizePath($path);
1283 1283
         
@@ -1285,17 +1285,17 @@  discard block
 block discarded – undo
1285 1285
         $tokens = array_filter($tokens); // remove empty entries (trailing slash for example)
1286 1286
         $tokens = array_values($tokens); // re-index keys
1287 1287
         
1288
-        if(empty($tokens)) {
1288
+        if (empty($tokens)) {
1289 1289
             return '';
1290 1290
         }
1291 1291
         
1292 1292
         // remove the drive if present
1293
-        if(strstr($tokens[0], ':')) {
1293
+        if (strstr($tokens[0], ':')) {
1294 1294
             array_shift($tokens);
1295 1295
         }
1296 1296
         
1297 1297
         // path was only the drive
1298
-        if(count($tokens) == 0) {
1298
+        if (count($tokens) == 0) {
1299 1299
             return '';
1300 1300
         }
1301 1301
 
@@ -1304,8 +1304,8 @@  discard block
 block discarded – undo
1304 1304
         
1305 1305
         // reduce the path to the specified depth
1306 1306
         $length = count($tokens);
1307
-        if($length > $depth) {
1308
-            $tokens = array_slice($tokens, $length-$depth);
1307
+        if ($length > $depth) {
1308
+            $tokens = array_slice($tokens, $length - $depth);
1309 1309
         }
1310 1310
 
1311 1311
         // append the last element again
@@ -1353,14 +1353,14 @@  discard block
 block discarded – undo
1353 1353
     * 
1354 1354
     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1355 1355
     */
1356
-    public static function requireFileExists(string $path, $errorCode=null) : string
1356
+    public static function requireFileExists(string $path, $errorCode = null) : string
1357 1357
     {
1358 1358
         $result = realpath($path);
1359
-        if($result !== false) {
1359
+        if ($result !== false) {
1360 1360
             return $result;
1361 1361
         }
1362 1362
         
1363
-        if($errorCode === null) {
1363
+        if ($errorCode === null) {
1364 1364
             $errorCode = self::ERROR_FILE_DOES_NOT_EXIST;
1365 1365
         }
1366 1366
         
@@ -1389,15 +1389,15 @@  discard block
 block discarded – undo
1389 1389
         
1390 1390
         $file = new \SplFileObject($path);
1391 1391
         
1392
-        if($file->eof()) {
1392
+        if ($file->eof()) {
1393 1393
             return '';
1394 1394
         }
1395 1395
         
1396
-        $targetLine = $lineNumber-1;
1396
+        $targetLine = $lineNumber - 1;
1397 1397
         
1398 1398
         $file->seek($targetLine);
1399 1399
         
1400
-        if($file->key() !== $targetLine) {
1400
+        if ($file->key() !== $targetLine) {
1401 1401
              return null;
1402 1402
         }
1403 1403
         
@@ -1423,7 +1423,7 @@  discard block
 block discarded – undo
1423 1423
         $number = $spl->key();
1424 1424
         
1425 1425
         // if seeking to the end the cursor is still at 0, there are no lines. 
1426
-        if($number === 0) 
1426
+        if ($number === 0) 
1427 1427
         {
1428 1428
             // since it's a very small file, to get reliable results,
1429 1429
             // we read its contents and use that to determine what
@@ -1431,13 +1431,13 @@  discard block
 block discarded – undo
1431 1431
             // that this is not pactical to solve with the SplFileObject.
1432 1432
             $content = file_get_contents($path);
1433 1433
             
1434
-            if(empty($content)) {
1434
+            if (empty($content)) {
1435 1435
                 return 0;
1436 1436
             }
1437 1437
         }
1438 1438
         
1439 1439
         // return the line number we were able to reach + 1 (key is zero-based)
1440
-        return $number+1;
1440
+        return $number + 1;
1441 1441
     }
1442 1442
     
1443 1443
    /**
@@ -1484,13 +1484,13 @@  discard block
 block discarded – undo
1484 1484
     * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES
1485 1485
     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1486 1486
     */
1487
-    public static function readLines(string $filePath, int $amount=0) : array
1487
+    public static function readLines(string $filePath, int $amount = 0) : array
1488 1488
     {
1489 1489
         self::requireFileExists($filePath);
1490 1490
         
1491 1491
         $fn = fopen($filePath, "r");
1492 1492
         
1493
-        if($fn === false) 
1493
+        if ($fn === false) 
1494 1494
         {
1495 1495
             throw new FileHelper_Exception(
1496 1496
                 'Could not open file for reading.',
@@ -1506,25 +1506,25 @@  discard block
 block discarded – undo
1506 1506
         $counter = 0;
1507 1507
         $first = true;
1508 1508
         
1509
-        while(!feof($fn)) 
1509
+        while (!feof($fn)) 
1510 1510
         {
1511 1511
             $counter++;
1512 1512
             
1513 1513
             $line = fgets($fn);
1514 1514
             
1515 1515
             // can happen with zero length files
1516
-            if($line === false) {
1516
+            if ($line === false) {
1517 1517
                 continue;
1518 1518
             }
1519 1519
             
1520 1520
             // the first line may contain a unicode BOM marker.
1521
-            if($first) {
1521
+            if ($first) {
1522 1522
                 $line = ConvertHelper::stripUTFBom($line);
1523 1523
             }
1524 1524
             
1525 1525
             $result[] = $line;
1526 1526
             
1527
-            if($amount > 0 && $counter == $amount) {
1527
+            if ($amount > 0 && $counter == $amount) {
1528 1528
                 break;
1529 1529
             }
1530 1530
         }
@@ -1550,7 +1550,7 @@  discard block
 block discarded – undo
1550 1550
         
1551 1551
         $result = file_get_contents($filePath);
1552 1552
         
1553
-        if($result !== false) {
1553
+        if ($result !== false) {
1554 1554
             return $result;
1555 1555
         }
1556 1556
         
Please login to merge, or discard this patch.
Braces   +3 added lines, -6 removed lines patch added patch discarded remove patch
@@ -215,8 +215,7 @@  discard block
 block discarded – undo
215 215
             if ($item->isDir()) 
216 216
             {
217 217
                 FileHelper::copyTree(str_replace('\\', '/', $itemPath), $target . '/' . $baseName);
218
-            } 
219
-            else if($item->isFile()) 
218
+            } else if($item->isFile()) 
220 219
             {
221 220
                 self::copyFile($itemPath, $target . '/' . $baseName);
222 221
             }
@@ -260,8 +259,7 @@  discard block
 block discarded – undo
260 259
         if(!file_exists($targetFolder))
261 260
         {
262 261
             self::createFolder($targetFolder);
263
-        }
264
-        else if(!is_writable($targetFolder)) 
262
+        } else if(!is_writable($targetFolder)) 
265 263
         {
266 264
             throw new FileHelper_Exception(
267 265
                 sprintf('Target folder [%s] is not writable.', basename($targetFolder)),
@@ -760,8 +758,7 @@  discard block
 block discarded – undo
760 758
         if(isset($options['relative-path']) && $options['relative-path'] === true) 
761 759
         {
762 760
             $finder->setPathmodeRelative();
763
-        } 
764
-        else if(isset($options['absolute-path']) && $options['absolute-path'] === true)
761
+        } else if(isset($options['absolute-path']) && $options['absolute-path'] === true)
765 762
         {
766 763
             $finder->setPathmodeAbsolute();
767 764
         }
Please login to merge, or discard this patch.