@@ -215,8 +215,7 @@ discard block |
||
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 |
||
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 |
||
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 | } |
@@ -74,32 +74,32 @@ discard block |
||
74 | 74 | |
75 | 75 | const ERROR_CANNOT_OPEN_FILE_TO_DETECT_BOM = 340032; |
76 | 76 | |
77 | - /** |
|
78 | - * Opens a serialized file and returns the unserialized data. |
|
79 | - * |
|
80 | - * @param string $file |
|
81 | - * @throws FileHelper_Exception |
|
82 | - * @return array |
|
83 | - * @deprecated Use parseSerializedFile() instead. |
|
84 | - * @see FileHelper::parseSerializedFile() |
|
85 | - */ |
|
77 | + /** |
|
78 | + * Opens a serialized file and returns the unserialized data. |
|
79 | + * |
|
80 | + * @param string $file |
|
81 | + * @throws FileHelper_Exception |
|
82 | + * @return array |
|
83 | + * @deprecated Use parseSerializedFile() instead. |
|
84 | + * @see FileHelper::parseSerializedFile() |
|
85 | + */ |
|
86 | 86 | public static function openUnserialized(string $file) : array |
87 | 87 | { |
88 | 88 | return self::parseSerializedFile($file); |
89 | 89 | } |
90 | 90 | |
91 | - /** |
|
92 | - * Opens a serialized file and returns the unserialized data. |
|
93 | - * |
|
94 | - * @param string $file |
|
95 | - * @throws FileHelper_Exception |
|
96 | - * @return array |
|
97 | - * @see FileHelper::parseSerializedFile() |
|
98 | - * |
|
99 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
100 | - * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ |
|
101 | - * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED |
|
102 | - */ |
|
91 | + /** |
|
92 | + * Opens a serialized file and returns the unserialized data. |
|
93 | + * |
|
94 | + * @param string $file |
|
95 | + * @throws FileHelper_Exception |
|
96 | + * @return array |
|
97 | + * @see FileHelper::parseSerializedFile() |
|
98 | + * |
|
99 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
100 | + * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ |
|
101 | + * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED |
|
102 | + */ |
|
103 | 103 | public static function parseSerializedFile(string $file) |
104 | 104 | { |
105 | 105 | self::requireFileExists($file); |
@@ -168,13 +168,13 @@ discard block |
||
168 | 168 | return rmdir($rootFolder); |
169 | 169 | } |
170 | 170 | |
171 | - /** |
|
172 | - * Create a folder, if it does not exist yet. |
|
173 | - * |
|
174 | - * @param string $path |
|
175 | - * @throws FileHelper_Exception |
|
176 | - * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER |
|
177 | - */ |
|
171 | + /** |
|
172 | + * Create a folder, if it does not exist yet. |
|
173 | + * |
|
174 | + * @param string $path |
|
175 | + * @throws FileHelper_Exception |
|
176 | + * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER |
|
177 | + */ |
|
178 | 178 | public static function createFolder($path) |
179 | 179 | { |
180 | 180 | if(is_dir($path) || mkdir($path, 0777, true)) { |
@@ -221,22 +221,22 @@ discard block |
||
221 | 221 | } |
222 | 222 | } |
223 | 223 | |
224 | - /** |
|
225 | - * Copies a file to the target location. Includes checks |
|
226 | - * for most error sources, like the source file not being |
|
227 | - * readable. Automatically creates the target folder if it |
|
228 | - * does not exist yet. |
|
229 | - * |
|
230 | - * @param string $sourcePath |
|
231 | - * @param string $targetPath |
|
232 | - * @throws FileHelper_Exception |
|
233 | - * |
|
234 | - * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER |
|
235 | - * @see FileHelper::ERROR_SOURCE_FILE_NOT_FOUND |
|
236 | - * @see FileHelper::ERROR_SOURCE_FILE_NOT_READABLE |
|
237 | - * @see FileHelper::ERROR_TARGET_COPY_FOLDER_NOT_WRITABLE |
|
238 | - * @see FileHelper::ERROR_CANNOT_COPY_FILE |
|
239 | - */ |
|
224 | + /** |
|
225 | + * Copies a file to the target location. Includes checks |
|
226 | + * for most error sources, like the source file not being |
|
227 | + * readable. Automatically creates the target folder if it |
|
228 | + * does not exist yet. |
|
229 | + * |
|
230 | + * @param string $sourcePath |
|
231 | + * @param string $targetPath |
|
232 | + * @throws FileHelper_Exception |
|
233 | + * |
|
234 | + * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER |
|
235 | + * @see FileHelper::ERROR_SOURCE_FILE_NOT_FOUND |
|
236 | + * @see FileHelper::ERROR_SOURCE_FILE_NOT_READABLE |
|
237 | + * @see FileHelper::ERROR_TARGET_COPY_FOLDER_NOT_WRITABLE |
|
238 | + * @see FileHelper::ERROR_CANNOT_COPY_FILE |
|
239 | + */ |
|
240 | 240 | public static function copyFile($sourcePath, $targetPath) |
241 | 241 | { |
242 | 242 | self::requireFileExists($sourcePath, self::ERROR_SOURCE_FILE_NOT_FOUND); |
@@ -287,15 +287,15 @@ discard block |
||
287 | 287 | ); |
288 | 288 | } |
289 | 289 | |
290 | - /** |
|
291 | - * Deletes the target file. Ignored if it cannot be found, |
|
292 | - * and throws an exception if it fails. |
|
293 | - * |
|
294 | - * @param string $filePath |
|
295 | - * @throws FileHelper_Exception |
|
296 | - * |
|
297 | - * @see FileHelper::ERROR_CANNOT_DELETE_FILE |
|
298 | - */ |
|
290 | + /** |
|
291 | + * Deletes the target file. Ignored if it cannot be found, |
|
292 | + * and throws an exception if it fails. |
|
293 | + * |
|
294 | + * @param string $filePath |
|
295 | + * @throws FileHelper_Exception |
|
296 | + * |
|
297 | + * @see FileHelper::ERROR_CANNOT_DELETE_FILE |
|
298 | + */ |
|
299 | 299 | public static function deleteFile(string $filePath) : void |
300 | 300 | { |
301 | 301 | if(!file_exists($filePath)) { |
@@ -317,15 +317,15 @@ discard block |
||
317 | 317 | } |
318 | 318 | |
319 | 319 | /** |
320 | - * Creates a new CSV parser instance and returns it. |
|
321 | - * |
|
322 | - * @param string $delimiter |
|
323 | - * @param string $enclosure |
|
324 | - * @param string $escape |
|
325 | - * @param bool $heading |
|
326 | - * @return \parseCSV |
|
327 | - * @todo Move this to the CSV helper. |
|
328 | - */ |
|
320 | + * Creates a new CSV parser instance and returns it. |
|
321 | + * |
|
322 | + * @param string $delimiter |
|
323 | + * @param string $enclosure |
|
324 | + * @param string $escape |
|
325 | + * @param bool $heading |
|
326 | + * @return \parseCSV |
|
327 | + * @todo Move this to the CSV helper. |
|
328 | + */ |
|
329 | 329 | public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : \parseCSV |
330 | 330 | { |
331 | 331 | if($delimiter==='') { $delimiter = ';'; } |
@@ -340,23 +340,23 @@ discard block |
||
340 | 340 | return $parser; |
341 | 341 | } |
342 | 342 | |
343 | - /** |
|
344 | - * Parses all lines in the specified string and returns an |
|
345 | - * indexed array with all csv values in each line. |
|
346 | - * |
|
347 | - * @param string $csv |
|
348 | - * @param string $delimiter |
|
349 | - * @param string $enclosure |
|
350 | - * @param string $escape |
|
351 | - * @param bool $heading |
|
352 | - * @return array |
|
353 | - * @throws FileHelper_Exception |
|
354 | - * |
|
355 | - * @todo Move this to the CSVHelper. |
|
356 | - * |
|
357 | - * @see parseCSVFile() |
|
358 | - * @see FileHelper::ERROR_PARSING_CSV |
|
359 | - */ |
|
343 | + /** |
|
344 | + * Parses all lines in the specified string and returns an |
|
345 | + * indexed array with all csv values in each line. |
|
346 | + * |
|
347 | + * @param string $csv |
|
348 | + * @param string $delimiter |
|
349 | + * @param string $enclosure |
|
350 | + * @param string $escape |
|
351 | + * @param bool $heading |
|
352 | + * @return array |
|
353 | + * @throws FileHelper_Exception |
|
354 | + * |
|
355 | + * @todo Move this to the CSVHelper. |
|
356 | + * |
|
357 | + * @see parseCSVFile() |
|
358 | + * @see FileHelper::ERROR_PARSING_CSV |
|
359 | + */ |
|
360 | 360 | public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array |
361 | 361 | { |
362 | 362 | $parser = self::createCSVParser($delimiter, $enclosure, $escape, $heading); |
@@ -527,31 +527,31 @@ discard block |
||
527 | 527 | ); |
528 | 528 | } |
529 | 529 | |
530 | - /** |
|
531 | - * Verifies whether the target file is a PHP file. The path |
|
532 | - * to the file can be a path to a file as a string, or a |
|
533 | - * DirectoryIterator object instance. |
|
534 | - * |
|
535 | - * @param string|\DirectoryIterator $pathOrDirIterator |
|
536 | - * @return boolean |
|
537 | - */ |
|
530 | + /** |
|
531 | + * Verifies whether the target file is a PHP file. The path |
|
532 | + * to the file can be a path to a file as a string, or a |
|
533 | + * DirectoryIterator object instance. |
|
534 | + * |
|
535 | + * @param string|\DirectoryIterator $pathOrDirIterator |
|
536 | + * @return boolean |
|
537 | + */ |
|
538 | 538 | public static function isPHPFile($pathOrDirIterator) |
539 | 539 | { |
540 | - if(self::getExtension($pathOrDirIterator) == 'php') { |
|
541 | - return true; |
|
542 | - } |
|
540 | + if(self::getExtension($pathOrDirIterator) == 'php') { |
|
541 | + return true; |
|
542 | + } |
|
543 | 543 | |
544 | - return false; |
|
544 | + return false; |
|
545 | 545 | } |
546 | 546 | |
547 | - /** |
|
548 | - * Retrieves the extension of the specified file. Can be a path |
|
549 | - * to a file as a string, or a DirectoryIterator object instance. |
|
550 | - * |
|
551 | - * @param string|\DirectoryIterator $pathOrDirIterator |
|
552 | - * @param bool $lowercase |
|
553 | - * @return string |
|
554 | - */ |
|
547 | + /** |
|
548 | + * Retrieves the extension of the specified file. Can be a path |
|
549 | + * to a file as a string, or a DirectoryIterator object instance. |
|
550 | + * |
|
551 | + * @param string|\DirectoryIterator $pathOrDirIterator |
|
552 | + * @param bool $lowercase |
|
553 | + * @return string |
|
554 | + */ |
|
555 | 555 | public static function getExtension($pathOrDirIterator, bool $lowercase = true) : string |
556 | 556 | { |
557 | 557 | if($pathOrDirIterator instanceof \DirectoryIterator) { |
@@ -562,51 +562,51 @@ discard block |
||
562 | 562 | |
563 | 563 | $ext = pathinfo($filename, PATHINFO_EXTENSION); |
564 | 564 | if($lowercase) { |
565 | - $ext = mb_strtolower($ext); |
|
565 | + $ext = mb_strtolower($ext); |
|
566 | 566 | } |
567 | 567 | |
568 | 568 | return $ext; |
569 | 569 | } |
570 | 570 | |
571 | - /** |
|
572 | - * Retrieves the file name from a path, with or without extension. |
|
573 | - * The path to the file can be a string, or a DirectoryIterator object |
|
574 | - * instance. |
|
575 | - * |
|
576 | - * In case of folders, behaves like the pathinfo function: returns |
|
577 | - * the name of the folder. |
|
578 | - * |
|
579 | - * @param string|\DirectoryIterator $pathOrDirIterator |
|
580 | - * @param bool $extension |
|
581 | - * @return string |
|
582 | - */ |
|
571 | + /** |
|
572 | + * Retrieves the file name from a path, with or without extension. |
|
573 | + * The path to the file can be a string, or a DirectoryIterator object |
|
574 | + * instance. |
|
575 | + * |
|
576 | + * In case of folders, behaves like the pathinfo function: returns |
|
577 | + * the name of the folder. |
|
578 | + * |
|
579 | + * @param string|\DirectoryIterator $pathOrDirIterator |
|
580 | + * @param bool $extension |
|
581 | + * @return string |
|
582 | + */ |
|
583 | 583 | public static function getFilename($pathOrDirIterator, $extension = true) |
584 | 584 | { |
585 | 585 | $path = $pathOrDirIterator; |
586 | - if($pathOrDirIterator instanceof \DirectoryIterator) { |
|
587 | - $path = $pathOrDirIterator->getFilename(); |
|
588 | - } |
|
586 | + if($pathOrDirIterator instanceof \DirectoryIterator) { |
|
587 | + $path = $pathOrDirIterator->getFilename(); |
|
588 | + } |
|
589 | 589 | |
590 | - $path = self::normalizePath($path); |
|
590 | + $path = self::normalizePath($path); |
|
591 | 591 | |
592 | - if(!$extension) { |
|
593 | - return pathinfo($path, PATHINFO_FILENAME); |
|
594 | - } |
|
592 | + if(!$extension) { |
|
593 | + return pathinfo($path, PATHINFO_FILENAME); |
|
594 | + } |
|
595 | 595 | |
596 | - return pathinfo($path, PATHINFO_BASENAME); |
|
596 | + return pathinfo($path, PATHINFO_BASENAME); |
|
597 | 597 | } |
598 | 598 | |
599 | - /** |
|
600 | - * Tries to read the contents of the target file and |
|
601 | - * treat it as JSON to return the decoded JSON data. |
|
602 | - * |
|
603 | - * @param string $file |
|
604 | - * @throws FileHelper_Exception |
|
605 | - * @return array |
|
606 | - * |
|
607 | - * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE |
|
608 | - * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE |
|
609 | - */ |
|
599 | + /** |
|
600 | + * Tries to read the contents of the target file and |
|
601 | + * treat it as JSON to return the decoded JSON data. |
|
602 | + * |
|
603 | + * @param string $file |
|
604 | + * @throws FileHelper_Exception |
|
605 | + * @return array |
|
606 | + * |
|
607 | + * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE |
|
608 | + * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE |
|
609 | + */ |
|
610 | 610 | public static function parseJSONFile(string $file, $targetEncoding=null, $sourceEncoding=null) |
611 | 611 | { |
612 | 612 | self::requireFileExists($file, self::ERROR_CANNOT_FIND_JSON_FILE); |
@@ -642,16 +642,16 @@ discard block |
||
642 | 642 | return $json; |
643 | 643 | } |
644 | 644 | |
645 | - /** |
|
646 | - * Corrects common formatting mistakes when users enter |
|
647 | - * file names, like too many spaces, dots and the like. |
|
648 | - * |
|
649 | - * NOTE: if the file name contains a path, the path is |
|
650 | - * stripped, leaving only the file name. |
|
651 | - * |
|
652 | - * @param string $name |
|
653 | - * @return string |
|
654 | - */ |
|
645 | + /** |
|
646 | + * Corrects common formatting mistakes when users enter |
|
647 | + * file names, like too many spaces, dots and the like. |
|
648 | + * |
|
649 | + * NOTE: if the file name contains a path, the path is |
|
650 | + * stripped, leaving only the file name. |
|
651 | + * |
|
652 | + * @param string $name |
|
653 | + * @return string |
|
654 | + */ |
|
655 | 655 | public static function fixFileName(string $name) : string |
656 | 656 | { |
657 | 657 | $name = trim($name); |
@@ -681,68 +681,68 @@ discard block |
||
681 | 681 | return $name; |
682 | 682 | } |
683 | 683 | |
684 | - /** |
|
685 | - * Creates an instance of the file finder, which is an easier |
|
686 | - * alternative to the other manual findFile methods, since all |
|
687 | - * options can be set by chaining. |
|
688 | - * |
|
689 | - * @param string $path |
|
690 | - * @return FileHelper_FileFinder |
|
691 | - */ |
|
684 | + /** |
|
685 | + * Creates an instance of the file finder, which is an easier |
|
686 | + * alternative to the other manual findFile methods, since all |
|
687 | + * options can be set by chaining. |
|
688 | + * |
|
689 | + * @param string $path |
|
690 | + * @return FileHelper_FileFinder |
|
691 | + */ |
|
692 | 692 | public static function createFileFinder(string $path) : FileHelper_FileFinder |
693 | 693 | { |
694 | 694 | return new FileHelper_FileFinder($path); |
695 | 695 | } |
696 | 696 | |
697 | - /** |
|
698 | - * Searches for all HTML files in the target folder. |
|
699 | - * |
|
700 | - * NOTE: This method only exists for backwards compatibility. |
|
701 | - * Use the `createFileFinder()` method instead, which offers |
|
702 | - * an object oriented interface that is much easier to use. |
|
703 | - * |
|
704 | - * @param string $targetFolder |
|
705 | - * @param array $options |
|
706 | - * @return array An indexed array with files. |
|
707 | - * @see FileHelper::createFileFinder() |
|
708 | - */ |
|
697 | + /** |
|
698 | + * Searches for all HTML files in the target folder. |
|
699 | + * |
|
700 | + * NOTE: This method only exists for backwards compatibility. |
|
701 | + * Use the `createFileFinder()` method instead, which offers |
|
702 | + * an object oriented interface that is much easier to use. |
|
703 | + * |
|
704 | + * @param string $targetFolder |
|
705 | + * @param array $options |
|
706 | + * @return array An indexed array with files. |
|
707 | + * @see FileHelper::createFileFinder() |
|
708 | + */ |
|
709 | 709 | public static function findHTMLFiles(string $targetFolder, array $options=array()) : array |
710 | 710 | { |
711 | 711 | return self::findFiles($targetFolder, array('html'), $options); |
712 | 712 | } |
713 | 713 | |
714 | - /** |
|
715 | - * Searches for all PHP files in the target folder. |
|
716 | - * |
|
717 | - * NOTE: This method only exists for backwards compatibility. |
|
718 | - * Use the `createFileFinder()` method instead, which offers |
|
719 | - * an object oriented interface that is much easier to use. |
|
720 | - * |
|
721 | - * @param string $targetFolder |
|
722 | - * @param array $options |
|
723 | - * @return array An indexed array of PHP files. |
|
724 | - * @see FileHelper::createFileFinder() |
|
725 | - */ |
|
714 | + /** |
|
715 | + * Searches for all PHP files in the target folder. |
|
716 | + * |
|
717 | + * NOTE: This method only exists for backwards compatibility. |
|
718 | + * Use the `createFileFinder()` method instead, which offers |
|
719 | + * an object oriented interface that is much easier to use. |
|
720 | + * |
|
721 | + * @param string $targetFolder |
|
722 | + * @param array $options |
|
723 | + * @return array An indexed array of PHP files. |
|
724 | + * @see FileHelper::createFileFinder() |
|
725 | + */ |
|
726 | 726 | public static function findPHPFiles(string $targetFolder, array $options=array()) : array |
727 | 727 | { |
728 | 728 | return self::findFiles($targetFolder, array('php'), $options); |
729 | 729 | } |
730 | 730 | |
731 | - /** |
|
732 | - * Finds files according to the specified options. |
|
733 | - * |
|
734 | - * NOTE: This method only exists for backwards compatibility. |
|
735 | - * Use the `createFileFinder()` method instead, which offers |
|
736 | - * an object oriented interface that is much easier to use. |
|
737 | - * |
|
738 | - * @param string $targetFolder |
|
739 | - * @param array $extensions |
|
740 | - * @param array $options |
|
741 | - * @param array $files |
|
742 | - * @throws FileHelper_Exception |
|
743 | - * @return array |
|
744 | - * @see FileHelper::createFileFinder() |
|
745 | - */ |
|
731 | + /** |
|
732 | + * Finds files according to the specified options. |
|
733 | + * |
|
734 | + * NOTE: This method only exists for backwards compatibility. |
|
735 | + * Use the `createFileFinder()` method instead, which offers |
|
736 | + * an object oriented interface that is much easier to use. |
|
737 | + * |
|
738 | + * @param string $targetFolder |
|
739 | + * @param array $extensions |
|
740 | + * @param array $options |
|
741 | + * @param array $files |
|
742 | + * @throws FileHelper_Exception |
|
743 | + * @return array |
|
744 | + * @see FileHelper::createFileFinder() |
|
745 | + */ |
|
746 | 746 | public static function findFiles(string $targetFolder, array $extensions=array(), array $options=array(), array $files=array()) : array |
747 | 747 | { |
748 | 748 | $finder = self::createFileFinder($targetFolder); |
@@ -768,13 +768,13 @@ discard block |
||
768 | 768 | return $finder->getAll(); |
769 | 769 | } |
770 | 770 | |
771 | - /** |
|
772 | - * Removes the extension from the specified path or file name, |
|
773 | - * if any, and returns the name without the extension. |
|
774 | - * |
|
775 | - * @param string $filename |
|
776 | - * @return sTring |
|
777 | - */ |
|
771 | + /** |
|
772 | + * Removes the extension from the specified path or file name, |
|
773 | + * if any, and returns the name without the extension. |
|
774 | + * |
|
775 | + * @param string $filename |
|
776 | + * @return sTring |
|
777 | + */ |
|
778 | 778 | public static function removeExtension(string $filename) : string |
779 | 779 | { |
780 | 780 | // normalize paths to allow windows style slashes even on nix servers |
@@ -783,22 +783,22 @@ discard block |
||
783 | 783 | return pathinfo($filename, PATHINFO_FILENAME); |
784 | 784 | } |
785 | 785 | |
786 | - /** |
|
787 | - * Detects the UTF BOM in the target file, if any. Returns |
|
788 | - * the encoding matching the BOM, which can be any of the |
|
789 | - * following: |
|
790 | - * |
|
791 | - * <ul> |
|
792 | - * <li>UTF32-BE</li> |
|
793 | - * <li>UTF32-LE</li> |
|
794 | - * <li>UTF16-BE</li> |
|
795 | - * <li>UTF16-LE</li> |
|
796 | - * <li>UTF8</li> |
|
797 | - * </ul> |
|
798 | - * |
|
799 | - * @param string $filename |
|
800 | - * @return string|NULL |
|
801 | - */ |
|
786 | + /** |
|
787 | + * Detects the UTF BOM in the target file, if any. Returns |
|
788 | + * the encoding matching the BOM, which can be any of the |
|
789 | + * following: |
|
790 | + * |
|
791 | + * <ul> |
|
792 | + * <li>UTF32-BE</li> |
|
793 | + * <li>UTF32-LE</li> |
|
794 | + * <li>UTF16-BE</li> |
|
795 | + * <li>UTF16-LE</li> |
|
796 | + * <li>UTF8</li> |
|
797 | + * </ul> |
|
798 | + * |
|
799 | + * @param string $filename |
|
800 | + * @return string|NULL |
|
801 | + */ |
|
802 | 802 | public static function detectUTFBom(string $filename) : ?string |
803 | 803 | { |
804 | 804 | $fp = fopen($filename, 'r'); |
@@ -830,13 +830,13 @@ discard block |
||
830 | 830 | |
831 | 831 | protected static $utfBoms; |
832 | 832 | |
833 | - /** |
|
834 | - * Retrieves a list of all UTF byte order mark character |
|
835 | - * sequences, as an assocative array with UTF encoding => bom sequence |
|
836 | - * pairs. |
|
837 | - * |
|
838 | - * @return array |
|
839 | - */ |
|
833 | + /** |
|
834 | + * Retrieves a list of all UTF byte order mark character |
|
835 | + * sequences, as an assocative array with UTF encoding => bom sequence |
|
836 | + * pairs. |
|
837 | + * |
|
838 | + * @return array |
|
839 | + */ |
|
840 | 840 | public static function getUTFBOMs() |
841 | 841 | { |
842 | 842 | if(!isset(self::$utfBoms)) { |
@@ -852,15 +852,15 @@ discard block |
||
852 | 852 | return self::$utfBoms; |
853 | 853 | } |
854 | 854 | |
855 | - /** |
|
856 | - * Checks whether the specified encoding is a valid |
|
857 | - * unicode encoding, for example "UTF16-LE" or "UTF8". |
|
858 | - * Also accounts for alternate way to write the, like |
|
859 | - * "UTF-8", and omitting little/big endian suffixes. |
|
860 | - * |
|
861 | - * @param string $encoding |
|
862 | - * @return boolean |
|
863 | - */ |
|
855 | + /** |
|
856 | + * Checks whether the specified encoding is a valid |
|
857 | + * unicode encoding, for example "UTF16-LE" or "UTF8". |
|
858 | + * Also accounts for alternate way to write the, like |
|
859 | + * "UTF-8", and omitting little/big endian suffixes. |
|
860 | + * |
|
861 | + * @param string $encoding |
|
862 | + * @return boolean |
|
863 | + */ |
|
864 | 864 | public static function isValidUnicodeEncoding(string $encoding) : bool |
865 | 865 | { |
866 | 866 | $encodings = self::getKnownUnicodeEncodings(); |
@@ -879,40 +879,40 @@ discard block |
||
879 | 879 | return in_array($encoding, $keep); |
880 | 880 | } |
881 | 881 | |
882 | - /** |
|
883 | - * Retrieves a list of all known unicode file encodings. |
|
884 | - * @return array |
|
885 | - */ |
|
882 | + /** |
|
883 | + * Retrieves a list of all known unicode file encodings. |
|
884 | + * @return array |
|
885 | + */ |
|
886 | 886 | public static function getKnownUnicodeEncodings() |
887 | 887 | { |
888 | 888 | return array_keys(self::getUTFBOMs()); |
889 | 889 | } |
890 | 890 | |
891 | - /** |
|
892 | - * Normalizes the slash style in a file or folder path, |
|
893 | - * by replacing any antislashes with forward slashes. |
|
894 | - * |
|
895 | - * @param string $path |
|
896 | - * @return string |
|
897 | - */ |
|
891 | + /** |
|
892 | + * Normalizes the slash style in a file or folder path, |
|
893 | + * by replacing any antislashes with forward slashes. |
|
894 | + * |
|
895 | + * @param string $path |
|
896 | + * @return string |
|
897 | + */ |
|
898 | 898 | public static function normalizePath(string $path) : string |
899 | 899 | { |
900 | 900 | return str_replace(array('\\', '//'), array('/', '/'), $path); |
901 | 901 | } |
902 | 902 | |
903 | - /** |
|
904 | - * Saves the specified data to a file, JSON encoded. |
|
905 | - * |
|
906 | - * @param mixed $data |
|
907 | - * @param string $file |
|
908 | - * @param bool $pretty |
|
909 | - * @throws FileHelper_Exception |
|
910 | - * |
|
911 | - * @see FileHelper::ERROR_JSON_ENCODE_ERROR |
|
912 | - * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE |
|
913 | - * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
|
914 | - * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
|
915 | - */ |
|
903 | + /** |
|
904 | + * Saves the specified data to a file, JSON encoded. |
|
905 | + * |
|
906 | + * @param mixed $data |
|
907 | + * @param string $file |
|
908 | + * @param bool $pretty |
|
909 | + * @throws FileHelper_Exception |
|
910 | + * |
|
911 | + * @see FileHelper::ERROR_JSON_ENCODE_ERROR |
|
912 | + * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE |
|
913 | + * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
|
914 | + * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
|
915 | + */ |
|
916 | 916 | public static function saveAsJSON($data, string $file, bool $pretty=false) |
917 | 917 | { |
918 | 918 | $options = null; |
@@ -936,18 +936,18 @@ discard block |
||
936 | 936 | self::saveFile($file, $json); |
937 | 937 | } |
938 | 938 | |
939 | - /** |
|
940 | - * Saves the specified content to the target file, creating |
|
941 | - * the file and the folder as necessary. |
|
942 | - * |
|
943 | - * @param string $filePath |
|
944 | - * @param string $content |
|
945 | - * @throws FileHelper_Exception |
|
946 | - * |
|
947 | - * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE |
|
948 | - * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
|
949 | - * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
|
950 | - */ |
|
939 | + /** |
|
940 | + * Saves the specified content to the target file, creating |
|
941 | + * the file and the folder as necessary. |
|
942 | + * |
|
943 | + * @param string $filePath |
|
944 | + * @param string $content |
|
945 | + * @throws FileHelper_Exception |
|
946 | + * |
|
947 | + * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE |
|
948 | + * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
|
949 | + * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
|
950 | + */ |
|
951 | 951 | public static function saveFile(string $filePath, string $content='') : void |
952 | 952 | { |
953 | 953 | // target file already exists |
@@ -1000,12 +1000,12 @@ discard block |
||
1000 | 1000 | ); |
1001 | 1001 | } |
1002 | 1002 | |
1003 | - /** |
|
1004 | - * Checks whether it is possible to run PHP command |
|
1005 | - * line commands. |
|
1006 | - * |
|
1007 | - * @return boolean |
|
1008 | - */ |
|
1003 | + /** |
|
1004 | + * Checks whether it is possible to run PHP command |
|
1005 | + * line commands. |
|
1006 | + * |
|
1007 | + * @return boolean |
|
1008 | + */ |
|
1009 | 1009 | public static function canMakePHPCalls() : bool |
1010 | 1010 | { |
1011 | 1011 | return self::cliCommandExists('php'); |
@@ -1082,16 +1082,16 @@ discard block |
||
1082 | 1082 | return $result; |
1083 | 1083 | } |
1084 | 1084 | |
1085 | - /** |
|
1086 | - * Validates a PHP file's syntax. |
|
1087 | - * |
|
1088 | - * NOTE: This will fail silently if the PHP command line |
|
1089 | - * is not available. Use {@link FileHelper::canMakePHPCalls()} |
|
1090 | - * to check this beforehand as needed. |
|
1091 | - * |
|
1092 | - * @param string $path |
|
1093 | - * @return boolean|array A boolean true if the file is valid, an array with validation messages otherwise. |
|
1094 | - */ |
|
1085 | + /** |
|
1086 | + * Validates a PHP file's syntax. |
|
1087 | + * |
|
1088 | + * NOTE: This will fail silently if the PHP command line |
|
1089 | + * is not available. Use {@link FileHelper::canMakePHPCalls()} |
|
1090 | + * to check this beforehand as needed. |
|
1091 | + * |
|
1092 | + * @param string $path |
|
1093 | + * @return boolean|array A boolean true if the file is valid, an array with validation messages otherwise. |
|
1094 | + */ |
|
1095 | 1095 | public static function checkPHPFileSyntax($path) |
1096 | 1096 | { |
1097 | 1097 | if(!self::canMakePHPCalls()) { |
@@ -1115,14 +1115,14 @@ discard block |
||
1115 | 1115 | return $output; |
1116 | 1116 | } |
1117 | 1117 | |
1118 | - /** |
|
1119 | - * Retrieves the last modified date for the specified file or folder. |
|
1120 | - * |
|
1121 | - * Note: If the target does not exist, returns null. |
|
1122 | - * |
|
1123 | - * @param string $path |
|
1124 | - * @return \DateTime|NULL |
|
1125 | - */ |
|
1118 | + /** |
|
1119 | + * Retrieves the last modified date for the specified file or folder. |
|
1120 | + * |
|
1121 | + * Note: If the target does not exist, returns null. |
|
1122 | + * |
|
1123 | + * @param string $path |
|
1124 | + * @return \DateTime|NULL |
|
1125 | + */ |
|
1126 | 1126 | public static function getModifiedDate($path) |
1127 | 1127 | { |
1128 | 1128 | $time = filemtime($path); |
@@ -1135,24 +1135,24 @@ discard block |
||
1135 | 1135 | return null; |
1136 | 1136 | } |
1137 | 1137 | |
1138 | - /** |
|
1139 | - * Retrieves the names of all subfolders in the specified path. |
|
1140 | - * |
|
1141 | - * Available options: |
|
1142 | - * |
|
1143 | - * - recursive: true/false |
|
1144 | - * Whether to search for subfolders recursively. |
|
1145 | - * |
|
1146 | - * - absolute-paths: true/false |
|
1147 | - * Whether to return a list of absolute paths. |
|
1148 | - * |
|
1149 | - * @param string $targetFolder |
|
1150 | - * @param array $options |
|
1151 | - * @throws FileHelper_Exception |
|
1152 | - * @return string[] |
|
1153 | - * |
|
1154 | - * @todo Move this to a separate class. |
|
1155 | - */ |
|
1138 | + /** |
|
1139 | + * Retrieves the names of all subfolders in the specified path. |
|
1140 | + * |
|
1141 | + * Available options: |
|
1142 | + * |
|
1143 | + * - recursive: true/false |
|
1144 | + * Whether to search for subfolders recursively. |
|
1145 | + * |
|
1146 | + * - absolute-paths: true/false |
|
1147 | + * Whether to return a list of absolute paths. |
|
1148 | + * |
|
1149 | + * @param string $targetFolder |
|
1150 | + * @param array $options |
|
1151 | + * @throws FileHelper_Exception |
|
1152 | + * @return string[] |
|
1153 | + * |
|
1154 | + * @todo Move this to a separate class. |
|
1155 | + */ |
|
1156 | 1156 | public static function getSubfolders($targetFolder, $options = array()) |
1157 | 1157 | { |
1158 | 1158 | if(!is_dir($targetFolder)) |
@@ -1213,16 +1213,16 @@ discard block |
||
1213 | 1213 | return $result; |
1214 | 1214 | } |
1215 | 1215 | |
1216 | - /** |
|
1217 | - * Retrieves the maximum allowed upload file size, in bytes. |
|
1218 | - * Takes into account the PHP ini settings <code>post_max_size</code> |
|
1219 | - * and <code>upload_max_filesize</code>. Since these cannot |
|
1220 | - * be modified at runtime, they are the hard limits for uploads. |
|
1221 | - * |
|
1222 | - * NOTE: Based on binary values, where 1KB = 1024 Bytes. |
|
1223 | - * |
|
1224 | - * @return int Will return <code>-1</code> if no limit. |
|
1225 | - */ |
|
1216 | + /** |
|
1217 | + * Retrieves the maximum allowed upload file size, in bytes. |
|
1218 | + * Takes into account the PHP ini settings <code>post_max_size</code> |
|
1219 | + * and <code>upload_max_filesize</code>. Since these cannot |
|
1220 | + * be modified at runtime, they are the hard limits for uploads. |
|
1221 | + * |
|
1222 | + * NOTE: Based on binary values, where 1KB = 1024 Bytes. |
|
1223 | + * |
|
1224 | + * @return int Will return <code>-1</code> if no limit. |
|
1225 | + */ |
|
1226 | 1226 | public static function getMaxUploadFilesize() : int |
1227 | 1227 | { |
1228 | 1228 | static $max_size = -1; |
@@ -1259,16 +1259,16 @@ discard block |
||
1259 | 1259 | return round($size); |
1260 | 1260 | } |
1261 | 1261 | |
1262 | - /** |
|
1263 | - * Makes a path relative using a folder depth: will reduce the |
|
1264 | - * length of the path so that only the amount of folders defined |
|
1265 | - * in the <code>$depth</code> attribute are shown below the actual |
|
1266 | - * folder or file in the path. |
|
1267 | - * |
|
1268 | - * @param string $path The absolute or relative path |
|
1269 | - * @param int $depth The folder depth to reduce the path to |
|
1270 | - * @return string |
|
1271 | - */ |
|
1262 | + /** |
|
1263 | + * Makes a path relative using a folder depth: will reduce the |
|
1264 | + * length of the path so that only the amount of folders defined |
|
1265 | + * in the <code>$depth</code> attribute are shown below the actual |
|
1266 | + * folder or file in the path. |
|
1267 | + * |
|
1268 | + * @param string $path The absolute or relative path |
|
1269 | + * @param int $depth The folder depth to reduce the path to |
|
1270 | + * @return string |
|
1271 | + */ |
|
1272 | 1272 | public static function relativizePathByDepth(string $path, int $depth=2) : string |
1273 | 1273 | { |
1274 | 1274 | $path = self::normalizePath($path); |
@@ -1306,23 +1306,23 @@ discard block |
||
1306 | 1306 | return trim(implode('/', $tokens), '/'); |
1307 | 1307 | } |
1308 | 1308 | |
1309 | - /** |
|
1310 | - * Makes the specified path relative to another path, |
|
1311 | - * by removing one from the other if found. Also |
|
1312 | - * normalizes the path to use forward slashes. |
|
1313 | - * |
|
1314 | - * Example: |
|
1315 | - * |
|
1316 | - * <pre> |
|
1317 | - * relativizePath('c:\some\folder\to\file.txt', 'c:\some\folder'); |
|
1318 | - * </pre> |
|
1319 | - * |
|
1320 | - * Result: <code>to/file.txt</code> |
|
1321 | - * |
|
1322 | - * @param string $path |
|
1323 | - * @param string $relativeTo |
|
1324 | - * @return string |
|
1325 | - */ |
|
1309 | + /** |
|
1310 | + * Makes the specified path relative to another path, |
|
1311 | + * by removing one from the other if found. Also |
|
1312 | + * normalizes the path to use forward slashes. |
|
1313 | + * |
|
1314 | + * Example: |
|
1315 | + * |
|
1316 | + * <pre> |
|
1317 | + * relativizePath('c:\some\folder\to\file.txt', 'c:\some\folder'); |
|
1318 | + * </pre> |
|
1319 | + * |
|
1320 | + * Result: <code>to/file.txt</code> |
|
1321 | + * |
|
1322 | + * @param string $path |
|
1323 | + * @param string $relativeTo |
|
1324 | + * @return string |
|
1325 | + */ |
|
1326 | 1326 | public static function relativizePath(string $path, string $relativeTo) : string |
1327 | 1327 | { |
1328 | 1328 | $path = self::normalizePath($path); |
@@ -1334,17 +1334,17 @@ discard block |
||
1334 | 1334 | return $relative; |
1335 | 1335 | } |
1336 | 1336 | |
1337 | - /** |
|
1338 | - * Checks that the target file exists, and throws an exception |
|
1339 | - * if it does not. |
|
1340 | - * |
|
1341 | - * @param string $path |
|
1342 | - * @param int|NULL $errorCode Optional custom error code |
|
1343 | - * @throws FileHelper_Exception |
|
1344 | - * @return string The real path to the file |
|
1345 | - * |
|
1346 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
1347 | - */ |
|
1337 | + /** |
|
1338 | + * Checks that the target file exists, and throws an exception |
|
1339 | + * if it does not. |
|
1340 | + * |
|
1341 | + * @param string $path |
|
1342 | + * @param int|NULL $errorCode Optional custom error code |
|
1343 | + * @throws FileHelper_Exception |
|
1344 | + * @return string The real path to the file |
|
1345 | + * |
|
1346 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
1347 | + */ |
|
1348 | 1348 | public static function requireFileExists(string $path, $errorCode=null) : string |
1349 | 1349 | { |
1350 | 1350 | $result = realpath($path); |
@@ -1363,18 +1363,18 @@ discard block |
||
1363 | 1363 | ); |
1364 | 1364 | } |
1365 | 1365 | |
1366 | - /** |
|
1367 | - * Reads a specific line number from the target file and returns its |
|
1368 | - * contents, if the file has such a line. Does so with little memory |
|
1369 | - * usage, as the file is not read entirely into memory. |
|
1370 | - * |
|
1371 | - * @param string $path |
|
1372 | - * @param int $lineNumber Note: 1-based; the first line is number 1. |
|
1373 | - * @return string|NULL Will return null if the requested line does not exist. |
|
1374 | - * @throws FileHelper_Exception |
|
1375 | - * |
|
1376 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
1377 | - */ |
|
1366 | + /** |
|
1367 | + * Reads a specific line number from the target file and returns its |
|
1368 | + * contents, if the file has such a line. Does so with little memory |
|
1369 | + * usage, as the file is not read entirely into memory. |
|
1370 | + * |
|
1371 | + * @param string $path |
|
1372 | + * @param int $lineNumber Note: 1-based; the first line is number 1. |
|
1373 | + * @return string|NULL Will return null if the requested line does not exist. |
|
1374 | + * @throws FileHelper_Exception |
|
1375 | + * |
|
1376 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
1377 | + */ |
|
1378 | 1378 | public static function getLineFromFile(string $path, int $lineNumber) : ?string |
1379 | 1379 | { |
1380 | 1380 | self::requireFileExists($path); |
@@ -1390,19 +1390,19 @@ discard block |
||
1390 | 1390 | $file->seek($targetLine); |
1391 | 1391 | |
1392 | 1392 | if($file->key() !== $targetLine) { |
1393 | - return null; |
|
1393 | + return null; |
|
1394 | 1394 | } |
1395 | 1395 | |
1396 | 1396 | return $file->current(); |
1397 | 1397 | } |
1398 | 1398 | |
1399 | - /** |
|
1400 | - * Retrieves the total amount of lines in the file, without |
|
1401 | - * reading the whole file into memory. |
|
1402 | - * |
|
1403 | - * @param string $path |
|
1404 | - * @return int |
|
1405 | - */ |
|
1399 | + /** |
|
1400 | + * Retrieves the total amount of lines in the file, without |
|
1401 | + * reading the whole file into memory. |
|
1402 | + * |
|
1403 | + * @param string $path |
|
1404 | + * @return int |
|
1405 | + */ |
|
1406 | 1406 | public static function countFileLines(string $path) : int |
1407 | 1407 | { |
1408 | 1408 | self::requireFileExists($path); |
@@ -1432,26 +1432,26 @@ discard block |
||
1432 | 1432 | return $number+1; |
1433 | 1433 | } |
1434 | 1434 | |
1435 | - /** |
|
1436 | - * Parses the target file to detect any PHP classes contained |
|
1437 | - * within, and retrieve information on them. Does not use the |
|
1438 | - * PHP reflection API. |
|
1439 | - * |
|
1440 | - * @param string $filePath |
|
1441 | - * @return FileHelper_PHPClassInfo |
|
1442 | - */ |
|
1435 | + /** |
|
1436 | + * Parses the target file to detect any PHP classes contained |
|
1437 | + * within, and retrieve information on them. Does not use the |
|
1438 | + * PHP reflection API. |
|
1439 | + * |
|
1440 | + * @param string $filePath |
|
1441 | + * @return FileHelper_PHPClassInfo |
|
1442 | + */ |
|
1443 | 1443 | public static function findPHPClasses(string $filePath) : FileHelper_PHPClassInfo |
1444 | 1444 | { |
1445 | 1445 | return new FileHelper_PHPClassInfo($filePath); |
1446 | 1446 | } |
1447 | 1447 | |
1448 | - /** |
|
1449 | - * Detects the end of line style used in the target file, if any. |
|
1450 | - * Can be used with large files, because it only reads part of it. |
|
1451 | - * |
|
1452 | - * @param string $filePath The path to the file. |
|
1453 | - * @return NULL|ConvertHelper_EOL The end of line character information, or NULL if none is found. |
|
1454 | - */ |
|
1448 | + /** |
|
1449 | + * Detects the end of line style used in the target file, if any. |
|
1450 | + * Can be used with large files, because it only reads part of it. |
|
1451 | + * |
|
1452 | + * @param string $filePath The path to the file. |
|
1453 | + * @return NULL|ConvertHelper_EOL The end of line character information, or NULL if none is found. |
|
1454 | + */ |
|
1455 | 1455 | public static function detectEOLCharacter(string $filePath) : ?ConvertHelper_EOL |
1456 | 1456 | { |
1457 | 1457 | // 20 lines is enough to get a good picture of the newline style in the file. |
@@ -1464,18 +1464,18 @@ discard block |
||
1464 | 1464 | return ConvertHelper::detectEOLCharacter($string); |
1465 | 1465 | } |
1466 | 1466 | |
1467 | - /** |
|
1468 | - * Reads the specified amount of lines from the target file. |
|
1469 | - * Unicode BOM compatible: any byte order marker is stripped |
|
1470 | - * from the resulting lines. |
|
1471 | - * |
|
1472 | - * @param string $filePath |
|
1473 | - * @param int $amount Set to 0 to read all lines. |
|
1474 | - * @return array |
|
1475 | - * |
|
1476 | - * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES |
|
1477 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
1478 | - */ |
|
1467 | + /** |
|
1468 | + * Reads the specified amount of lines from the target file. |
|
1469 | + * Unicode BOM compatible: any byte order marker is stripped |
|
1470 | + * from the resulting lines. |
|
1471 | + * |
|
1472 | + * @param string $filePath |
|
1473 | + * @param int $amount Set to 0 to read all lines. |
|
1474 | + * @return array |
|
1475 | + * |
|
1476 | + * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES |
|
1477 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
1478 | + */ |
|
1479 | 1479 | public static function readLines(string $filePath, int $amount=0) : array |
1480 | 1480 | { |
1481 | 1481 | self::requireFileExists($filePath); |
@@ -1526,16 +1526,16 @@ discard block |
||
1526 | 1526 | return $result; |
1527 | 1527 | } |
1528 | 1528 | |
1529 | - /** |
|
1530 | - * Reads all content from a file. |
|
1531 | - * |
|
1532 | - * @param string $filePath |
|
1533 | - * @throws FileHelper_Exception |
|
1534 | - * @return string |
|
1535 | - * |
|
1536 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
1537 | - * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS |
|
1538 | - */ |
|
1529 | + /** |
|
1530 | + * Reads all content from a file. |
|
1531 | + * |
|
1532 | + * @param string $filePath |
|
1533 | + * @throws FileHelper_Exception |
|
1534 | + * @return string |
|
1535 | + * |
|
1536 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
1537 | + * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS |
|
1538 | + */ |
|
1539 | 1539 | public static function readContents(string $filePath) : string |
1540 | 1540 | { |
1541 | 1541 | self::requireFileExists($filePath); |
@@ -106,7 +106,7 @@ discard block |
||
106 | 106 | |
107 | 107 | $contents = file_get_contents($file); |
108 | 108 | |
109 | - if($contents === false) |
|
109 | + if ($contents === false) |
|
110 | 110 | { |
111 | 111 | throw new FileHelper_Exception( |
112 | 112 | 'Cannot load serialized content from file.', |
@@ -120,7 +120,7 @@ discard block |
||
120 | 120 | |
121 | 121 | $result = @unserialize($contents); |
122 | 122 | |
123 | - if($result !== false) { |
|
123 | + if ($result !== false) { |
|
124 | 124 | return $result; |
125 | 125 | } |
126 | 126 | |
@@ -136,7 +136,7 @@ discard block |
||
136 | 136 | |
137 | 137 | public static function deleteTree($rootFolder) |
138 | 138 | { |
139 | - if(!file_exists($rootFolder)) { |
|
139 | + if (!file_exists($rootFolder)) { |
|
140 | 140 | return true; |
141 | 141 | } |
142 | 142 | |
@@ -177,7 +177,7 @@ discard block |
||
177 | 177 | */ |
178 | 178 | public static function createFolder($path) |
179 | 179 | { |
180 | - if(is_dir($path) || mkdir($path, 0777, true)) { |
|
180 | + if (is_dir($path) || mkdir($path, 0777, true)) { |
|
181 | 181 | return; |
182 | 182 | } |
183 | 183 | |
@@ -212,11 +212,11 @@ discard block |
||
212 | 212 | |
213 | 213 | if ($item->isDir()) |
214 | 214 | { |
215 | - FileHelper::copyTree(str_replace('\\', '/', $itemPath), $target . '/' . $baseName); |
|
215 | + FileHelper::copyTree(str_replace('\\', '/', $itemPath), $target.'/'.$baseName); |
|
216 | 216 | } |
217 | - else if($item->isFile()) |
|
217 | + else if ($item->isFile()) |
|
218 | 218 | { |
219 | - self::copyFile($itemPath, $target . '/' . $baseName); |
|
219 | + self::copyFile($itemPath, $target.'/'.$baseName); |
|
220 | 220 | } |
221 | 221 | } |
222 | 222 | } |
@@ -241,7 +241,7 @@ discard block |
||
241 | 241 | { |
242 | 242 | self::requireFileExists($sourcePath, self::ERROR_SOURCE_FILE_NOT_FOUND); |
243 | 243 | |
244 | - if(!is_readable($sourcePath)) |
|
244 | + if (!is_readable($sourcePath)) |
|
245 | 245 | { |
246 | 246 | throw new FileHelper_Exception( |
247 | 247 | sprintf('Source file [%s] to copy is not readable.', basename($sourcePath)), |
@@ -255,11 +255,11 @@ discard block |
||
255 | 255 | |
256 | 256 | $targetFolder = dirname($targetPath); |
257 | 257 | |
258 | - if(!file_exists($targetFolder)) |
|
258 | + if (!file_exists($targetFolder)) |
|
259 | 259 | { |
260 | 260 | self::createFolder($targetFolder); |
261 | 261 | } |
262 | - else if(!is_writable($targetFolder)) |
|
262 | + else if (!is_writable($targetFolder)) |
|
263 | 263 | { |
264 | 264 | throw new FileHelper_Exception( |
265 | 265 | sprintf('Target folder [%s] is not writable.', basename($targetFolder)), |
@@ -271,7 +271,7 @@ discard block |
||
271 | 271 | ); |
272 | 272 | } |
273 | 273 | |
274 | - if(copy($sourcePath, $targetPath)) { |
|
274 | + if (copy($sourcePath, $targetPath)) { |
|
275 | 275 | return; |
276 | 276 | } |
277 | 277 | |
@@ -298,11 +298,11 @@ discard block |
||
298 | 298 | */ |
299 | 299 | public static function deleteFile(string $filePath) : void |
300 | 300 | { |
301 | - if(!file_exists($filePath)) { |
|
301 | + if (!file_exists($filePath)) { |
|
302 | 302 | return; |
303 | 303 | } |
304 | 304 | |
305 | - if(unlink($filePath)) { |
|
305 | + if (unlink($filePath)) { |
|
306 | 306 | return; |
307 | 307 | } |
308 | 308 | |
@@ -326,10 +326,10 @@ discard block |
||
326 | 326 | * @return \parseCSV |
327 | 327 | * @todo Move this to the CSV helper. |
328 | 328 | */ |
329 | - public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : \parseCSV |
|
329 | + public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : \parseCSV |
|
330 | 330 | { |
331 | - if($delimiter==='') { $delimiter = ';'; } |
|
332 | - if($enclosure==='') { $enclosure = '"'; } |
|
331 | + if ($delimiter === '') { $delimiter = ';'; } |
|
332 | + if ($enclosure === '') { $enclosure = '"'; } |
|
333 | 333 | |
334 | 334 | $parser = new \parseCSV(null, null, null, array()); |
335 | 335 | |
@@ -357,11 +357,11 @@ discard block |
||
357 | 357 | * @see parseCSVFile() |
358 | 358 | * @see FileHelper::ERROR_PARSING_CSV |
359 | 359 | */ |
360 | - public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array |
|
360 | + public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : array |
|
361 | 361 | { |
362 | 362 | $parser = self::createCSVParser($delimiter, $enclosure, $escape, $heading); |
363 | 363 | $result = $parser->parse_string(/** @scrutinizer ignore-type */ $csv); |
364 | - if(is_array($result)) { |
|
364 | + if (is_array($result)) { |
|
365 | 365 | return $result; |
366 | 366 | } |
367 | 367 | |
@@ -389,7 +389,7 @@ discard block |
||
389 | 389 | * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
390 | 390 | * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS |
391 | 391 | */ |
392 | - public static function parseCSVFile(string $filePath, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array |
|
392 | + public static function parseCSVFile(string $filePath, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : array |
|
393 | 393 | { |
394 | 394 | $content = self::readContents($filePath); |
395 | 395 | |
@@ -406,7 +406,7 @@ discard block |
||
406 | 406 | public static function detectMimeType(string $fileName) : ?string |
407 | 407 | { |
408 | 408 | $ext = self::getExtension($fileName); |
409 | - if(empty($ext)) { |
|
409 | + if (empty($ext)) { |
|
410 | 410 | return null; |
411 | 411 | } |
412 | 412 | |
@@ -427,11 +427,11 @@ discard block |
||
427 | 427 | * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
428 | 428 | * @see FileHelper::ERROR_UNKNOWN_FILE_MIME_TYPE |
429 | 429 | */ |
430 | - public static function sendFile(string $filePath, $fileName = null, bool $asAttachment=true) |
|
430 | + public static function sendFile(string $filePath, $fileName = null, bool $asAttachment = true) |
|
431 | 431 | { |
432 | 432 | self::requireFileExists($filePath); |
433 | 433 | |
434 | - if(empty($fileName)) { |
|
434 | + if (empty($fileName)) { |
|
435 | 435 | $fileName = basename($filePath); |
436 | 436 | } |
437 | 437 | |
@@ -449,10 +449,10 @@ discard block |
||
449 | 449 | |
450 | 450 | header("Cache-Control: public", true); |
451 | 451 | header("Content-Description: File Transfer", true); |
452 | - header("Content-Type: " . $mime, true); |
|
452 | + header("Content-Type: ".$mime, true); |
|
453 | 453 | |
454 | 454 | $disposition = 'inline'; |
455 | - if($asAttachment) { |
|
455 | + if ($asAttachment) { |
|
456 | 456 | $disposition = 'attachment'; |
457 | 457 | } |
458 | 458 | |
@@ -480,7 +480,7 @@ discard block |
||
480 | 480 | requireCURL(); |
481 | 481 | |
482 | 482 | $ch = curl_init(); |
483 | - if($ch === false) |
|
483 | + if ($ch === false) |
|
484 | 484 | { |
485 | 485 | throw new FileHelper_Exception( |
486 | 486 | 'Could not initialize a new cURL instance.', |
@@ -501,7 +501,7 @@ discard block |
||
501 | 501 | |
502 | 502 | $output = curl_exec($ch); |
503 | 503 | |
504 | - if($output === false) { |
|
504 | + if ($output === false) { |
|
505 | 505 | throw new FileHelper_Exception( |
506 | 506 | 'Unable to open URL', |
507 | 507 | sprintf( |
@@ -515,7 +515,7 @@ discard block |
||
515 | 515 | |
516 | 516 | curl_close($ch); |
517 | 517 | |
518 | - if(is_string($output)) |
|
518 | + if (is_string($output)) |
|
519 | 519 | { |
520 | 520 | return $output; |
521 | 521 | } |
@@ -537,7 +537,7 @@ discard block |
||
537 | 537 | */ |
538 | 538 | public static function isPHPFile($pathOrDirIterator) |
539 | 539 | { |
540 | - if(self::getExtension($pathOrDirIterator) == 'php') { |
|
540 | + if (self::getExtension($pathOrDirIterator) == 'php') { |
|
541 | 541 | return true; |
542 | 542 | } |
543 | 543 | |
@@ -554,14 +554,14 @@ discard block |
||
554 | 554 | */ |
555 | 555 | public static function getExtension($pathOrDirIterator, bool $lowercase = true) : string |
556 | 556 | { |
557 | - if($pathOrDirIterator instanceof \DirectoryIterator) { |
|
557 | + if ($pathOrDirIterator instanceof \DirectoryIterator) { |
|
558 | 558 | $filename = $pathOrDirIterator->getFilename(); |
559 | 559 | } else { |
560 | 560 | $filename = basename($pathOrDirIterator); |
561 | 561 | } |
562 | 562 | |
563 | 563 | $ext = pathinfo($filename, PATHINFO_EXTENSION); |
564 | - if($lowercase) { |
|
564 | + if ($lowercase) { |
|
565 | 565 | $ext = mb_strtolower($ext); |
566 | 566 | } |
567 | 567 | |
@@ -583,13 +583,13 @@ discard block |
||
583 | 583 | public static function getFilename($pathOrDirIterator, $extension = true) |
584 | 584 | { |
585 | 585 | $path = $pathOrDirIterator; |
586 | - if($pathOrDirIterator instanceof \DirectoryIterator) { |
|
586 | + if ($pathOrDirIterator instanceof \DirectoryIterator) { |
|
587 | 587 | $path = $pathOrDirIterator->getFilename(); |
588 | 588 | } |
589 | 589 | |
590 | 590 | $path = self::normalizePath($path); |
591 | 591 | |
592 | - if(!$extension) { |
|
592 | + if (!$extension) { |
|
593 | 593 | return pathinfo($path, PATHINFO_FILENAME); |
594 | 594 | } |
595 | 595 | |
@@ -607,12 +607,12 @@ discard block |
||
607 | 607 | * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE |
608 | 608 | * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE |
609 | 609 | */ |
610 | - public static function parseJSONFile(string $file, $targetEncoding=null, $sourceEncoding=null) |
|
610 | + public static function parseJSONFile(string $file, $targetEncoding = null, $sourceEncoding = null) |
|
611 | 611 | { |
612 | 612 | self::requireFileExists($file, self::ERROR_CANNOT_FIND_JSON_FILE); |
613 | 613 | |
614 | 614 | $content = file_get_contents($file); |
615 | - if(!$content) { |
|
615 | + if (!$content) { |
|
616 | 616 | throw new FileHelper_Exception( |
617 | 617 | 'Cannot get file contents', |
618 | 618 | sprintf( |
@@ -623,12 +623,12 @@ discard block |
||
623 | 623 | ); |
624 | 624 | } |
625 | 625 | |
626 | - if(isset($targetEncoding)) { |
|
626 | + if (isset($targetEncoding)) { |
|
627 | 627 | $content = mb_convert_encoding($content, $targetEncoding, $sourceEncoding); |
628 | 628 | } |
629 | 629 | |
630 | 630 | $json = json_decode($content, true); |
631 | - if($json === false || $json === NULL) { |
|
631 | + if ($json === false || $json === NULL) { |
|
632 | 632 | throw new FileHelper_Exception( |
633 | 633 | 'Cannot decode json data', |
634 | 634 | sprintf( |
@@ -668,13 +668,13 @@ discard block |
||
668 | 668 | |
669 | 669 | $name = str_replace(array_keys($replaces), array_values($replaces), $name); |
670 | 670 | |
671 | - while(strstr($name, ' ')) { |
|
671 | + while (strstr($name, ' ')) { |
|
672 | 672 | $name = str_replace(' ', ' ', $name); |
673 | 673 | } |
674 | 674 | |
675 | 675 | $name = str_replace(array_keys($replaces), array_values($replaces), $name); |
676 | 676 | |
677 | - while(strstr($name, '..')) { |
|
677 | + while (strstr($name, '..')) { |
|
678 | 678 | $name = str_replace('..', '.', $name); |
679 | 679 | } |
680 | 680 | |
@@ -706,7 +706,7 @@ discard block |
||
706 | 706 | * @return array An indexed array with files. |
707 | 707 | * @see FileHelper::createFileFinder() |
708 | 708 | */ |
709 | - public static function findHTMLFiles(string $targetFolder, array $options=array()) : array |
|
709 | + public static function findHTMLFiles(string $targetFolder, array $options = array()) : array |
|
710 | 710 | { |
711 | 711 | return self::findFiles($targetFolder, array('html'), $options); |
712 | 712 | } |
@@ -723,7 +723,7 @@ discard block |
||
723 | 723 | * @return array An indexed array of PHP files. |
724 | 724 | * @see FileHelper::createFileFinder() |
725 | 725 | */ |
726 | - public static function findPHPFiles(string $targetFolder, array $options=array()) : array |
|
726 | + public static function findPHPFiles(string $targetFolder, array $options = array()) : array |
|
727 | 727 | { |
728 | 728 | return self::findFiles($targetFolder, array('php'), $options); |
729 | 729 | } |
@@ -743,22 +743,22 @@ discard block |
||
743 | 743 | * @return array |
744 | 744 | * @see FileHelper::createFileFinder() |
745 | 745 | */ |
746 | - public static function findFiles(string $targetFolder, array $extensions=array(), array $options=array(), array $files=array()) : array |
|
746 | + public static function findFiles(string $targetFolder, array $extensions = array(), array $options = array(), array $files = array()) : array |
|
747 | 747 | { |
748 | 748 | $finder = self::createFileFinder($targetFolder); |
749 | 749 | |
750 | 750 | $finder->setPathmodeStrip(); |
751 | 751 | |
752 | - if(isset($options['relative-path']) && $options['relative-path'] === true) |
|
752 | + if (isset($options['relative-path']) && $options['relative-path'] === true) |
|
753 | 753 | { |
754 | 754 | $finder->setPathmodeRelative(); |
755 | 755 | } |
756 | - else if(isset($options['absolute-path']) && $options['absolute-path'] === true) |
|
756 | + else if (isset($options['absolute-path']) && $options['absolute-path'] === true) |
|
757 | 757 | { |
758 | 758 | $finder->setPathmodeAbsolute(); |
759 | 759 | } |
760 | 760 | |
761 | - if(isset($options['strip-extension'])) |
|
761 | + if (isset($options['strip-extension'])) |
|
762 | 762 | { |
763 | 763 | $finder->stripExtensions(); |
764 | 764 | } |
@@ -802,7 +802,7 @@ discard block |
||
802 | 802 | public static function detectUTFBom(string $filename) : ?string |
803 | 803 | { |
804 | 804 | $fp = fopen($filename, 'r'); |
805 | - if($fp === false) |
|
805 | + if ($fp === false) |
|
806 | 806 | { |
807 | 807 | throw new FileHelper_Exception( |
808 | 808 | 'Cannot open file for reading', |
@@ -817,10 +817,10 @@ discard block |
||
817 | 817 | |
818 | 818 | $boms = self::getUTFBOMs(); |
819 | 819 | |
820 | - foreach($boms as $bom => $value) |
|
820 | + foreach ($boms as $bom => $value) |
|
821 | 821 | { |
822 | 822 | $length = mb_strlen($value); |
823 | - if(mb_substr($text, 0, $length) == $value) { |
|
823 | + if (mb_substr($text, 0, $length) == $value) { |
|
824 | 824 | return $bom; |
825 | 825 | } |
826 | 826 | } |
@@ -839,13 +839,13 @@ discard block |
||
839 | 839 | */ |
840 | 840 | public static function getUTFBOMs() |
841 | 841 | { |
842 | - if(!isset(self::$utfBoms)) { |
|
842 | + if (!isset(self::$utfBoms)) { |
|
843 | 843 | self::$utfBoms = array( |
844 | - 'UTF32-BE' => chr(0x00) . chr(0x00) . chr(0xFE) . chr(0xFF), |
|
845 | - 'UTF32-LE' => chr(0xFF) . chr(0xFE) . chr(0x00) . chr(0x00), |
|
846 | - 'UTF16-BE' => chr(0xFE) . chr(0xFF), |
|
847 | - 'UTF16-LE' => chr(0xFF) . chr(0xFE), |
|
848 | - 'UTF8' => chr(0xEF) . chr(0xBB) . chr(0xBF) |
|
844 | + 'UTF32-BE' => chr(0x00).chr(0x00).chr(0xFE).chr(0xFF), |
|
845 | + 'UTF32-LE' => chr(0xFF).chr(0xFE).chr(0x00).chr(0x00), |
|
846 | + 'UTF16-BE' => chr(0xFE).chr(0xFF), |
|
847 | + 'UTF16-LE' => chr(0xFF).chr(0xFE), |
|
848 | + 'UTF8' => chr(0xEF).chr(0xBB).chr(0xBF) |
|
849 | 849 | ); |
850 | 850 | } |
851 | 851 | |
@@ -866,7 +866,7 @@ discard block |
||
866 | 866 | $encodings = self::getKnownUnicodeEncodings(); |
867 | 867 | |
868 | 868 | $keep = array(); |
869 | - foreach($encodings as $string) |
|
869 | + foreach ($encodings as $string) |
|
870 | 870 | { |
871 | 871 | $withHyphen = str_replace('UTF', 'UTF-', $string); |
872 | 872 | |
@@ -913,16 +913,16 @@ discard block |
||
913 | 913 | * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
914 | 914 | * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
915 | 915 | */ |
916 | - public static function saveAsJSON($data, string $file, bool $pretty=false) |
|
916 | + public static function saveAsJSON($data, string $file, bool $pretty = false) |
|
917 | 917 | { |
918 | 918 | $options = null; |
919 | - if($pretty) { |
|
919 | + if ($pretty) { |
|
920 | 920 | $options = JSON_PRETTY_PRINT; |
921 | 921 | } |
922 | 922 | |
923 | 923 | $json = json_encode($data, $options); |
924 | 924 | |
925 | - if($json===false) |
|
925 | + if ($json === false) |
|
926 | 926 | { |
927 | 927 | $errorCode = json_last_error(); |
928 | 928 | |
@@ -948,12 +948,12 @@ discard block |
||
948 | 948 | * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
949 | 949 | * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
950 | 950 | */ |
951 | - public static function saveFile(string $filePath, string $content='') : void |
|
951 | + public static function saveFile(string $filePath, string $content = '') : void |
|
952 | 952 | { |
953 | 953 | // target file already exists |
954 | - if(file_exists($filePath)) |
|
954 | + if (file_exists($filePath)) |
|
955 | 955 | { |
956 | - if(!is_writable($filePath)) |
|
956 | + if (!is_writable($filePath)) |
|
957 | 957 | { |
958 | 958 | throw new FileHelper_Exception( |
959 | 959 | sprintf('Cannot save file: target file [%s] exists, but is not writable.', basename($filePath)), |
@@ -973,7 +973,7 @@ discard block |
||
973 | 973 | // create the folder as needed |
974 | 974 | self::createFolder($targetFolder); |
975 | 975 | |
976 | - if(!is_writable($targetFolder)) |
|
976 | + if (!is_writable($targetFolder)) |
|
977 | 977 | { |
978 | 978 | throw new FileHelper_Exception( |
979 | 979 | sprintf('Cannot save file: target folder [%s] is not writable.', basename($targetFolder)), |
@@ -986,7 +986,7 @@ discard block |
||
986 | 986 | } |
987 | 987 | } |
988 | 988 | |
989 | - if(file_put_contents($filePath, $content) !== false) { |
|
989 | + if (file_put_contents($filePath, $content) !== false) { |
|
990 | 990 | return; |
991 | 991 | } |
992 | 992 | |
@@ -1024,7 +1024,7 @@ discard block |
||
1024 | 1024 | { |
1025 | 1025 | static $checked = array(); |
1026 | 1026 | |
1027 | - if(isset($checked[$command])) { |
|
1027 | + if (isset($checked[$command])) { |
|
1028 | 1028 | return $checked[$command]; |
1029 | 1029 | } |
1030 | 1030 | |
@@ -1037,7 +1037,7 @@ discard block |
||
1037 | 1037 | |
1038 | 1038 | $os = strtolower(PHP_OS_FAMILY); |
1039 | 1039 | |
1040 | - if(!isset($osCommands[$os])) |
|
1040 | + if (!isset($osCommands[$os])) |
|
1041 | 1041 | { |
1042 | 1042 | throw new FileHelper_Exception( |
1043 | 1043 | 'Unsupported OS for CLI commands', |
@@ -1063,7 +1063,7 @@ discard block |
||
1063 | 1063 | $pipes |
1064 | 1064 | ); |
1065 | 1065 | |
1066 | - if($process === false) { |
|
1066 | + if ($process === false) { |
|
1067 | 1067 | $checked[$command] = false; |
1068 | 1068 | return false; |
1069 | 1069 | } |
@@ -1094,7 +1094,7 @@ discard block |
||
1094 | 1094 | */ |
1095 | 1095 | public static function checkPHPFileSyntax($path) |
1096 | 1096 | { |
1097 | - if(!self::canMakePHPCalls()) { |
|
1097 | + if (!self::canMakePHPCalls()) { |
|
1098 | 1098 | return true; |
1099 | 1099 | } |
1100 | 1100 | |
@@ -1105,7 +1105,7 @@ discard block |
||
1105 | 1105 | // when the validation is successful, the first entry |
1106 | 1106 | // in the array contains the success message. When it |
1107 | 1107 | // is invalid, the first entry is always empty. |
1108 | - if(!empty($output[0])) { |
|
1108 | + if (!empty($output[0])) { |
|
1109 | 1109 | return true; |
1110 | 1110 | } |
1111 | 1111 | |
@@ -1126,7 +1126,7 @@ discard block |
||
1126 | 1126 | public static function getModifiedDate($path) |
1127 | 1127 | { |
1128 | 1128 | $time = filemtime($path); |
1129 | - if($time !== false) { |
|
1129 | + if ($time !== false) { |
|
1130 | 1130 | $date = new \DateTime(); |
1131 | 1131 | $date->setTimestamp($time); |
1132 | 1132 | return $date; |
@@ -1155,7 +1155,7 @@ discard block |
||
1155 | 1155 | */ |
1156 | 1156 | public static function getSubfolders($targetFolder, $options = array()) |
1157 | 1157 | { |
1158 | - if(!is_dir($targetFolder)) |
|
1158 | + if (!is_dir($targetFolder)) |
|
1159 | 1159 | { |
1160 | 1160 | throw new FileHelper_Exception( |
1161 | 1161 | 'Target folder does not exist', |
@@ -1179,29 +1179,29 @@ discard block |
||
1179 | 1179 | |
1180 | 1180 | $d = new \DirectoryIterator($targetFolder); |
1181 | 1181 | |
1182 | - foreach($d as $item) |
|
1182 | + foreach ($d as $item) |
|
1183 | 1183 | { |
1184 | - if($item->isDir() && !$item->isDot()) |
|
1184 | + if ($item->isDir() && !$item->isDot()) |
|
1185 | 1185 | { |
1186 | 1186 | $name = $item->getFilename(); |
1187 | 1187 | |
1188 | - if(!$options['absolute-path']) { |
|
1188 | + if (!$options['absolute-path']) { |
|
1189 | 1189 | $result[] = $name; |
1190 | 1190 | } else { |
1191 | 1191 | $result[] = $targetFolder.'/'.$name; |
1192 | 1192 | } |
1193 | 1193 | |
1194 | - if(!$options['recursive']) |
|
1194 | + if (!$options['recursive']) |
|
1195 | 1195 | { |
1196 | 1196 | continue; |
1197 | 1197 | } |
1198 | 1198 | |
1199 | 1199 | $subs = self::getSubfolders($targetFolder.'/'.$name, $options); |
1200 | - foreach($subs as $sub) |
|
1200 | + foreach ($subs as $sub) |
|
1201 | 1201 | { |
1202 | 1202 | $relative = $name.'/'.$sub; |
1203 | 1203 | |
1204 | - if(!$options['absolute-path']) { |
|
1204 | + if (!$options['absolute-path']) { |
|
1205 | 1205 | $result[] = $relative; |
1206 | 1206 | } else { |
1207 | 1207 | $result[] = $targetFolder.'/'.$relative; |
@@ -1269,7 +1269,7 @@ discard block |
||
1269 | 1269 | * @param int $depth The folder depth to reduce the path to |
1270 | 1270 | * @return string |
1271 | 1271 | */ |
1272 | - public static function relativizePathByDepth(string $path, int $depth=2) : string |
|
1272 | + public static function relativizePathByDepth(string $path, int $depth = 2) : string |
|
1273 | 1273 | { |
1274 | 1274 | $path = self::normalizePath($path); |
1275 | 1275 | |
@@ -1277,17 +1277,17 @@ discard block |
||
1277 | 1277 | $tokens = array_filter($tokens); // remove empty entries (trailing slash for example) |
1278 | 1278 | $tokens = array_values($tokens); // re-index keys |
1279 | 1279 | |
1280 | - if(empty($tokens)) { |
|
1280 | + if (empty($tokens)) { |
|
1281 | 1281 | return ''; |
1282 | 1282 | } |
1283 | 1283 | |
1284 | 1284 | // remove the drive if present |
1285 | - if(strstr($tokens[0], ':')) { |
|
1285 | + if (strstr($tokens[0], ':')) { |
|
1286 | 1286 | array_shift($tokens); |
1287 | 1287 | } |
1288 | 1288 | |
1289 | 1289 | // path was only the drive |
1290 | - if(count($tokens) == 0) { |
|
1290 | + if (count($tokens) == 0) { |
|
1291 | 1291 | return ''; |
1292 | 1292 | } |
1293 | 1293 | |
@@ -1296,8 +1296,8 @@ discard block |
||
1296 | 1296 | |
1297 | 1297 | // reduce the path to the specified depth |
1298 | 1298 | $length = count($tokens); |
1299 | - if($length > $depth) { |
|
1300 | - $tokens = array_slice($tokens, $length-$depth); |
|
1299 | + if ($length > $depth) { |
|
1300 | + $tokens = array_slice($tokens, $length - $depth); |
|
1301 | 1301 | } |
1302 | 1302 | |
1303 | 1303 | // append the last element again |
@@ -1345,14 +1345,14 @@ discard block |
||
1345 | 1345 | * |
1346 | 1346 | * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
1347 | 1347 | */ |
1348 | - public static function requireFileExists(string $path, $errorCode=null) : string |
|
1348 | + public static function requireFileExists(string $path, $errorCode = null) : string |
|
1349 | 1349 | { |
1350 | 1350 | $result = realpath($path); |
1351 | - if($result !== false) { |
|
1351 | + if ($result !== false) { |
|
1352 | 1352 | return $result; |
1353 | 1353 | } |
1354 | 1354 | |
1355 | - if($errorCode === null) { |
|
1355 | + if ($errorCode === null) { |
|
1356 | 1356 | $errorCode = self::ERROR_FILE_DOES_NOT_EXIST; |
1357 | 1357 | } |
1358 | 1358 | |
@@ -1381,15 +1381,15 @@ discard block |
||
1381 | 1381 | |
1382 | 1382 | $file = new \SplFileObject($path); |
1383 | 1383 | |
1384 | - if($file->eof()) { |
|
1384 | + if ($file->eof()) { |
|
1385 | 1385 | return ''; |
1386 | 1386 | } |
1387 | 1387 | |
1388 | - $targetLine = $lineNumber-1; |
|
1388 | + $targetLine = $lineNumber - 1; |
|
1389 | 1389 | |
1390 | 1390 | $file->seek($targetLine); |
1391 | 1391 | |
1392 | - if($file->key() !== $targetLine) { |
|
1392 | + if ($file->key() !== $targetLine) { |
|
1393 | 1393 | return null; |
1394 | 1394 | } |
1395 | 1395 | |
@@ -1415,7 +1415,7 @@ discard block |
||
1415 | 1415 | $number = $spl->key(); |
1416 | 1416 | |
1417 | 1417 | // if seeking to the end the cursor is still at 0, there are no lines. |
1418 | - if($number === 0) |
|
1418 | + if ($number === 0) |
|
1419 | 1419 | { |
1420 | 1420 | // since it's a very small file, to get reliable results, |
1421 | 1421 | // we read its contents and use that to determine what |
@@ -1423,13 +1423,13 @@ discard block |
||
1423 | 1423 | // that this is not pactical to solve with the SplFileObject. |
1424 | 1424 | $content = file_get_contents($path); |
1425 | 1425 | |
1426 | - if(empty($content)) { |
|
1426 | + if (empty($content)) { |
|
1427 | 1427 | return 0; |
1428 | 1428 | } |
1429 | 1429 | } |
1430 | 1430 | |
1431 | 1431 | // return the line number we were able to reach + 1 (key is zero-based) |
1432 | - return $number+1; |
|
1432 | + return $number + 1; |
|
1433 | 1433 | } |
1434 | 1434 | |
1435 | 1435 | /** |
@@ -1476,13 +1476,13 @@ discard block |
||
1476 | 1476 | * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES |
1477 | 1477 | * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
1478 | 1478 | */ |
1479 | - public static function readLines(string $filePath, int $amount=0) : array |
|
1479 | + public static function readLines(string $filePath, int $amount = 0) : array |
|
1480 | 1480 | { |
1481 | 1481 | self::requireFileExists($filePath); |
1482 | 1482 | |
1483 | 1483 | $fn = fopen($filePath, "r"); |
1484 | 1484 | |
1485 | - if($fn === false) |
|
1485 | + if ($fn === false) |
|
1486 | 1486 | { |
1487 | 1487 | throw new FileHelper_Exception( |
1488 | 1488 | 'Could not open file for reading.', |
@@ -1498,25 +1498,25 @@ discard block |
||
1498 | 1498 | $counter = 0; |
1499 | 1499 | $first = true; |
1500 | 1500 | |
1501 | - while(!feof($fn)) |
|
1501 | + while (!feof($fn)) |
|
1502 | 1502 | { |
1503 | 1503 | $counter++; |
1504 | 1504 | |
1505 | 1505 | $line = fgets($fn); |
1506 | 1506 | |
1507 | 1507 | // can happen with zero length files |
1508 | - if($line === false) { |
|
1508 | + if ($line === false) { |
|
1509 | 1509 | continue; |
1510 | 1510 | } |
1511 | 1511 | |
1512 | 1512 | // the first line may contain a unicode BOM marker. |
1513 | - if($first) { |
|
1513 | + if ($first) { |
|
1514 | 1514 | $line = ConvertHelper::stripUTFBom($line); |
1515 | 1515 | } |
1516 | 1516 | |
1517 | 1517 | $result[] = $line; |
1518 | 1518 | |
1519 | - if($amount > 0 && $counter == $amount) { |
|
1519 | + if ($amount > 0 && $counter == $amount) { |
|
1520 | 1520 | break; |
1521 | 1521 | } |
1522 | 1522 | } |
@@ -1542,7 +1542,7 @@ discard block |
||
1542 | 1542 | |
1543 | 1543 | $result = file_get_contents($filePath); |
1544 | 1544 | |
1545 | - if($result !== false) { |
|
1545 | + if ($result !== false) { |
|
1546 | 1546 | return $result; |
1547 | 1547 | } |
1548 | 1548 |
@@ -22,9 +22,9 @@ |
||
22 | 22 | { |
23 | 23 | use Traits_Optionable; |
24 | 24 | |
25 | - /** |
|
26 | - * @var Request_Param |
|
27 | - */ |
|
25 | + /** |
|
26 | + * @var Request_Param |
|
27 | + */ |
|
28 | 28 | protected $param; |
29 | 29 | |
30 | 30 | protected $value; |
@@ -20,7 +20,7 @@ |
||
20 | 20 | |
21 | 21 | protected function _filter() |
22 | 22 | { |
23 | - if($this->value === 'yes' || $this->value === 'true' || $this->value === true) { |
|
23 | + if ($this->value === 'yes' || $this->value === 'true' || $this->value === true) { |
|
24 | 24 | return true; |
25 | 25 | } |
26 | 26 |
@@ -23,11 +23,11 @@ discard block |
||
23 | 23 | |
24 | 24 | protected function _filter() |
25 | 25 | { |
26 | - if(is_array($this->value)) { |
|
26 | + if (is_array($this->value)) { |
|
27 | 27 | return $this->value; |
28 | 28 | } |
29 | 29 | |
30 | - if($this->value === '' || $this->value === null || !is_string($this->value)) { |
|
30 | + if ($this->value === '' || $this->value === null || !is_string($this->value)) { |
|
31 | 31 | return array(); |
32 | 32 | } |
33 | 33 | |
@@ -35,19 +35,19 @@ discard block |
||
35 | 35 | $stripEmptyEntries = $this->getBoolOption('stripEmptyEntries'); |
36 | 36 | $result = explode(',', $this->value); |
37 | 37 | |
38 | - if(!$trimEntries && !$stripEmptyEntries) { |
|
38 | + if (!$trimEntries && !$stripEmptyEntries) { |
|
39 | 39 | return $result; |
40 | 40 | } |
41 | 41 | |
42 | 42 | $keep = array(); |
43 | 43 | |
44 | - foreach($result as $entry) |
|
44 | + foreach ($result as $entry) |
|
45 | 45 | { |
46 | - if($trimEntries === true) { |
|
46 | + if ($trimEntries === true) { |
|
47 | 47 | $entry = trim($entry); |
48 | 48 | } |
49 | 49 | |
50 | - if($stripEmptyEntries === true && $entry === '') { |
|
50 | + if ($stripEmptyEntries === true && $entry === '') { |
|
51 | 51 | continue; |
52 | 52 | } |
53 | 53 |
@@ -20,7 +20,7 @@ |
||
20 | 20 | |
21 | 21 | protected function _filter() |
22 | 22 | { |
23 | - if(!is_scalar($this->value)) { |
|
23 | + if (!is_scalar($this->value)) { |
|
24 | 24 | return ''; |
25 | 25 | } |
26 | 26 |
@@ -27,11 +27,11 @@ |
||
27 | 27 | |
28 | 28 | protected function _validate() |
29 | 29 | { |
30 | - if(!is_scalar($this->value)) { |
|
30 | + if (!is_scalar($this->value)) { |
|
31 | 31 | return null; |
32 | 32 | } |
33 | 33 | |
34 | - if(preg_match('/\A[a-zA-Z]+\z/', $this->value)) { |
|
34 | + if (preg_match('/\A[a-zA-Z]+\z/', $this->value)) { |
|
35 | 35 | return $this->value; |
36 | 36 | } |
37 | 37 |
@@ -34,7 +34,7 @@ |
||
34 | 34 | array_unshift($args, $this->value); |
35 | 35 | |
36 | 36 | $result = call_user_func_array($this->getOption('callback'), $args); |
37 | - if($result !== false) { |
|
37 | + if ($result !== false) { |
|
38 | 38 | return $this->value; |
39 | 39 | } |
40 | 40 |
@@ -30,7 +30,7 @@ |
||
30 | 30 | |
31 | 31 | protected function _validate() |
32 | 32 | { |
33 | - if(ConvertHelper::isInteger($this->value)) { |
|
33 | + if (ConvertHelper::isInteger($this->value)) { |
|
34 | 34 | return intval($this->value); |
35 | 35 | } |
36 | 36 |
@@ -27,12 +27,12 @@ |
||
27 | 27 | |
28 | 28 | protected function _validate() |
29 | 29 | { |
30 | - if(!is_string($this->value)) { |
|
30 | + if (!is_string($this->value)) { |
|
31 | 31 | return ''; |
32 | 32 | } |
33 | 33 | |
34 | 34 | $info = parseURL($this->value); |
35 | - if($info->isValid()) { |
|
35 | + if ($info->isValid()) { |
|
36 | 36 | return $this->value; |
37 | 37 | } |
38 | 38 |