@@ -32,7 +32,7 @@ discard block |
||
32 | 32 | * @param string[] $paths |
33 | 33 | * @throws FileHelper_Exception |
34 | 34 | */ |
35 | - public function __construct(array $paths=array()) |
|
35 | + public function __construct(array $paths = array()) |
|
36 | 36 | { |
37 | 37 | $this->addPaths($paths); |
38 | 38 | } |
@@ -46,7 +46,7 @@ discard block |
||
46 | 46 | */ |
47 | 47 | public function addPaths(array $paths) : FileHelper_PathsReducer |
48 | 48 | { |
49 | - foreach($paths as $path) { |
|
49 | + foreach ($paths as $path) { |
|
50 | 50 | $this->addPath($path); |
51 | 51 | } |
52 | 52 | |
@@ -64,7 +64,7 @@ discard block |
||
64 | 64 | { |
65 | 65 | $path = FileHelper::normalizePath(FileHelper::requireFileExists($path)); |
66 | 66 | |
67 | - if(!in_array($path, $this->paths)) { |
|
67 | + if (!in_array($path, $this->paths)) { |
|
68 | 68 | $this->paths[] = $path; |
69 | 69 | } |
70 | 70 | |
@@ -81,11 +81,11 @@ discard block |
||
81 | 81 | { |
82 | 82 | $split = $this->splitPaths(); |
83 | 83 | |
84 | - if(empty($split)) { |
|
84 | + if (empty($split)) { |
|
85 | 85 | return array(); |
86 | 86 | } |
87 | 87 | |
88 | - while($this->shiftPart($split) === true) {} |
|
88 | + while ($this->shiftPart($split) === true) {} |
|
89 | 89 | |
90 | 90 | return $this->joinPaths($split); |
91 | 91 | } |
@@ -99,7 +99,7 @@ discard block |
||
99 | 99 | $result = array(); |
100 | 100 | |
101 | 101 | foreach ($split as $entry) { |
102 | - if(!empty($entry)) { |
|
102 | + if (!empty($entry)) { |
|
103 | 103 | $result[] = implode('/', $entry); |
104 | 104 | } |
105 | 105 | } |
@@ -116,22 +116,22 @@ discard block |
||
116 | 116 | $current = null; |
117 | 117 | $result = array(); |
118 | 118 | |
119 | - foreach($split as $entry) |
|
119 | + foreach ($split as $entry) |
|
120 | 120 | { |
121 | - if(empty($entry)) { |
|
121 | + if (empty($entry)) { |
|
122 | 122 | return false; |
123 | 123 | } |
124 | 124 | |
125 | 125 | $part = array_shift($entry); |
126 | - if(empty($entry)) { |
|
126 | + if (empty($entry)) { |
|
127 | 127 | return false; |
128 | 128 | } |
129 | 129 | |
130 | - if($current === null) { |
|
130 | + if ($current === null) { |
|
131 | 131 | $current = $part; |
132 | 132 | } |
133 | 133 | |
134 | - if($part !== $current) { |
|
134 | + if ($part !== $current) { |
|
135 | 135 | return false; |
136 | 136 | } |
137 | 137 | |
@@ -147,9 +147,9 @@ discard block |
||
147 | 147 | { |
148 | 148 | $split = array(); |
149 | 149 | |
150 | - foreach($this->paths as $path) { |
|
150 | + foreach ($this->paths as $path) { |
|
151 | 151 | $entry = ConvertHelper::explodeTrim('/', $path); |
152 | - if(!empty($entry)) { |
|
152 | + if (!empty($entry)) { |
|
153 | 153 | $split[] = $entry; |
154 | 154 | } |
155 | 155 | } |
@@ -52,32 +52,32 @@ discard block |
||
52 | 52 | const ERROR_PATH_IS_NOT_A_FOLDER = 340034; |
53 | 53 | const ERROR_CANNOT_WRITE_TO_FOLDER = 340035; |
54 | 54 | |
55 | - /** |
|
56 | - * Opens a serialized file and returns the unserialized data. |
|
57 | - * |
|
58 | - * @param string $file |
|
59 | - * @throws FileHelper_Exception |
|
60 | - * @return array |
|
61 | - * @deprecated Use parseSerializedFile() instead. |
|
62 | - * @see FileHelper::parseSerializedFile() |
|
63 | - */ |
|
55 | + /** |
|
56 | + * Opens a serialized file and returns the unserialized data. |
|
57 | + * |
|
58 | + * @param string $file |
|
59 | + * @throws FileHelper_Exception |
|
60 | + * @return array |
|
61 | + * @deprecated Use parseSerializedFile() instead. |
|
62 | + * @see FileHelper::parseSerializedFile() |
|
63 | + */ |
|
64 | 64 | public static function openUnserialized(string $file) : array |
65 | 65 | { |
66 | 66 | return self::parseSerializedFile($file); |
67 | 67 | } |
68 | 68 | |
69 | - /** |
|
70 | - * Opens a serialized file and returns the unserialized data. |
|
71 | - * |
|
72 | - * @param string $file |
|
73 | - * @throws FileHelper_Exception |
|
74 | - * @return array |
|
75 | - * @see FileHelper::parseSerializedFile() |
|
76 | - * |
|
77 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
78 | - * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ |
|
79 | - * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED |
|
80 | - */ |
|
69 | + /** |
|
70 | + * Opens a serialized file and returns the unserialized data. |
|
71 | + * |
|
72 | + * @param string $file |
|
73 | + * @throws FileHelper_Exception |
|
74 | + * @return array |
|
75 | + * @see FileHelper::parseSerializedFile() |
|
76 | + * |
|
77 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
78 | + * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ |
|
79 | + * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED |
|
80 | + */ |
|
81 | 81 | public static function parseSerializedFile(string $file) |
82 | 82 | { |
83 | 83 | self::requireFileExists($file); |
@@ -146,13 +146,13 @@ discard block |
||
146 | 146 | return rmdir($rootFolder); |
147 | 147 | } |
148 | 148 | |
149 | - /** |
|
150 | - * Create a folder, if it does not exist yet. |
|
151 | - * |
|
152 | - * @param string $path |
|
153 | - * @throws FileHelper_Exception |
|
154 | - * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER |
|
155 | - */ |
|
149 | + /** |
|
150 | + * Create a folder, if it does not exist yet. |
|
151 | + * |
|
152 | + * @param string $path |
|
153 | + * @throws FileHelper_Exception |
|
154 | + * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER |
|
155 | + */ |
|
156 | 156 | public static function createFolder($path) |
157 | 157 | { |
158 | 158 | if(is_dir($path) || mkdir($path, 0777, true)) { |
@@ -199,22 +199,22 @@ discard block |
||
199 | 199 | } |
200 | 200 | } |
201 | 201 | |
202 | - /** |
|
203 | - * Copies a file to the target location. Includes checks |
|
204 | - * for most error sources, like the source file not being |
|
205 | - * readable. Automatically creates the target folder if it |
|
206 | - * does not exist yet. |
|
207 | - * |
|
208 | - * @param string $sourcePath |
|
209 | - * @param string $targetPath |
|
210 | - * @throws FileHelper_Exception |
|
211 | - * |
|
212 | - * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER |
|
213 | - * @see FileHelper::ERROR_SOURCE_FILE_NOT_FOUND |
|
214 | - * @see FileHelper::ERROR_SOURCE_FILE_NOT_READABLE |
|
215 | - * @see FileHelper::ERROR_TARGET_COPY_FOLDER_NOT_WRITABLE |
|
216 | - * @see FileHelper::ERROR_CANNOT_COPY_FILE |
|
217 | - */ |
|
202 | + /** |
|
203 | + * Copies a file to the target location. Includes checks |
|
204 | + * for most error sources, like the source file not being |
|
205 | + * readable. Automatically creates the target folder if it |
|
206 | + * does not exist yet. |
|
207 | + * |
|
208 | + * @param string $sourcePath |
|
209 | + * @param string $targetPath |
|
210 | + * @throws FileHelper_Exception |
|
211 | + * |
|
212 | + * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER |
|
213 | + * @see FileHelper::ERROR_SOURCE_FILE_NOT_FOUND |
|
214 | + * @see FileHelper::ERROR_SOURCE_FILE_NOT_READABLE |
|
215 | + * @see FileHelper::ERROR_TARGET_COPY_FOLDER_NOT_WRITABLE |
|
216 | + * @see FileHelper::ERROR_CANNOT_COPY_FILE |
|
217 | + */ |
|
218 | 218 | public static function copyFile(string $sourcePath, string $targetPath) : void |
219 | 219 | { |
220 | 220 | self::requireFileExists($sourcePath, self::ERROR_SOURCE_FILE_NOT_FOUND); |
@@ -254,15 +254,15 @@ discard block |
||
254 | 254 | ); |
255 | 255 | } |
256 | 256 | |
257 | - /** |
|
258 | - * Deletes the target file. Ignored if it cannot be found, |
|
259 | - * and throws an exception if it fails. |
|
260 | - * |
|
261 | - * @param string $filePath |
|
262 | - * @throws FileHelper_Exception |
|
263 | - * |
|
264 | - * @see FileHelper::ERROR_CANNOT_DELETE_FILE |
|
265 | - */ |
|
257 | + /** |
|
258 | + * Deletes the target file. Ignored if it cannot be found, |
|
259 | + * and throws an exception if it fails. |
|
260 | + * |
|
261 | + * @param string $filePath |
|
262 | + * @throws FileHelper_Exception |
|
263 | + * |
|
264 | + * @see FileHelper::ERROR_CANNOT_DELETE_FILE |
|
265 | + */ |
|
266 | 266 | public static function deleteFile(string $filePath) : void |
267 | 267 | { |
268 | 268 | if(!file_exists($filePath)) { |
@@ -284,15 +284,15 @@ discard block |
||
284 | 284 | } |
285 | 285 | |
286 | 286 | /** |
287 | - * Creates a new CSV parser instance and returns it. |
|
288 | - * |
|
289 | - * @param string $delimiter |
|
290 | - * @param string $enclosure |
|
291 | - * @param string $escape |
|
292 | - * @param bool $heading |
|
293 | - * @return Csv |
|
287 | + * Creates a new CSV parser instance and returns it. |
|
288 | + * |
|
289 | + * @param string $delimiter |
|
290 | + * @param string $enclosure |
|
291 | + * @param string $escape |
|
292 | + * @param bool $heading |
|
293 | + * @return Csv |
|
294 | 294 | * @see CSVHelper::createParser() |
295 | - */ |
|
295 | + */ |
|
296 | 296 | public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : Csv |
297 | 297 | { |
298 | 298 | if($delimiter==='') { $delimiter = ';'; } |
@@ -305,21 +305,21 @@ discard block |
||
305 | 305 | return $parser; |
306 | 306 | } |
307 | 307 | |
308 | - /** |
|
309 | - * Parses all lines in the specified string and returns an |
|
310 | - * indexed array with all csv values in each line. |
|
311 | - * |
|
312 | - * @param string $csv |
|
313 | - * @param string $delimiter |
|
314 | - * @param string $enclosure |
|
315 | - * @param string $escape |
|
316 | - * @param bool $heading |
|
317 | - * @return array |
|
318 | - * @throws FileHelper_Exception |
|
319 | - * |
|
320 | - * @see parseCSVFile() |
|
321 | - * @see FileHelper::ERROR_PARSING_CSV |
|
322 | - */ |
|
308 | + /** |
|
309 | + * Parses all lines in the specified string and returns an |
|
310 | + * indexed array with all csv values in each line. |
|
311 | + * |
|
312 | + * @param string $csv |
|
313 | + * @param string $delimiter |
|
314 | + * @param string $enclosure |
|
315 | + * @param string $escape |
|
316 | + * @param bool $heading |
|
317 | + * @return array |
|
318 | + * @throws FileHelper_Exception |
|
319 | + * |
|
320 | + * @see parseCSVFile() |
|
321 | + * @see FileHelper::ERROR_PARSING_CSV |
|
322 | + */ |
|
323 | 323 | public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array |
324 | 324 | { |
325 | 325 | $parser = self::createCSVParser($delimiter, $enclosure, '\\', $heading); |
@@ -490,31 +490,31 @@ discard block |
||
490 | 490 | ); |
491 | 491 | } |
492 | 492 | |
493 | - /** |
|
494 | - * Verifies whether the target file is a PHP file. The path |
|
495 | - * to the file can be a path to a file as a string, or a |
|
496 | - * DirectoryIterator object instance. |
|
497 | - * |
|
498 | - * @param string|\DirectoryIterator $pathOrDirIterator |
|
499 | - * @return boolean |
|
500 | - */ |
|
493 | + /** |
|
494 | + * Verifies whether the target file is a PHP file. The path |
|
495 | + * to the file can be a path to a file as a string, or a |
|
496 | + * DirectoryIterator object instance. |
|
497 | + * |
|
498 | + * @param string|\DirectoryIterator $pathOrDirIterator |
|
499 | + * @return boolean |
|
500 | + */ |
|
501 | 501 | public static function isPHPFile($pathOrDirIterator) |
502 | 502 | { |
503 | - if(self::getExtension($pathOrDirIterator) == 'php') { |
|
504 | - return true; |
|
505 | - } |
|
503 | + if(self::getExtension($pathOrDirIterator) == 'php') { |
|
504 | + return true; |
|
505 | + } |
|
506 | 506 | |
507 | - return false; |
|
507 | + return false; |
|
508 | 508 | } |
509 | 509 | |
510 | - /** |
|
511 | - * Retrieves the extension of the specified file. Can be a path |
|
512 | - * to a file as a string, or a DirectoryIterator object instance. |
|
513 | - * |
|
514 | - * @param string|\DirectoryIterator $pathOrDirIterator |
|
515 | - * @param bool $lowercase |
|
516 | - * @return string |
|
517 | - */ |
|
510 | + /** |
|
511 | + * Retrieves the extension of the specified file. Can be a path |
|
512 | + * to a file as a string, or a DirectoryIterator object instance. |
|
513 | + * |
|
514 | + * @param string|\DirectoryIterator $pathOrDirIterator |
|
515 | + * @param bool $lowercase |
|
516 | + * @return string |
|
517 | + */ |
|
518 | 518 | public static function getExtension($pathOrDirIterator, bool $lowercase = true) : string |
519 | 519 | { |
520 | 520 | if($pathOrDirIterator instanceof \DirectoryIterator) { |
@@ -525,51 +525,51 @@ discard block |
||
525 | 525 | |
526 | 526 | $ext = pathinfo($filename, PATHINFO_EXTENSION); |
527 | 527 | if($lowercase) { |
528 | - $ext = mb_strtolower($ext); |
|
528 | + $ext = mb_strtolower($ext); |
|
529 | 529 | } |
530 | 530 | |
531 | 531 | return $ext; |
532 | 532 | } |
533 | 533 | |
534 | - /** |
|
535 | - * Retrieves the file name from a path, with or without extension. |
|
536 | - * The path to the file can be a string, or a DirectoryIterator object |
|
537 | - * instance. |
|
538 | - * |
|
539 | - * In case of folders, behaves like the pathinfo function: returns |
|
540 | - * the name of the folder. |
|
541 | - * |
|
542 | - * @param string|\DirectoryIterator $pathOrDirIterator |
|
543 | - * @param bool $extension |
|
544 | - * @return string |
|
545 | - */ |
|
534 | + /** |
|
535 | + * Retrieves the file name from a path, with or without extension. |
|
536 | + * The path to the file can be a string, or a DirectoryIterator object |
|
537 | + * instance. |
|
538 | + * |
|
539 | + * In case of folders, behaves like the pathinfo function: returns |
|
540 | + * the name of the folder. |
|
541 | + * |
|
542 | + * @param string|\DirectoryIterator $pathOrDirIterator |
|
543 | + * @param bool $extension |
|
544 | + * @return string |
|
545 | + */ |
|
546 | 546 | public static function getFilename($pathOrDirIterator, $extension = true) |
547 | 547 | { |
548 | 548 | $path = $pathOrDirIterator; |
549 | - if($pathOrDirIterator instanceof \DirectoryIterator) { |
|
550 | - $path = $pathOrDirIterator->getFilename(); |
|
551 | - } |
|
549 | + if($pathOrDirIterator instanceof \DirectoryIterator) { |
|
550 | + $path = $pathOrDirIterator->getFilename(); |
|
551 | + } |
|
552 | 552 | |
553 | - $path = self::normalizePath($path); |
|
553 | + $path = self::normalizePath($path); |
|
554 | 554 | |
555 | - if(!$extension) { |
|
556 | - return pathinfo($path, PATHINFO_FILENAME); |
|
557 | - } |
|
555 | + if(!$extension) { |
|
556 | + return pathinfo($path, PATHINFO_FILENAME); |
|
557 | + } |
|
558 | 558 | |
559 | - return pathinfo($path, PATHINFO_BASENAME); |
|
559 | + return pathinfo($path, PATHINFO_BASENAME); |
|
560 | 560 | } |
561 | 561 | |
562 | - /** |
|
563 | - * Tries to read the contents of the target file and |
|
564 | - * treat it as JSON to return the decoded JSON data. |
|
565 | - * |
|
566 | - * @param string $file |
|
567 | - * @throws FileHelper_Exception |
|
568 | - * @return array |
|
569 | - * |
|
570 | - * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE |
|
571 | - * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE |
|
572 | - */ |
|
562 | + /** |
|
563 | + * Tries to read the contents of the target file and |
|
564 | + * treat it as JSON to return the decoded JSON data. |
|
565 | + * |
|
566 | + * @param string $file |
|
567 | + * @throws FileHelper_Exception |
|
568 | + * @return array |
|
569 | + * |
|
570 | + * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE |
|
571 | + * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE |
|
572 | + */ |
|
573 | 573 | public static function parseJSONFile(string $file, $targetEncoding=null, $sourceEncoding=null) |
574 | 574 | { |
575 | 575 | self::requireFileExists($file, self::ERROR_CANNOT_FIND_JSON_FILE); |
@@ -605,16 +605,16 @@ discard block |
||
605 | 605 | return $json; |
606 | 606 | } |
607 | 607 | |
608 | - /** |
|
609 | - * Corrects common formatting mistakes when users enter |
|
610 | - * file names, like too many spaces, dots and the like. |
|
611 | - * |
|
612 | - * NOTE: if the file name contains a path, the path is |
|
613 | - * stripped, leaving only the file name. |
|
614 | - * |
|
615 | - * @param string $name |
|
616 | - * @return string |
|
617 | - */ |
|
608 | + /** |
|
609 | + * Corrects common formatting mistakes when users enter |
|
610 | + * file names, like too many spaces, dots and the like. |
|
611 | + * |
|
612 | + * NOTE: if the file name contains a path, the path is |
|
613 | + * stripped, leaving only the file name. |
|
614 | + * |
|
615 | + * @param string $name |
|
616 | + * @return string |
|
617 | + */ |
|
618 | 618 | public static function fixFileName(string $name) : string |
619 | 619 | { |
620 | 620 | $name = trim($name); |
@@ -644,68 +644,68 @@ discard block |
||
644 | 644 | return $name; |
645 | 645 | } |
646 | 646 | |
647 | - /** |
|
648 | - * Creates an instance of the file finder, which is an easier |
|
649 | - * alternative to the other manual findFile methods, since all |
|
650 | - * options can be set by chaining. |
|
651 | - * |
|
652 | - * @param string $path |
|
653 | - * @return FileHelper_FileFinder |
|
654 | - */ |
|
647 | + /** |
|
648 | + * Creates an instance of the file finder, which is an easier |
|
649 | + * alternative to the other manual findFile methods, since all |
|
650 | + * options can be set by chaining. |
|
651 | + * |
|
652 | + * @param string $path |
|
653 | + * @return FileHelper_FileFinder |
|
654 | + */ |
|
655 | 655 | public static function createFileFinder(string $path) : FileHelper_FileFinder |
656 | 656 | { |
657 | 657 | return new FileHelper_FileFinder($path); |
658 | 658 | } |
659 | 659 | |
660 | - /** |
|
661 | - * Searches for all HTML files in the target folder. |
|
662 | - * |
|
663 | - * NOTE: This method only exists for backwards compatibility. |
|
664 | - * Use the `createFileFinder()` method instead, which offers |
|
665 | - * an object oriented interface that is much easier to use. |
|
666 | - * |
|
667 | - * @param string $targetFolder |
|
668 | - * @param array $options |
|
669 | - * @return array An indexed array with files. |
|
670 | - * @see FileHelper::createFileFinder() |
|
671 | - */ |
|
660 | + /** |
|
661 | + * Searches for all HTML files in the target folder. |
|
662 | + * |
|
663 | + * NOTE: This method only exists for backwards compatibility. |
|
664 | + * Use the `createFileFinder()` method instead, which offers |
|
665 | + * an object oriented interface that is much easier to use. |
|
666 | + * |
|
667 | + * @param string $targetFolder |
|
668 | + * @param array $options |
|
669 | + * @return array An indexed array with files. |
|
670 | + * @see FileHelper::createFileFinder() |
|
671 | + */ |
|
672 | 672 | public static function findHTMLFiles(string $targetFolder, array $options=array()) : array |
673 | 673 | { |
674 | 674 | return self::findFiles($targetFolder, array('html'), $options); |
675 | 675 | } |
676 | 676 | |
677 | - /** |
|
678 | - * Searches for all PHP files in the target folder. |
|
679 | - * |
|
680 | - * NOTE: This method only exists for backwards compatibility. |
|
681 | - * Use the `createFileFinder()` method instead, which offers |
|
682 | - * an object oriented interface that is much easier to use. |
|
683 | - * |
|
684 | - * @param string $targetFolder |
|
685 | - * @param array $options |
|
686 | - * @return array An indexed array of PHP files. |
|
687 | - * @see FileHelper::createFileFinder() |
|
688 | - */ |
|
677 | + /** |
|
678 | + * Searches for all PHP files in the target folder. |
|
679 | + * |
|
680 | + * NOTE: This method only exists for backwards compatibility. |
|
681 | + * Use the `createFileFinder()` method instead, which offers |
|
682 | + * an object oriented interface that is much easier to use. |
|
683 | + * |
|
684 | + * @param string $targetFolder |
|
685 | + * @param array $options |
|
686 | + * @return array An indexed array of PHP files. |
|
687 | + * @see FileHelper::createFileFinder() |
|
688 | + */ |
|
689 | 689 | public static function findPHPFiles(string $targetFolder, array $options=array()) : array |
690 | 690 | { |
691 | 691 | return self::findFiles($targetFolder, array('php'), $options); |
692 | 692 | } |
693 | 693 | |
694 | - /** |
|
695 | - * Finds files according to the specified options. |
|
696 | - * |
|
697 | - * NOTE: This method only exists for backwards compatibility. |
|
698 | - * Use the `createFileFinder()` method instead, which offers |
|
699 | - * an object oriented interface that is much easier to use. |
|
700 | - * |
|
701 | - * @param string $targetFolder |
|
702 | - * @param array $extensions |
|
703 | - * @param array $options |
|
704 | - * @param array $files |
|
705 | - * @throws FileHelper_Exception |
|
706 | - * @return array |
|
707 | - * @see FileHelper::createFileFinder() |
|
708 | - */ |
|
694 | + /** |
|
695 | + * Finds files according to the specified options. |
|
696 | + * |
|
697 | + * NOTE: This method only exists for backwards compatibility. |
|
698 | + * Use the `createFileFinder()` method instead, which offers |
|
699 | + * an object oriented interface that is much easier to use. |
|
700 | + * |
|
701 | + * @param string $targetFolder |
|
702 | + * @param array $extensions |
|
703 | + * @param array $options |
|
704 | + * @param array $files |
|
705 | + * @throws FileHelper_Exception |
|
706 | + * @return array |
|
707 | + * @see FileHelper::createFileFinder() |
|
708 | + */ |
|
709 | 709 | public static function findFiles(string $targetFolder, array $extensions=array(), array $options=array(), array $files=array()) : array |
710 | 710 | { |
711 | 711 | $finder = self::createFileFinder($targetFolder); |
@@ -731,14 +731,14 @@ discard block |
||
731 | 731 | return $finder->getAll(); |
732 | 732 | } |
733 | 733 | |
734 | - /** |
|
735 | - * Removes the extension from the specified path or file name, |
|
736 | - * if any, and returns the name without the extension. |
|
737 | - * |
|
738 | - * @param string $filename |
|
739 | - * @param bool $keepPath Whether to keep the path component, if any. Default PHP pathinfo behavior is not to. |
|
740 | - * @return string |
|
741 | - */ |
|
734 | + /** |
|
735 | + * Removes the extension from the specified path or file name, |
|
736 | + * if any, and returns the name without the extension. |
|
737 | + * |
|
738 | + * @param string $filename |
|
739 | + * @param bool $keepPath Whether to keep the path component, if any. Default PHP pathinfo behavior is not to. |
|
740 | + * @return string |
|
741 | + */ |
|
742 | 742 | public static function removeExtension(string $filename, bool $keepPath=false) : string |
743 | 743 | { |
744 | 744 | // normalize paths to allow windows style slashes even on nix servers |
@@ -758,22 +758,22 @@ discard block |
||
758 | 758 | return implode('/', $parts); |
759 | 759 | } |
760 | 760 | |
761 | - /** |
|
762 | - * Detects the UTF BOM in the target file, if any. Returns |
|
763 | - * the encoding matching the BOM, which can be any of the |
|
764 | - * following: |
|
765 | - * |
|
766 | - * <ul> |
|
767 | - * <li>UTF32-BE</li> |
|
768 | - * <li>UTF32-LE</li> |
|
769 | - * <li>UTF16-BE</li> |
|
770 | - * <li>UTF16-LE</li> |
|
771 | - * <li>UTF8</li> |
|
772 | - * </ul> |
|
773 | - * |
|
774 | - * @param string $filename |
|
775 | - * @return string|NULL |
|
776 | - */ |
|
761 | + /** |
|
762 | + * Detects the UTF BOM in the target file, if any. Returns |
|
763 | + * the encoding matching the BOM, which can be any of the |
|
764 | + * following: |
|
765 | + * |
|
766 | + * <ul> |
|
767 | + * <li>UTF32-BE</li> |
|
768 | + * <li>UTF32-LE</li> |
|
769 | + * <li>UTF16-BE</li> |
|
770 | + * <li>UTF16-LE</li> |
|
771 | + * <li>UTF8</li> |
|
772 | + * </ul> |
|
773 | + * |
|
774 | + * @param string $filename |
|
775 | + * @return string|NULL |
|
776 | + */ |
|
777 | 777 | public static function detectUTFBom(string $filename) : ?string |
778 | 778 | { |
779 | 779 | $fp = fopen($filename, 'r'); |
@@ -805,13 +805,13 @@ discard block |
||
805 | 805 | |
806 | 806 | protected static $utfBoms; |
807 | 807 | |
808 | - /** |
|
809 | - * Retrieves a list of all UTF byte order mark character |
|
810 | - * sequences, as an assocative array with UTF encoding => bom sequence |
|
811 | - * pairs. |
|
812 | - * |
|
813 | - * @return array |
|
814 | - */ |
|
808 | + /** |
|
809 | + * Retrieves a list of all UTF byte order mark character |
|
810 | + * sequences, as an assocative array with UTF encoding => bom sequence |
|
811 | + * pairs. |
|
812 | + * |
|
813 | + * @return array |
|
814 | + */ |
|
815 | 815 | public static function getUTFBOMs() |
816 | 816 | { |
817 | 817 | if(!isset(self::$utfBoms)) { |
@@ -827,15 +827,15 @@ discard block |
||
827 | 827 | return self::$utfBoms; |
828 | 828 | } |
829 | 829 | |
830 | - /** |
|
831 | - * Checks whether the specified encoding is a valid |
|
832 | - * unicode encoding, for example "UTF16-LE" or "UTF8". |
|
833 | - * Also accounts for alternate way to write the, like |
|
834 | - * "UTF-8", and omitting little/big endian suffixes. |
|
835 | - * |
|
836 | - * @param string $encoding |
|
837 | - * @return boolean |
|
838 | - */ |
|
830 | + /** |
|
831 | + * Checks whether the specified encoding is a valid |
|
832 | + * unicode encoding, for example "UTF16-LE" or "UTF8". |
|
833 | + * Also accounts for alternate way to write the, like |
|
834 | + * "UTF-8", and omitting little/big endian suffixes. |
|
835 | + * |
|
836 | + * @param string $encoding |
|
837 | + * @return boolean |
|
838 | + */ |
|
839 | 839 | public static function isValidUnicodeEncoding(string $encoding) : bool |
840 | 840 | { |
841 | 841 | $encodings = self::getKnownUnicodeEncodings(); |
@@ -854,40 +854,40 @@ discard block |
||
854 | 854 | return in_array($encoding, $keep); |
855 | 855 | } |
856 | 856 | |
857 | - /** |
|
858 | - * Retrieves a list of all known unicode file encodings. |
|
859 | - * @return array |
|
860 | - */ |
|
857 | + /** |
|
858 | + * Retrieves a list of all known unicode file encodings. |
|
859 | + * @return array |
|
860 | + */ |
|
861 | 861 | public static function getKnownUnicodeEncodings() |
862 | 862 | { |
863 | 863 | return array_keys(self::getUTFBOMs()); |
864 | 864 | } |
865 | 865 | |
866 | - /** |
|
867 | - * Normalizes the slash style in a file or folder path, |
|
868 | - * by replacing any antislashes with forward slashes. |
|
869 | - * |
|
870 | - * @param string $path |
|
871 | - * @return string |
|
872 | - */ |
|
866 | + /** |
|
867 | + * Normalizes the slash style in a file or folder path, |
|
868 | + * by replacing any antislashes with forward slashes. |
|
869 | + * |
|
870 | + * @param string $path |
|
871 | + * @return string |
|
872 | + */ |
|
873 | 873 | public static function normalizePath(string $path) : string |
874 | 874 | { |
875 | 875 | return str_replace(array('\\', '//'), array('/', '/'), $path); |
876 | 876 | } |
877 | 877 | |
878 | - /** |
|
879 | - * Saves the specified data to a file, JSON encoded. |
|
880 | - * |
|
881 | - * @param mixed $data |
|
882 | - * @param string $file |
|
883 | - * @param bool $pretty |
|
884 | - * @throws FileHelper_Exception |
|
885 | - * |
|
886 | - * @see FileHelper::ERROR_JSON_ENCODE_ERROR |
|
887 | - * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE |
|
888 | - * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
|
889 | - * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
|
890 | - */ |
|
878 | + /** |
|
879 | + * Saves the specified data to a file, JSON encoded. |
|
880 | + * |
|
881 | + * @param mixed $data |
|
882 | + * @param string $file |
|
883 | + * @param bool $pretty |
|
884 | + * @throws FileHelper_Exception |
|
885 | + * |
|
886 | + * @see FileHelper::ERROR_JSON_ENCODE_ERROR |
|
887 | + * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE |
|
888 | + * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
|
889 | + * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
|
890 | + */ |
|
891 | 891 | public static function saveAsJSON($data, string $file, bool $pretty=false) |
892 | 892 | { |
893 | 893 | $options = null; |
@@ -911,18 +911,18 @@ discard block |
||
911 | 911 | self::saveFile($file, $json); |
912 | 912 | } |
913 | 913 | |
914 | - /** |
|
915 | - * Saves the specified content to the target file, creating |
|
916 | - * the file and the folder as necessary. |
|
917 | - * |
|
918 | - * @param string $filePath |
|
919 | - * @param string $content |
|
920 | - * @throws FileHelper_Exception |
|
921 | - * |
|
922 | - * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE |
|
923 | - * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
|
924 | - * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
|
925 | - */ |
|
914 | + /** |
|
915 | + * Saves the specified content to the target file, creating |
|
916 | + * the file and the folder as necessary. |
|
917 | + * |
|
918 | + * @param string $filePath |
|
919 | + * @param string $content |
|
920 | + * @throws FileHelper_Exception |
|
921 | + * |
|
922 | + * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE |
|
923 | + * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
|
924 | + * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
|
925 | + */ |
|
926 | 926 | public static function saveFile(string $filePath, string $content='') : void |
927 | 927 | { |
928 | 928 | $filePath = self::normalizePath($filePath); |
@@ -1072,16 +1072,16 @@ discard block |
||
1072 | 1072 | return $result; |
1073 | 1073 | } |
1074 | 1074 | |
1075 | - /** |
|
1076 | - * Validates a PHP file's syntax. |
|
1077 | - * |
|
1078 | - * NOTE: This will fail silently if the PHP command line |
|
1079 | - * is not available. Use {@link FileHelper::canMakePHPCalls()} |
|
1080 | - * to check this beforehand as needed. |
|
1081 | - * |
|
1082 | - * @param string $path |
|
1083 | - * @return boolean|array A boolean true if the file is valid, an array with validation messages otherwise. |
|
1084 | - */ |
|
1075 | + /** |
|
1076 | + * Validates a PHP file's syntax. |
|
1077 | + * |
|
1078 | + * NOTE: This will fail silently if the PHP command line |
|
1079 | + * is not available. Use {@link FileHelper::canMakePHPCalls()} |
|
1080 | + * to check this beforehand as needed. |
|
1081 | + * |
|
1082 | + * @param string $path |
|
1083 | + * @return boolean|array A boolean true if the file is valid, an array with validation messages otherwise. |
|
1084 | + */ |
|
1085 | 1085 | public static function checkPHPFileSyntax($path) |
1086 | 1086 | { |
1087 | 1087 | if(!self::canMakePHPCalls()) { |
@@ -1105,14 +1105,14 @@ discard block |
||
1105 | 1105 | return $output; |
1106 | 1106 | } |
1107 | 1107 | |
1108 | - /** |
|
1109 | - * Retrieves the last modified date for the specified file or folder. |
|
1110 | - * |
|
1111 | - * Note: If the target does not exist, returns null. |
|
1112 | - * |
|
1113 | - * @param string $path |
|
1114 | - * @return \DateTime|NULL |
|
1115 | - */ |
|
1108 | + /** |
|
1109 | + * Retrieves the last modified date for the specified file or folder. |
|
1110 | + * |
|
1111 | + * Note: If the target does not exist, returns null. |
|
1112 | + * |
|
1113 | + * @param string $path |
|
1114 | + * @return \DateTime|NULL |
|
1115 | + */ |
|
1116 | 1116 | public static function getModifiedDate($path) |
1117 | 1117 | { |
1118 | 1118 | $time = filemtime($path); |
@@ -1125,24 +1125,24 @@ discard block |
||
1125 | 1125 | return null; |
1126 | 1126 | } |
1127 | 1127 | |
1128 | - /** |
|
1129 | - * Retrieves the names of all subfolders in the specified path. |
|
1130 | - * |
|
1131 | - * Available options: |
|
1132 | - * |
|
1133 | - * - recursive: true/false |
|
1134 | - * Whether to search for subfolders recursively. |
|
1135 | - * |
|
1136 | - * - absolute-paths: true/false |
|
1137 | - * Whether to return a list of absolute paths. |
|
1138 | - * |
|
1139 | - * @param string $targetFolder |
|
1140 | - * @param array $options |
|
1141 | - * @throws FileHelper_Exception |
|
1142 | - * @return string[] |
|
1143 | - * |
|
1144 | - * @todo Move this to a separate class. |
|
1145 | - */ |
|
1128 | + /** |
|
1129 | + * Retrieves the names of all subfolders in the specified path. |
|
1130 | + * |
|
1131 | + * Available options: |
|
1132 | + * |
|
1133 | + * - recursive: true/false |
|
1134 | + * Whether to search for subfolders recursively. |
|
1135 | + * |
|
1136 | + * - absolute-paths: true/false |
|
1137 | + * Whether to return a list of absolute paths. |
|
1138 | + * |
|
1139 | + * @param string $targetFolder |
|
1140 | + * @param array $options |
|
1141 | + * @throws FileHelper_Exception |
|
1142 | + * @return string[] |
|
1143 | + * |
|
1144 | + * @todo Move this to a separate class. |
|
1145 | + */ |
|
1146 | 1146 | public static function getSubfolders($targetFolder, $options = array()) |
1147 | 1147 | { |
1148 | 1148 | if(!is_dir($targetFolder)) |
@@ -1203,16 +1203,16 @@ discard block |
||
1203 | 1203 | return $result; |
1204 | 1204 | } |
1205 | 1205 | |
1206 | - /** |
|
1207 | - * Retrieves the maximum allowed upload file size, in bytes. |
|
1208 | - * Takes into account the PHP ini settings <code>post_max_size</code> |
|
1209 | - * and <code>upload_max_filesize</code>. Since these cannot |
|
1210 | - * be modified at runtime, they are the hard limits for uploads. |
|
1211 | - * |
|
1212 | - * NOTE: Based on binary values, where 1KB = 1024 Bytes. |
|
1213 | - * |
|
1214 | - * @return int Will return <code>-1</code> if no limit. |
|
1215 | - */ |
|
1206 | + /** |
|
1207 | + * Retrieves the maximum allowed upload file size, in bytes. |
|
1208 | + * Takes into account the PHP ini settings <code>post_max_size</code> |
|
1209 | + * and <code>upload_max_filesize</code>. Since these cannot |
|
1210 | + * be modified at runtime, they are the hard limits for uploads. |
|
1211 | + * |
|
1212 | + * NOTE: Based on binary values, where 1KB = 1024 Bytes. |
|
1213 | + * |
|
1214 | + * @return int Will return <code>-1</code> if no limit. |
|
1215 | + */ |
|
1216 | 1216 | public static function getMaxUploadFilesize() : int |
1217 | 1217 | { |
1218 | 1218 | static $max_size = -1; |
@@ -1250,16 +1250,16 @@ discard block |
||
1250 | 1250 | return round($size); |
1251 | 1251 | } |
1252 | 1252 | |
1253 | - /** |
|
1254 | - * Makes a path relative using a folder depth: will reduce the |
|
1255 | - * length of the path so that only the amount of folders defined |
|
1256 | - * in the <code>$depth</code> attribute are shown below the actual |
|
1257 | - * folder or file in the path. |
|
1258 | - * |
|
1259 | - * @param string $path The absolute or relative path |
|
1260 | - * @param int $depth The folder depth to reduce the path to |
|
1261 | - * @return string |
|
1262 | - */ |
|
1253 | + /** |
|
1254 | + * Makes a path relative using a folder depth: will reduce the |
|
1255 | + * length of the path so that only the amount of folders defined |
|
1256 | + * in the <code>$depth</code> attribute are shown below the actual |
|
1257 | + * folder or file in the path. |
|
1258 | + * |
|
1259 | + * @param string $path The absolute or relative path |
|
1260 | + * @param int $depth The folder depth to reduce the path to |
|
1261 | + * @return string |
|
1262 | + */ |
|
1263 | 1263 | public static function relativizePathByDepth(string $path, int $depth=2) : string |
1264 | 1264 | { |
1265 | 1265 | $path = self::normalizePath($path); |
@@ -1297,23 +1297,23 @@ discard block |
||
1297 | 1297 | return trim(implode('/', $tokens), '/'); |
1298 | 1298 | } |
1299 | 1299 | |
1300 | - /** |
|
1301 | - * Makes the specified path relative to another path, |
|
1302 | - * by removing one from the other if found. Also |
|
1303 | - * normalizes the path to use forward slashes. |
|
1304 | - * |
|
1305 | - * Example: |
|
1306 | - * |
|
1307 | - * <pre> |
|
1308 | - * relativizePath('c:\some\folder\to\file.txt', 'c:\some\folder'); |
|
1309 | - * </pre> |
|
1310 | - * |
|
1311 | - * Result: <code>to/file.txt</code> |
|
1312 | - * |
|
1313 | - * @param string $path |
|
1314 | - * @param string $relativeTo |
|
1315 | - * @return string |
|
1316 | - */ |
|
1300 | + /** |
|
1301 | + * Makes the specified path relative to another path, |
|
1302 | + * by removing one from the other if found. Also |
|
1303 | + * normalizes the path to use forward slashes. |
|
1304 | + * |
|
1305 | + * Example: |
|
1306 | + * |
|
1307 | + * <pre> |
|
1308 | + * relativizePath('c:\some\folder\to\file.txt', 'c:\some\folder'); |
|
1309 | + * </pre> |
|
1310 | + * |
|
1311 | + * Result: <code>to/file.txt</code> |
|
1312 | + * |
|
1313 | + * @param string $path |
|
1314 | + * @param string $relativeTo |
|
1315 | + * @return string |
|
1316 | + */ |
|
1317 | 1317 | public static function relativizePath(string $path, string $relativeTo) : string |
1318 | 1318 | { |
1319 | 1319 | $path = self::normalizePath($path); |
@@ -1325,17 +1325,17 @@ discard block |
||
1325 | 1325 | return $relative; |
1326 | 1326 | } |
1327 | 1327 | |
1328 | - /** |
|
1329 | - * Checks that the target file exists, and throws an exception |
|
1330 | - * if it does not. |
|
1331 | - * |
|
1332 | - * @param string $path |
|
1333 | - * @param int|NULL $errorCode Optional custom error code |
|
1334 | - * @throws FileHelper_Exception |
|
1335 | - * @return string The real path to the file |
|
1336 | - * |
|
1337 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
1338 | - */ |
|
1328 | + /** |
|
1329 | + * Checks that the target file exists, and throws an exception |
|
1330 | + * if it does not. |
|
1331 | + * |
|
1332 | + * @param string $path |
|
1333 | + * @param int|NULL $errorCode Optional custom error code |
|
1334 | + * @throws FileHelper_Exception |
|
1335 | + * @return string The real path to the file |
|
1336 | + * |
|
1337 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
1338 | + */ |
|
1339 | 1339 | public static function requireFileExists(string $path, ?int $errorCode=null) : string |
1340 | 1340 | { |
1341 | 1341 | $result = realpath($path); |
@@ -1373,18 +1373,18 @@ discard block |
||
1373 | 1373 | ); |
1374 | 1374 | } |
1375 | 1375 | |
1376 | - /** |
|
1377 | - * Reads a specific line number from the target file and returns its |
|
1378 | - * contents, if the file has such a line. Does so with little memory |
|
1379 | - * usage, as the file is not read entirely into memory. |
|
1380 | - * |
|
1381 | - * @param string $path |
|
1382 | - * @param int $lineNumber Note: 1-based; the first line is number 1. |
|
1383 | - * @return string|NULL Will return null if the requested line does not exist. |
|
1384 | - * @throws FileHelper_Exception |
|
1385 | - * |
|
1386 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
1387 | - */ |
|
1376 | + /** |
|
1377 | + * Reads a specific line number from the target file and returns its |
|
1378 | + * contents, if the file has such a line. Does so with little memory |
|
1379 | + * usage, as the file is not read entirely into memory. |
|
1380 | + * |
|
1381 | + * @param string $path |
|
1382 | + * @param int $lineNumber Note: 1-based; the first line is number 1. |
|
1383 | + * @return string|NULL Will return null if the requested line does not exist. |
|
1384 | + * @throws FileHelper_Exception |
|
1385 | + * |
|
1386 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
1387 | + */ |
|
1388 | 1388 | public static function getLineFromFile(string $path, int $lineNumber) : ?string |
1389 | 1389 | { |
1390 | 1390 | self::requireFileExists($path); |
@@ -1400,19 +1400,19 @@ discard block |
||
1400 | 1400 | $file->seek($targetLine); |
1401 | 1401 | |
1402 | 1402 | if($file->key() !== $targetLine) { |
1403 | - return null; |
|
1403 | + return null; |
|
1404 | 1404 | } |
1405 | 1405 | |
1406 | 1406 | return $file->current(); |
1407 | 1407 | } |
1408 | 1408 | |
1409 | - /** |
|
1410 | - * Retrieves the total amount of lines in the file, without |
|
1411 | - * reading the whole file into memory. |
|
1412 | - * |
|
1413 | - * @param string $path |
|
1414 | - * @return int |
|
1415 | - */ |
|
1409 | + /** |
|
1410 | + * Retrieves the total amount of lines in the file, without |
|
1411 | + * reading the whole file into memory. |
|
1412 | + * |
|
1413 | + * @param string $path |
|
1414 | + * @return int |
|
1415 | + */ |
|
1416 | 1416 | public static function countFileLines(string $path) : int |
1417 | 1417 | { |
1418 | 1418 | self::requireFileExists($path); |
@@ -1442,26 +1442,26 @@ discard block |
||
1442 | 1442 | return $number+1; |
1443 | 1443 | } |
1444 | 1444 | |
1445 | - /** |
|
1446 | - * Parses the target file to detect any PHP classes contained |
|
1447 | - * within, and retrieve information on them. Does not use the |
|
1448 | - * PHP reflection API. |
|
1449 | - * |
|
1450 | - * @param string $filePath |
|
1451 | - * @return FileHelper_PHPClassInfo |
|
1452 | - */ |
|
1445 | + /** |
|
1446 | + * Parses the target file to detect any PHP classes contained |
|
1447 | + * within, and retrieve information on them. Does not use the |
|
1448 | + * PHP reflection API. |
|
1449 | + * |
|
1450 | + * @param string $filePath |
|
1451 | + * @return FileHelper_PHPClassInfo |
|
1452 | + */ |
|
1453 | 1453 | public static function findPHPClasses(string $filePath) : FileHelper_PHPClassInfo |
1454 | 1454 | { |
1455 | 1455 | return new FileHelper_PHPClassInfo($filePath); |
1456 | 1456 | } |
1457 | 1457 | |
1458 | - /** |
|
1459 | - * Detects the end of line style used in the target file, if any. |
|
1460 | - * Can be used with large files, because it only reads part of it. |
|
1461 | - * |
|
1462 | - * @param string $filePath The path to the file. |
|
1463 | - * @return NULL|ConvertHelper_EOL The end of line character information, or NULL if none is found. |
|
1464 | - */ |
|
1458 | + /** |
|
1459 | + * Detects the end of line style used in the target file, if any. |
|
1460 | + * Can be used with large files, because it only reads part of it. |
|
1461 | + * |
|
1462 | + * @param string $filePath The path to the file. |
|
1463 | + * @return NULL|ConvertHelper_EOL The end of line character information, or NULL if none is found. |
|
1464 | + */ |
|
1465 | 1465 | public static function detectEOLCharacter(string $filePath) : ?ConvertHelper_EOL |
1466 | 1466 | { |
1467 | 1467 | // 20 lines is enough to get a good picture of the newline style in the file. |
@@ -1474,18 +1474,18 @@ discard block |
||
1474 | 1474 | return ConvertHelper::detectEOLCharacter($string); |
1475 | 1475 | } |
1476 | 1476 | |
1477 | - /** |
|
1478 | - * Reads the specified amount of lines from the target file. |
|
1479 | - * Unicode BOM compatible: any byte order marker is stripped |
|
1480 | - * from the resulting lines. |
|
1481 | - * |
|
1482 | - * @param string $filePath |
|
1483 | - * @param int $amount Set to 0 to read all lines. |
|
1484 | - * @return array |
|
1485 | - * |
|
1486 | - * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES |
|
1487 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
1488 | - */ |
|
1477 | + /** |
|
1478 | + * Reads the specified amount of lines from the target file. |
|
1479 | + * Unicode BOM compatible: any byte order marker is stripped |
|
1480 | + * from the resulting lines. |
|
1481 | + * |
|
1482 | + * @param string $filePath |
|
1483 | + * @param int $amount Set to 0 to read all lines. |
|
1484 | + * @return array |
|
1485 | + * |
|
1486 | + * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES |
|
1487 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
1488 | + */ |
|
1489 | 1489 | public static function readLines(string $filePath, int $amount=0) : array |
1490 | 1490 | { |
1491 | 1491 | self::requireFileExists($filePath); |
@@ -1538,16 +1538,16 @@ discard block |
||
1538 | 1538 | return $result; |
1539 | 1539 | } |
1540 | 1540 | |
1541 | - /** |
|
1542 | - * Reads all content from a file. |
|
1543 | - * |
|
1544 | - * @param string $filePath |
|
1545 | - * @throws FileHelper_Exception |
|
1546 | - * @return string |
|
1547 | - * |
|
1548 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
1549 | - * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS |
|
1550 | - */ |
|
1541 | + /** |
|
1542 | + * Reads all content from a file. |
|
1543 | + * |
|
1544 | + * @param string $filePath |
|
1545 | + * @throws FileHelper_Exception |
|
1546 | + * @return string |
|
1547 | + * |
|
1548 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
1549 | + * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS |
|
1550 | + */ |
|
1551 | 1551 | public static function readContents(string $filePath) : string |
1552 | 1552 | { |
1553 | 1553 | self::requireFileExists($filePath); |
@@ -1568,18 +1568,18 @@ discard block |
||
1568 | 1568 | ); |
1569 | 1569 | } |
1570 | 1570 | |
1571 | - /** |
|
1572 | - * Ensures that the target path exists on disk, and is a folder. |
|
1573 | - * |
|
1574 | - * @param string $path |
|
1575 | - * @return string The real path, with normalized slashes. |
|
1576 | - * @throws FileHelper_Exception |
|
1577 | - * |
|
1578 | - * @see FileHelper::normalizePath() |
|
1579 | - * |
|
1580 | - * @see FileHelper::ERROR_FOLDER_DOES_NOT_EXIST |
|
1581 | - * @see FileHelper::ERROR_PATH_IS_NOT_A_FOLDER |
|
1582 | - */ |
|
1571 | + /** |
|
1572 | + * Ensures that the target path exists on disk, and is a folder. |
|
1573 | + * |
|
1574 | + * @param string $path |
|
1575 | + * @return string The real path, with normalized slashes. |
|
1576 | + * @throws FileHelper_Exception |
|
1577 | + * |
|
1578 | + * @see FileHelper::normalizePath() |
|
1579 | + * |
|
1580 | + * @see FileHelper::ERROR_FOLDER_DOES_NOT_EXIST |
|
1581 | + * @see FileHelper::ERROR_PATH_IS_NOT_A_FOLDER |
|
1582 | + */ |
|
1583 | 1583 | public static function requireFolderExists(string $path) : string |
1584 | 1584 | { |
1585 | 1585 | $actual = realpath($path); |
@@ -84,7 +84,7 @@ discard block |
||
84 | 84 | |
85 | 85 | $contents = file_get_contents($file); |
86 | 86 | |
87 | - if($contents === false) |
|
87 | + if ($contents === false) |
|
88 | 88 | { |
89 | 89 | throw new FileHelper_Exception( |
90 | 90 | 'Cannot load serialized content from file.', |
@@ -98,7 +98,7 @@ discard block |
||
98 | 98 | |
99 | 99 | $result = @unserialize($contents); |
100 | 100 | |
101 | - if($result !== false) { |
|
101 | + if ($result !== false) { |
|
102 | 102 | return $result; |
103 | 103 | } |
104 | 104 | |
@@ -114,7 +114,7 @@ discard block |
||
114 | 114 | |
115 | 115 | public static function deleteTree($rootFolder) |
116 | 116 | { |
117 | - if(!file_exists($rootFolder)) { |
|
117 | + if (!file_exists($rootFolder)) { |
|
118 | 118 | return true; |
119 | 119 | } |
120 | 120 | |
@@ -155,7 +155,7 @@ discard block |
||
155 | 155 | */ |
156 | 156 | public static function createFolder($path) |
157 | 157 | { |
158 | - if(is_dir($path) || mkdir($path, 0777, true)) { |
|
158 | + if (is_dir($path) || mkdir($path, 0777, true)) { |
|
159 | 159 | return; |
160 | 160 | } |
161 | 161 | |
@@ -190,11 +190,11 @@ discard block |
||
190 | 190 | |
191 | 191 | if ($item->isDir()) |
192 | 192 | { |
193 | - FileHelper::copyTree($itemPath, $target . '/' . $baseName); |
|
193 | + FileHelper::copyTree($itemPath, $target.'/'.$baseName); |
|
194 | 194 | } |
195 | - else if($item->isFile()) |
|
195 | + else if ($item->isFile()) |
|
196 | 196 | { |
197 | - self::copyFile($itemPath, $target . '/' . $baseName); |
|
197 | + self::copyFile($itemPath, $target.'/'.$baseName); |
|
198 | 198 | } |
199 | 199 | } |
200 | 200 | } |
@@ -222,11 +222,11 @@ discard block |
||
222 | 222 | |
223 | 223 | $targetFolder = dirname($targetPath); |
224 | 224 | |
225 | - if(!file_exists($targetFolder)) |
|
225 | + if (!file_exists($targetFolder)) |
|
226 | 226 | { |
227 | 227 | self::createFolder($targetFolder); |
228 | 228 | } |
229 | - else if(!is_writable($targetFolder)) |
|
229 | + else if (!is_writable($targetFolder)) |
|
230 | 230 | { |
231 | 231 | throw new FileHelper_Exception( |
232 | 232 | sprintf('Target folder [%s] is not writable.', basename($targetFolder)), |
@@ -238,7 +238,7 @@ discard block |
||
238 | 238 | ); |
239 | 239 | } |
240 | 240 | |
241 | - if(copy($sourcePath, $targetPath)) { |
|
241 | + if (copy($sourcePath, $targetPath)) { |
|
242 | 242 | return; |
243 | 243 | } |
244 | 244 | |
@@ -265,11 +265,11 @@ discard block |
||
265 | 265 | */ |
266 | 266 | public static function deleteFile(string $filePath) : void |
267 | 267 | { |
268 | - if(!file_exists($filePath)) { |
|
268 | + if (!file_exists($filePath)) { |
|
269 | 269 | return; |
270 | 270 | } |
271 | 271 | |
272 | - if(unlink($filePath)) { |
|
272 | + if (unlink($filePath)) { |
|
273 | 273 | return; |
274 | 274 | } |
275 | 275 | |
@@ -293,10 +293,10 @@ discard block |
||
293 | 293 | * @return Csv |
294 | 294 | * @see CSVHelper::createParser() |
295 | 295 | */ |
296 | - public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : Csv |
|
296 | + public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : Csv |
|
297 | 297 | { |
298 | - if($delimiter==='') { $delimiter = ';'; } |
|
299 | - if($enclosure==='') { $enclosure = '"'; } |
|
298 | + if ($delimiter === '') { $delimiter = ';'; } |
|
299 | + if ($enclosure === '') { $enclosure = '"'; } |
|
300 | 300 | |
301 | 301 | $parser = CSVHelper::createParser($delimiter); |
302 | 302 | $parser->enclosure = $enclosure; |
@@ -320,11 +320,11 @@ discard block |
||
320 | 320 | * @see parseCSVFile() |
321 | 321 | * @see FileHelper::ERROR_PARSING_CSV |
322 | 322 | */ |
323 | - public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array |
|
323 | + public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : array |
|
324 | 324 | { |
325 | 325 | $parser = self::createCSVParser($delimiter, $enclosure, '\\', $heading); |
326 | 326 | |
327 | - if($parser->parse($csv)) |
|
327 | + if ($parser->parse($csv)) |
|
328 | 328 | { |
329 | 329 | return $parser->data; |
330 | 330 | } |
@@ -352,7 +352,7 @@ discard block |
||
352 | 352 | * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
353 | 353 | * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS |
354 | 354 | */ |
355 | - public static function parseCSVFile(string $filePath, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array |
|
355 | + public static function parseCSVFile(string $filePath, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : array |
|
356 | 356 | { |
357 | 357 | $content = self::readContents($filePath); |
358 | 358 | |
@@ -369,7 +369,7 @@ discard block |
||
369 | 369 | public static function detectMimeType(string $fileName) : ?string |
370 | 370 | { |
371 | 371 | $ext = self::getExtension($fileName); |
372 | - if(empty($ext)) { |
|
372 | + if (empty($ext)) { |
|
373 | 373 | return null; |
374 | 374 | } |
375 | 375 | |
@@ -390,11 +390,11 @@ discard block |
||
390 | 390 | * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
391 | 391 | * @see FileHelper::ERROR_UNKNOWN_FILE_MIME_TYPE |
392 | 392 | */ |
393 | - public static function sendFile(string $filePath, $fileName = null, bool $asAttachment=true) |
|
393 | + public static function sendFile(string $filePath, $fileName = null, bool $asAttachment = true) |
|
394 | 394 | { |
395 | 395 | self::requireFileExists($filePath); |
396 | 396 | |
397 | - if(empty($fileName)) { |
|
397 | + if (empty($fileName)) { |
|
398 | 398 | $fileName = basename($filePath); |
399 | 399 | } |
400 | 400 | |
@@ -412,10 +412,10 @@ discard block |
||
412 | 412 | |
413 | 413 | header("Cache-Control: public", true); |
414 | 414 | header("Content-Description: File Transfer", true); |
415 | - header("Content-Type: " . $mime, true); |
|
415 | + header("Content-Type: ".$mime, true); |
|
416 | 416 | |
417 | 417 | $disposition = 'inline'; |
418 | - if($asAttachment) { |
|
418 | + if ($asAttachment) { |
|
419 | 419 | $disposition = 'attachment'; |
420 | 420 | } |
421 | 421 | |
@@ -443,7 +443,7 @@ discard block |
||
443 | 443 | requireCURL(); |
444 | 444 | |
445 | 445 | $ch = curl_init(); |
446 | - if(!is_resource($ch)) |
|
446 | + if (!is_resource($ch)) |
|
447 | 447 | { |
448 | 448 | throw new FileHelper_Exception( |
449 | 449 | 'Could not initialize a new cURL instance.', |
@@ -464,7 +464,7 @@ discard block |
||
464 | 464 | |
465 | 465 | $output = curl_exec($ch); |
466 | 466 | |
467 | - if($output === false) { |
|
467 | + if ($output === false) { |
|
468 | 468 | throw new FileHelper_Exception( |
469 | 469 | 'Unable to open URL', |
470 | 470 | sprintf( |
@@ -478,7 +478,7 @@ discard block |
||
478 | 478 | |
479 | 479 | curl_close($ch); |
480 | 480 | |
481 | - if(is_string($output)) |
|
481 | + if (is_string($output)) |
|
482 | 482 | { |
483 | 483 | return $output; |
484 | 484 | } |
@@ -500,7 +500,7 @@ discard block |
||
500 | 500 | */ |
501 | 501 | public static function isPHPFile($pathOrDirIterator) |
502 | 502 | { |
503 | - if(self::getExtension($pathOrDirIterator) == 'php') { |
|
503 | + if (self::getExtension($pathOrDirIterator) == 'php') { |
|
504 | 504 | return true; |
505 | 505 | } |
506 | 506 | |
@@ -517,14 +517,14 @@ discard block |
||
517 | 517 | */ |
518 | 518 | public static function getExtension($pathOrDirIterator, bool $lowercase = true) : string |
519 | 519 | { |
520 | - if($pathOrDirIterator instanceof \DirectoryIterator) { |
|
520 | + if ($pathOrDirIterator instanceof \DirectoryIterator) { |
|
521 | 521 | $filename = $pathOrDirIterator->getFilename(); |
522 | 522 | } else { |
523 | 523 | $filename = basename($pathOrDirIterator); |
524 | 524 | } |
525 | 525 | |
526 | 526 | $ext = pathinfo($filename, PATHINFO_EXTENSION); |
527 | - if($lowercase) { |
|
527 | + if ($lowercase) { |
|
528 | 528 | $ext = mb_strtolower($ext); |
529 | 529 | } |
530 | 530 | |
@@ -546,13 +546,13 @@ discard block |
||
546 | 546 | public static function getFilename($pathOrDirIterator, $extension = true) |
547 | 547 | { |
548 | 548 | $path = $pathOrDirIterator; |
549 | - if($pathOrDirIterator instanceof \DirectoryIterator) { |
|
549 | + if ($pathOrDirIterator instanceof \DirectoryIterator) { |
|
550 | 550 | $path = $pathOrDirIterator->getFilename(); |
551 | 551 | } |
552 | 552 | |
553 | 553 | $path = self::normalizePath($path); |
554 | 554 | |
555 | - if(!$extension) { |
|
555 | + if (!$extension) { |
|
556 | 556 | return pathinfo($path, PATHINFO_FILENAME); |
557 | 557 | } |
558 | 558 | |
@@ -570,12 +570,12 @@ discard block |
||
570 | 570 | * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE |
571 | 571 | * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE |
572 | 572 | */ |
573 | - public static function parseJSONFile(string $file, $targetEncoding=null, $sourceEncoding=null) |
|
573 | + public static function parseJSONFile(string $file, $targetEncoding = null, $sourceEncoding = null) |
|
574 | 574 | { |
575 | 575 | self::requireFileExists($file, self::ERROR_CANNOT_FIND_JSON_FILE); |
576 | 576 | |
577 | 577 | $content = file_get_contents($file); |
578 | - if(!$content) { |
|
578 | + if (!$content) { |
|
579 | 579 | throw new FileHelper_Exception( |
580 | 580 | 'Cannot get file contents', |
581 | 581 | sprintf( |
@@ -586,12 +586,12 @@ discard block |
||
586 | 586 | ); |
587 | 587 | } |
588 | 588 | |
589 | - if(isset($targetEncoding)) { |
|
589 | + if (isset($targetEncoding)) { |
|
590 | 590 | $content = mb_convert_encoding($content, $targetEncoding, $sourceEncoding); |
591 | 591 | } |
592 | 592 | |
593 | 593 | $json = json_decode($content, true); |
594 | - if($json === false || $json === NULL) { |
|
594 | + if ($json === false || $json === NULL) { |
|
595 | 595 | throw new FileHelper_Exception( |
596 | 596 | 'Cannot decode json data', |
597 | 597 | sprintf( |
@@ -631,13 +631,13 @@ discard block |
||
631 | 631 | |
632 | 632 | $name = str_replace(array_keys($replaces), array_values($replaces), $name); |
633 | 633 | |
634 | - while(strstr($name, ' ')) { |
|
634 | + while (strstr($name, ' ')) { |
|
635 | 635 | $name = str_replace(' ', ' ', $name); |
636 | 636 | } |
637 | 637 | |
638 | 638 | $name = str_replace(array_keys($replaces), array_values($replaces), $name); |
639 | 639 | |
640 | - while(strstr($name, '..')) { |
|
640 | + while (strstr($name, '..')) { |
|
641 | 641 | $name = str_replace('..', '.', $name); |
642 | 642 | } |
643 | 643 | |
@@ -669,7 +669,7 @@ discard block |
||
669 | 669 | * @return array An indexed array with files. |
670 | 670 | * @see FileHelper::createFileFinder() |
671 | 671 | */ |
672 | - public static function findHTMLFiles(string $targetFolder, array $options=array()) : array |
|
672 | + public static function findHTMLFiles(string $targetFolder, array $options = array()) : array |
|
673 | 673 | { |
674 | 674 | return self::findFiles($targetFolder, array('html'), $options); |
675 | 675 | } |
@@ -686,7 +686,7 @@ discard block |
||
686 | 686 | * @return array An indexed array of PHP files. |
687 | 687 | * @see FileHelper::createFileFinder() |
688 | 688 | */ |
689 | - public static function findPHPFiles(string $targetFolder, array $options=array()) : array |
|
689 | + public static function findPHPFiles(string $targetFolder, array $options = array()) : array |
|
690 | 690 | { |
691 | 691 | return self::findFiles($targetFolder, array('php'), $options); |
692 | 692 | } |
@@ -706,22 +706,22 @@ discard block |
||
706 | 706 | * @return array |
707 | 707 | * @see FileHelper::createFileFinder() |
708 | 708 | */ |
709 | - public static function findFiles(string $targetFolder, array $extensions=array(), array $options=array(), array $files=array()) : array |
|
709 | + public static function findFiles(string $targetFolder, array $extensions = array(), array $options = array(), array $files = array()) : array |
|
710 | 710 | { |
711 | 711 | $finder = self::createFileFinder($targetFolder); |
712 | 712 | |
713 | 713 | $finder->setPathmodeStrip(); |
714 | 714 | |
715 | - if(isset($options['relative-path']) && $options['relative-path'] === true) |
|
715 | + if (isset($options['relative-path']) && $options['relative-path'] === true) |
|
716 | 716 | { |
717 | 717 | $finder->setPathmodeRelative(); |
718 | 718 | } |
719 | - else if(isset($options['absolute-path']) && $options['absolute-path'] === true) |
|
719 | + else if (isset($options['absolute-path']) && $options['absolute-path'] === true) |
|
720 | 720 | { |
721 | 721 | $finder->setPathmodeAbsolute(); |
722 | 722 | } |
723 | 723 | |
724 | - if(isset($options['strip-extension'])) |
|
724 | + if (isset($options['strip-extension'])) |
|
725 | 725 | { |
726 | 726 | $finder->stripExtensions(); |
727 | 727 | } |
@@ -739,12 +739,12 @@ discard block |
||
739 | 739 | * @param bool $keepPath Whether to keep the path component, if any. Default PHP pathinfo behavior is not to. |
740 | 740 | * @return string |
741 | 741 | */ |
742 | - public static function removeExtension(string $filename, bool $keepPath=false) : string |
|
742 | + public static function removeExtension(string $filename, bool $keepPath = false) : string |
|
743 | 743 | { |
744 | 744 | // normalize paths to allow windows style slashes even on nix servers |
745 | 745 | $filename = self::normalizePath($filename); |
746 | 746 | |
747 | - if(!$keepPath) |
|
747 | + if (!$keepPath) |
|
748 | 748 | { |
749 | 749 | return pathinfo($filename, PATHINFO_FILENAME); |
750 | 750 | } |
@@ -777,7 +777,7 @@ discard block |
||
777 | 777 | public static function detectUTFBom(string $filename) : ?string |
778 | 778 | { |
779 | 779 | $fp = fopen($filename, 'r'); |
780 | - if($fp === false) |
|
780 | + if ($fp === false) |
|
781 | 781 | { |
782 | 782 | throw new FileHelper_Exception( |
783 | 783 | 'Cannot open file for reading', |
@@ -792,10 +792,10 @@ discard block |
||
792 | 792 | |
793 | 793 | $boms = self::getUTFBOMs(); |
794 | 794 | |
795 | - foreach($boms as $bom => $value) |
|
795 | + foreach ($boms as $bom => $value) |
|
796 | 796 | { |
797 | 797 | $length = mb_strlen($value); |
798 | - if(mb_substr($text, 0, $length) == $value) { |
|
798 | + if (mb_substr($text, 0, $length) == $value) { |
|
799 | 799 | return $bom; |
800 | 800 | } |
801 | 801 | } |
@@ -814,13 +814,13 @@ discard block |
||
814 | 814 | */ |
815 | 815 | public static function getUTFBOMs() |
816 | 816 | { |
817 | - if(!isset(self::$utfBoms)) { |
|
817 | + if (!isset(self::$utfBoms)) { |
|
818 | 818 | self::$utfBoms = array( |
819 | - 'UTF32-BE' => chr(0x00) . chr(0x00) . chr(0xFE) . chr(0xFF), |
|
820 | - 'UTF32-LE' => chr(0xFF) . chr(0xFE) . chr(0x00) . chr(0x00), |
|
821 | - 'UTF16-BE' => chr(0xFE) . chr(0xFF), |
|
822 | - 'UTF16-LE' => chr(0xFF) . chr(0xFE), |
|
823 | - 'UTF8' => chr(0xEF) . chr(0xBB) . chr(0xBF) |
|
819 | + 'UTF32-BE' => chr(0x00).chr(0x00).chr(0xFE).chr(0xFF), |
|
820 | + 'UTF32-LE' => chr(0xFF).chr(0xFE).chr(0x00).chr(0x00), |
|
821 | + 'UTF16-BE' => chr(0xFE).chr(0xFF), |
|
822 | + 'UTF16-LE' => chr(0xFF).chr(0xFE), |
|
823 | + 'UTF8' => chr(0xEF).chr(0xBB).chr(0xBF) |
|
824 | 824 | ); |
825 | 825 | } |
826 | 826 | |
@@ -841,7 +841,7 @@ discard block |
||
841 | 841 | $encodings = self::getKnownUnicodeEncodings(); |
842 | 842 | |
843 | 843 | $keep = array(); |
844 | - foreach($encodings as $string) |
|
844 | + foreach ($encodings as $string) |
|
845 | 845 | { |
846 | 846 | $withHyphen = str_replace('UTF', 'UTF-', $string); |
847 | 847 | |
@@ -888,16 +888,16 @@ discard block |
||
888 | 888 | * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
889 | 889 | * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
890 | 890 | */ |
891 | - public static function saveAsJSON($data, string $file, bool $pretty=false) |
|
891 | + public static function saveAsJSON($data, string $file, bool $pretty = false) |
|
892 | 892 | { |
893 | 893 | $options = null; |
894 | - if($pretty) { |
|
894 | + if ($pretty) { |
|
895 | 895 | $options = JSON_PRETTY_PRINT; |
896 | 896 | } |
897 | 897 | |
898 | 898 | $json = json_encode($data, $options); |
899 | 899 | |
900 | - if($json===false) |
|
900 | + if ($json === false) |
|
901 | 901 | { |
902 | 902 | $errorCode = json_last_error(); |
903 | 903 | |
@@ -923,14 +923,14 @@ discard block |
||
923 | 923 | * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
924 | 924 | * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
925 | 925 | */ |
926 | - public static function saveFile(string $filePath, string $content='') : void |
|
926 | + public static function saveFile(string $filePath, string $content = '') : void |
|
927 | 927 | { |
928 | 928 | $filePath = self::normalizePath($filePath); |
929 | 929 | |
930 | 930 | // target file already exists |
931 | - if(file_exists($filePath)) |
|
931 | + if (file_exists($filePath)) |
|
932 | 932 | { |
933 | - if(!is_writable($filePath)) |
|
933 | + if (!is_writable($filePath)) |
|
934 | 934 | { |
935 | 935 | throw new FileHelper_Exception( |
936 | 936 | sprintf('Cannot save file: target file [%s] exists, but is not writable.', basename($filePath)), |
@@ -950,7 +950,7 @@ discard block |
||
950 | 950 | // create the folder as needed |
951 | 951 | self::createFolder($targetFolder); |
952 | 952 | |
953 | - if(!is_writable($targetFolder)) |
|
953 | + if (!is_writable($targetFolder)) |
|
954 | 954 | { |
955 | 955 | throw new FileHelper_Exception( |
956 | 956 | sprintf('Cannot save file: target folder [%s] is not writable.', basename($targetFolder)), |
@@ -963,7 +963,7 @@ discard block |
||
963 | 963 | } |
964 | 964 | } |
965 | 965 | |
966 | - if(is_dir($filePath)) |
|
966 | + if (is_dir($filePath)) |
|
967 | 967 | { |
968 | 968 | throw new FileHelper_Exception( |
969 | 969 | sprintf('Cannot save file: the target [%s] is a directory.', basename($filePath)), |
@@ -975,7 +975,7 @@ discard block |
||
975 | 975 | ); |
976 | 976 | } |
977 | 977 | |
978 | - if(file_put_contents($filePath, $content) !== false) { |
|
978 | + if (file_put_contents($filePath, $content) !== false) { |
|
979 | 979 | return; |
980 | 980 | } |
981 | 981 | |
@@ -1014,7 +1014,7 @@ discard block |
||
1014 | 1014 | { |
1015 | 1015 | static $checked = array(); |
1016 | 1016 | |
1017 | - if(isset($checked[$command])) { |
|
1017 | + if (isset($checked[$command])) { |
|
1018 | 1018 | return $checked[$command]; |
1019 | 1019 | } |
1020 | 1020 | |
@@ -1027,7 +1027,7 @@ discard block |
||
1027 | 1027 | |
1028 | 1028 | $os = strtolower(PHP_OS_FAMILY); |
1029 | 1029 | |
1030 | - if(!isset($osCommands[$os])) |
|
1030 | + if (!isset($osCommands[$os])) |
|
1031 | 1031 | { |
1032 | 1032 | throw new FileHelper_Exception( |
1033 | 1033 | 'Unsupported OS for CLI commands', |
@@ -1053,7 +1053,7 @@ discard block |
||
1053 | 1053 | $pipes |
1054 | 1054 | ); |
1055 | 1055 | |
1056 | - if($process === false) { |
|
1056 | + if ($process === false) { |
|
1057 | 1057 | $checked[$command] = false; |
1058 | 1058 | return false; |
1059 | 1059 | } |
@@ -1084,7 +1084,7 @@ discard block |
||
1084 | 1084 | */ |
1085 | 1085 | public static function checkPHPFileSyntax($path) |
1086 | 1086 | { |
1087 | - if(!self::canMakePHPCalls()) { |
|
1087 | + if (!self::canMakePHPCalls()) { |
|
1088 | 1088 | return true; |
1089 | 1089 | } |
1090 | 1090 | |
@@ -1095,7 +1095,7 @@ discard block |
||
1095 | 1095 | // when the validation is successful, the first entry |
1096 | 1096 | // in the array contains the success message. When it |
1097 | 1097 | // is invalid, the first entry is always empty. |
1098 | - if(!empty($output[0])) { |
|
1098 | + if (!empty($output[0])) { |
|
1099 | 1099 | return true; |
1100 | 1100 | } |
1101 | 1101 | |
@@ -1116,7 +1116,7 @@ discard block |
||
1116 | 1116 | public static function getModifiedDate($path) |
1117 | 1117 | { |
1118 | 1118 | $time = filemtime($path); |
1119 | - if($time !== false) { |
|
1119 | + if ($time !== false) { |
|
1120 | 1120 | $date = new \DateTime(); |
1121 | 1121 | $date->setTimestamp($time); |
1122 | 1122 | return $date; |
@@ -1145,7 +1145,7 @@ discard block |
||
1145 | 1145 | */ |
1146 | 1146 | public static function getSubfolders($targetFolder, $options = array()) |
1147 | 1147 | { |
1148 | - if(!is_dir($targetFolder)) |
|
1148 | + if (!is_dir($targetFolder)) |
|
1149 | 1149 | { |
1150 | 1150 | throw new FileHelper_Exception( |
1151 | 1151 | 'Target folder does not exist', |
@@ -1169,29 +1169,29 @@ discard block |
||
1169 | 1169 | |
1170 | 1170 | $d = new \DirectoryIterator($targetFolder); |
1171 | 1171 | |
1172 | - foreach($d as $item) |
|
1172 | + foreach ($d as $item) |
|
1173 | 1173 | { |
1174 | - if($item->isDir() && !$item->isDot()) |
|
1174 | + if ($item->isDir() && !$item->isDot()) |
|
1175 | 1175 | { |
1176 | 1176 | $name = $item->getFilename(); |
1177 | 1177 | |
1178 | - if(!$options['absolute-path']) { |
|
1178 | + if (!$options['absolute-path']) { |
|
1179 | 1179 | $result[] = $name; |
1180 | 1180 | } else { |
1181 | 1181 | $result[] = $targetFolder.'/'.$name; |
1182 | 1182 | } |
1183 | 1183 | |
1184 | - if(!$options['recursive']) |
|
1184 | + if (!$options['recursive']) |
|
1185 | 1185 | { |
1186 | 1186 | continue; |
1187 | 1187 | } |
1188 | 1188 | |
1189 | 1189 | $subs = self::getSubfolders($targetFolder.'/'.$name, $options); |
1190 | - foreach($subs as $sub) |
|
1190 | + foreach ($subs as $sub) |
|
1191 | 1191 | { |
1192 | 1192 | $relative = $name.'/'.$sub; |
1193 | 1193 | |
1194 | - if(!$options['absolute-path']) { |
|
1194 | + if (!$options['absolute-path']) { |
|
1195 | 1195 | $result[] = $relative; |
1196 | 1196 | } else { |
1197 | 1197 | $result[] = $targetFolder.'/'.$relative; |
@@ -1241,7 +1241,7 @@ discard block |
||
1241 | 1241 | $unit = preg_replace('/[^bkmgtpezy]/i', '', $size); // Remove the non-unit characters from the size. |
1242 | 1242 | $size = floatval(preg_replace('/[^0-9\.]/', '', $size)); // Remove the non-numeric characters from the size. |
1243 | 1243 | |
1244 | - if($unit) |
|
1244 | + if ($unit) |
|
1245 | 1245 | { |
1246 | 1246 | // Find the position of the unit in the ordered string which is the power of magnitude to multiply a kilobyte by. |
1247 | 1247 | return round($size * pow(1024, stripos('bkmgtpezy', $unit[0]))); |
@@ -1260,7 +1260,7 @@ discard block |
||
1260 | 1260 | * @param int $depth The folder depth to reduce the path to |
1261 | 1261 | * @return string |
1262 | 1262 | */ |
1263 | - public static function relativizePathByDepth(string $path, int $depth=2) : string |
|
1263 | + public static function relativizePathByDepth(string $path, int $depth = 2) : string |
|
1264 | 1264 | { |
1265 | 1265 | $path = self::normalizePath($path); |
1266 | 1266 | |
@@ -1268,17 +1268,17 @@ discard block |
||
1268 | 1268 | $tokens = array_filter($tokens); // remove empty entries (trailing slash for example) |
1269 | 1269 | $tokens = array_values($tokens); // re-index keys |
1270 | 1270 | |
1271 | - if(empty($tokens)) { |
|
1271 | + if (empty($tokens)) { |
|
1272 | 1272 | return ''; |
1273 | 1273 | } |
1274 | 1274 | |
1275 | 1275 | // remove the drive if present |
1276 | - if(strstr($tokens[0], ':')) { |
|
1276 | + if (strstr($tokens[0], ':')) { |
|
1277 | 1277 | array_shift($tokens); |
1278 | 1278 | } |
1279 | 1279 | |
1280 | 1280 | // path was only the drive |
1281 | - if(count($tokens) == 0) { |
|
1281 | + if (count($tokens) == 0) { |
|
1282 | 1282 | return ''; |
1283 | 1283 | } |
1284 | 1284 | |
@@ -1287,8 +1287,8 @@ discard block |
||
1287 | 1287 | |
1288 | 1288 | // reduce the path to the specified depth |
1289 | 1289 | $length = count($tokens); |
1290 | - if($length > $depth) { |
|
1291 | - $tokens = array_slice($tokens, $length-$depth); |
|
1290 | + if ($length > $depth) { |
|
1291 | + $tokens = array_slice($tokens, $length - $depth); |
|
1292 | 1292 | } |
1293 | 1293 | |
1294 | 1294 | // append the last element again |
@@ -1336,14 +1336,14 @@ discard block |
||
1336 | 1336 | * |
1337 | 1337 | * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
1338 | 1338 | */ |
1339 | - public static function requireFileExists(string $path, ?int $errorCode=null) : string |
|
1339 | + public static function requireFileExists(string $path, ?int $errorCode = null) : string |
|
1340 | 1340 | { |
1341 | 1341 | $result = realpath($path); |
1342 | - if($result !== false) { |
|
1342 | + if ($result !== false) { |
|
1343 | 1343 | return $result; |
1344 | 1344 | } |
1345 | 1345 | |
1346 | - if($errorCode === null) { |
|
1346 | + if ($errorCode === null) { |
|
1347 | 1347 | $errorCode = self::ERROR_FILE_DOES_NOT_EXIST; |
1348 | 1348 | } |
1349 | 1349 | |
@@ -1354,15 +1354,15 @@ discard block |
||
1354 | 1354 | ); |
1355 | 1355 | } |
1356 | 1356 | |
1357 | - public static function requireFileReadable(string $path, ?int $errorCode=null) : string |
|
1357 | + public static function requireFileReadable(string $path, ?int $errorCode = null) : string |
|
1358 | 1358 | { |
1359 | 1359 | $path = self::requireFileExists($path, $errorCode); |
1360 | 1360 | |
1361 | - if(is_readable($path)) { |
|
1361 | + if (is_readable($path)) { |
|
1362 | 1362 | return $path; |
1363 | 1363 | } |
1364 | 1364 | |
1365 | - if($errorCode === null) { |
|
1365 | + if ($errorCode === null) { |
|
1366 | 1366 | $errorCode = self::ERROR_FILE_NOT_READABLE; |
1367 | 1367 | } |
1368 | 1368 | |
@@ -1391,15 +1391,15 @@ discard block |
||
1391 | 1391 | |
1392 | 1392 | $file = new \SplFileObject($path); |
1393 | 1393 | |
1394 | - if($file->eof()) { |
|
1394 | + if ($file->eof()) { |
|
1395 | 1395 | return ''; |
1396 | 1396 | } |
1397 | 1397 | |
1398 | - $targetLine = $lineNumber-1; |
|
1398 | + $targetLine = $lineNumber - 1; |
|
1399 | 1399 | |
1400 | 1400 | $file->seek($targetLine); |
1401 | 1401 | |
1402 | - if($file->key() !== $targetLine) { |
|
1402 | + if ($file->key() !== $targetLine) { |
|
1403 | 1403 | return null; |
1404 | 1404 | } |
1405 | 1405 | |
@@ -1425,7 +1425,7 @@ discard block |
||
1425 | 1425 | $number = $spl->key(); |
1426 | 1426 | |
1427 | 1427 | // if seeking to the end the cursor is still at 0, there are no lines. |
1428 | - if($number === 0) |
|
1428 | + if ($number === 0) |
|
1429 | 1429 | { |
1430 | 1430 | // since it's a very small file, to get reliable results, |
1431 | 1431 | // we read its contents and use that to determine what |
@@ -1433,13 +1433,13 @@ discard block |
||
1433 | 1433 | // that this is not pactical to solve with the SplFileObject. |
1434 | 1434 | $content = file_get_contents($path); |
1435 | 1435 | |
1436 | - if(empty($content)) { |
|
1436 | + if (empty($content)) { |
|
1437 | 1437 | return 0; |
1438 | 1438 | } |
1439 | 1439 | } |
1440 | 1440 | |
1441 | 1441 | // return the line number we were able to reach + 1 (key is zero-based) |
1442 | - return $number+1; |
|
1442 | + return $number + 1; |
|
1443 | 1443 | } |
1444 | 1444 | |
1445 | 1445 | /** |
@@ -1486,13 +1486,13 @@ discard block |
||
1486 | 1486 | * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES |
1487 | 1487 | * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
1488 | 1488 | */ |
1489 | - public static function readLines(string $filePath, int $amount=0) : array |
|
1489 | + public static function readLines(string $filePath, int $amount = 0) : array |
|
1490 | 1490 | { |
1491 | 1491 | self::requireFileExists($filePath); |
1492 | 1492 | |
1493 | 1493 | $fn = fopen($filePath, "r"); |
1494 | 1494 | |
1495 | - if($fn === false) |
|
1495 | + if ($fn === false) |
|
1496 | 1496 | { |
1497 | 1497 | throw new FileHelper_Exception( |
1498 | 1498 | 'Could not open file for reading.', |
@@ -1508,19 +1508,19 @@ discard block |
||
1508 | 1508 | $counter = 0; |
1509 | 1509 | $first = true; |
1510 | 1510 | |
1511 | - while(!feof($fn)) |
|
1511 | + while (!feof($fn)) |
|
1512 | 1512 | { |
1513 | 1513 | $counter++; |
1514 | 1514 | |
1515 | 1515 | $line = fgets($fn); |
1516 | 1516 | |
1517 | 1517 | // can happen with zero length files |
1518 | - if($line === false) { |
|
1518 | + if ($line === false) { |
|
1519 | 1519 | continue; |
1520 | 1520 | } |
1521 | 1521 | |
1522 | 1522 | // the first line may contain a unicode BOM marker. |
1523 | - if($first) |
|
1523 | + if ($first) |
|
1524 | 1524 | { |
1525 | 1525 | $line = ConvertHelper::stripUTFBom($line); |
1526 | 1526 | $first = false; |
@@ -1528,7 +1528,7 @@ discard block |
||
1528 | 1528 | |
1529 | 1529 | $result[] = $line; |
1530 | 1530 | |
1531 | - if($amount > 0 && $counter == $amount) { |
|
1531 | + if ($amount > 0 && $counter == $amount) { |
|
1532 | 1532 | break; |
1533 | 1533 | } |
1534 | 1534 | } |
@@ -1554,7 +1554,7 @@ discard block |
||
1554 | 1554 | |
1555 | 1555 | $result = file_get_contents($filePath); |
1556 | 1556 | |
1557 | - if($result !== false) { |
|
1557 | + if ($result !== false) { |
|
1558 | 1558 | return $result; |
1559 | 1559 | } |
1560 | 1560 | |
@@ -1584,7 +1584,7 @@ discard block |
||
1584 | 1584 | { |
1585 | 1585 | $actual = realpath($path); |
1586 | 1586 | |
1587 | - if($actual === false) |
|
1587 | + if ($actual === false) |
|
1588 | 1588 | { |
1589 | 1589 | throw new FileHelper_Exception( |
1590 | 1590 | 'Folder does not exist', |
@@ -1596,7 +1596,7 @@ discard block |
||
1596 | 1596 | ); |
1597 | 1597 | } |
1598 | 1598 | |
1599 | - if(is_dir($path)) |
|
1599 | + if (is_dir($path)) |
|
1600 | 1600 | { |
1601 | 1601 | return self::normalizePath($actual); |
1602 | 1602 | } |
@@ -1618,7 +1618,7 @@ discard block |
||
1618 | 1618 | * @param string[] $paths |
1619 | 1619 | * @return FileHelper_PathsReducer |
1620 | 1620 | */ |
1621 | - public static function createPathsReducer(array $paths=array()) : FileHelper_PathsReducer |
|
1621 | + public static function createPathsReducer(array $paths = array()) : FileHelper_PathsReducer |
|
1622 | 1622 | { |
1623 | 1623 | return new FileHelper_PathsReducer(); |
1624 | 1624 | } |