@@ -40,7 +40,7 @@ discard block |
||
40 | 40 | */ |
41 | 41 | public function setTimeout(int $timeout) : FileDownloader |
42 | 42 | { |
43 | - if($timeout > 0) |
|
43 | + if ($timeout > 0) |
|
44 | 44 | { |
45 | 45 | $this->timeout = $timeout; |
46 | 46 | } |
@@ -52,7 +52,7 @@ discard block |
||
52 | 52 | * @param bool $enabled |
53 | 53 | * @return FileDownloader |
54 | 54 | */ |
55 | - public function setSSLEnabled(bool $enabled=true) : FileDownloader |
|
55 | + public function setSSLEnabled(bool $enabled = true) : FileDownloader |
|
56 | 56 | { |
57 | 57 | $this->SSLEnabled = $enabled; |
58 | 58 | return $this; |
@@ -73,7 +73,7 @@ discard block |
||
73 | 73 | |
74 | 74 | $output = curl_exec($ch); |
75 | 75 | |
76 | - if($output === false) |
|
76 | + if ($output === false) |
|
77 | 77 | { |
78 | 78 | throw new FileHelper_Exception( |
79 | 79 | 'Unable to open URL', |
@@ -88,7 +88,7 @@ discard block |
||
88 | 88 | |
89 | 89 | curl_close($ch); |
90 | 90 | |
91 | - if(is_string($output)) |
|
91 | + if (is_string($output)) |
|
92 | 92 | { |
93 | 93 | return $output; |
94 | 94 | } |
@@ -108,7 +108,7 @@ discard block |
||
108 | 108 | { |
109 | 109 | $ch = curl_init(); |
110 | 110 | |
111 | - if(!is_resource($ch)) |
|
111 | + if (!is_resource($ch)) |
|
112 | 112 | { |
113 | 113 | throw new FileHelper_Exception( |
114 | 114 | 'Could not initialize a new cURL instance.', |
@@ -125,7 +125,7 @@ discard block |
||
125 | 125 | curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); |
126 | 126 | curl_setopt($ch, CURLOPT_TIMEOUT, $this->timeout); |
127 | 127 | |
128 | - if(!$this->SSLEnabled) |
|
128 | + if (!$this->SSLEnabled) |
|
129 | 129 | { |
130 | 130 | curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0); |
131 | 131 | curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0); |
@@ -516,8 +516,7 @@ |
||
516 | 516 | if(isset($options['relative-path']) && $options['relative-path'] === true) |
517 | 517 | { |
518 | 518 | $finder->setPathmodeRelative(); |
519 | - } |
|
520 | - else if(isset($options['absolute-path']) && $options['absolute-path'] === true) |
|
519 | + } else if(isset($options['absolute-path']) && $options['absolute-path'] === true) |
|
521 | 520 | { |
522 | 521 | $finder->setPathmodeAbsolute(); |
523 | 522 | } |
@@ -73,18 +73,18 @@ discard block |
||
73 | 73 | public const ERROR_PATH_NOT_WRITABLE = 340039; |
74 | 74 | public const ERROR_PATH_INVALID = 340040; |
75 | 75 | |
76 | - /** |
|
77 | - * Opens a serialized file and returns the unserialized data. |
|
78 | - * |
|
79 | - * @param string|PathInfoInterface|SplFileInfo $file |
|
80 | - * @throws FileHelper_Exception |
|
81 | - * @return array<int|string,mixed> |
|
82 | - * @see SerializedFile::parse() |
|
83 | - * |
|
84 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
85 | - * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ |
|
86 | - * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED |
|
87 | - */ |
|
76 | + /** |
|
77 | + * Opens a serialized file and returns the unserialized data. |
|
78 | + * |
|
79 | + * @param string|PathInfoInterface|SplFileInfo $file |
|
80 | + * @throws FileHelper_Exception |
|
81 | + * @return array<int|string,mixed> |
|
82 | + * @see SerializedFile::parse() |
|
83 | + * |
|
84 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
85 | + * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ |
|
86 | + * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED |
|
87 | + */ |
|
88 | 88 | public static function parseSerializedFile($file) : array |
89 | 89 | { |
90 | 90 | return SerializedFile::factory($file)->parse(); |
@@ -103,13 +103,13 @@ discard block |
||
103 | 103 | return FolderTree::delete($rootFolder); |
104 | 104 | } |
105 | 105 | |
106 | - /** |
|
107 | - * Create a folder, if it does not exist yet. |
|
108 | - * |
|
109 | - * @param string|PathInfoInterface $path |
|
110 | - * @throws FileHelper_Exception |
|
111 | - * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER |
|
112 | - */ |
|
106 | + /** |
|
107 | + * Create a folder, if it does not exist yet. |
|
108 | + * |
|
109 | + * @param string|PathInfoInterface $path |
|
110 | + * @throws FileHelper_Exception |
|
111 | + * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER |
|
112 | + */ |
|
113 | 113 | public static function createFolder($path) : FolderInfo |
114 | 114 | { |
115 | 115 | return self::getFolderInfo($path)->create(); |
@@ -138,36 +138,36 @@ discard block |
||
138 | 138 | FolderTree::copy($source, $target); |
139 | 139 | } |
140 | 140 | |
141 | - /** |
|
142 | - * Copies a file to the target location. Includes checks |
|
143 | - * for most error sources, like the source file not being |
|
144 | - * readable. Automatically creates the target folder if it |
|
145 | - * does not exist yet. |
|
146 | - * |
|
147 | - * @param string|PathInfoInterface|SplFileInfo $sourcePath |
|
148 | - * @param string|PathInfoInterface|SplFileInfo $targetPath |
|
149 | - * @throws FileHelper_Exception |
|
150 | - * |
|
151 | - * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER |
|
152 | - * @see FileHelper::ERROR_SOURCE_FILE_NOT_FOUND |
|
153 | - * @see FileHelper::ERROR_SOURCE_FILE_NOT_READABLE |
|
154 | - * @see FileHelper::ERROR_TARGET_COPY_FOLDER_NOT_WRITABLE |
|
155 | - * @see FileHelper::ERROR_CANNOT_COPY_FILE |
|
156 | - */ |
|
141 | + /** |
|
142 | + * Copies a file to the target location. Includes checks |
|
143 | + * for most error sources, like the source file not being |
|
144 | + * readable. Automatically creates the target folder if it |
|
145 | + * does not exist yet. |
|
146 | + * |
|
147 | + * @param string|PathInfoInterface|SplFileInfo $sourcePath |
|
148 | + * @param string|PathInfoInterface|SplFileInfo $targetPath |
|
149 | + * @throws FileHelper_Exception |
|
150 | + * |
|
151 | + * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER |
|
152 | + * @see FileHelper::ERROR_SOURCE_FILE_NOT_FOUND |
|
153 | + * @see FileHelper::ERROR_SOURCE_FILE_NOT_READABLE |
|
154 | + * @see FileHelper::ERROR_TARGET_COPY_FOLDER_NOT_WRITABLE |
|
155 | + * @see FileHelper::ERROR_CANNOT_COPY_FILE |
|
156 | + */ |
|
157 | 157 | public static function copyFile($sourcePath, $targetPath) : void |
158 | 158 | { |
159 | 159 | self::getFileInfo($sourcePath)->copyTo($targetPath); |
160 | 160 | } |
161 | 161 | |
162 | - /** |
|
163 | - * Deletes the target file. Ignored if it cannot be found, |
|
164 | - * and throws an exception if it fails. |
|
165 | - * |
|
166 | - * @param string|PathInfoInterface|SplFileInfo $filePath |
|
167 | - * @throws FileHelper_Exception |
|
168 | - * |
|
169 | - * @see FileHelper::ERROR_CANNOT_DELETE_FILE |
|
170 | - */ |
|
162 | + /** |
|
163 | + * Deletes the target file. Ignored if it cannot be found, |
|
164 | + * and throws an exception if it fails. |
|
165 | + * |
|
166 | + * @param string|PathInfoInterface|SplFileInfo $filePath |
|
167 | + * @throws FileHelper_Exception |
|
168 | + * |
|
169 | + * @see FileHelper::ERROR_CANNOT_DELETE_FILE |
|
170 | + */ |
|
171 | 171 | public static function deleteFile($filePath) : void |
172 | 172 | { |
173 | 173 | self::getFileInfo($filePath)->delete(); |
@@ -288,7 +288,7 @@ discard block |
||
288 | 288 | */ |
289 | 289 | public static function isPHPFile($filePath) : bool |
290 | 290 | { |
291 | - return self::getExtension($filePath) === 'php'; |
|
291 | + return self::getExtension($filePath) === 'php'; |
|
292 | 292 | } |
293 | 293 | |
294 | 294 | /** |
@@ -354,16 +354,16 @@ discard block |
||
354 | 354 | ->parse(); |
355 | 355 | } |
356 | 356 | |
357 | - /** |
|
358 | - * Corrects common formatting mistakes when users enter |
|
359 | - * file names, like too many spaces, dots and the like. |
|
360 | - * |
|
361 | - * NOTE: if the file name contains a path, the path is |
|
362 | - * stripped, leaving only the file name. |
|
363 | - * |
|
364 | - * @param string $name |
|
365 | - * @return string |
|
366 | - */ |
|
357 | + /** |
|
358 | + * Corrects common formatting mistakes when users enter |
|
359 | + * file names, like too many spaces, dots and the like. |
|
360 | + * |
|
361 | + * NOTE: if the file name contains a path, the path is |
|
362 | + * stripped, leaving only the file name. |
|
363 | + * |
|
364 | + * @param string $name |
|
365 | + * @return string |
|
366 | + */ |
|
367 | 367 | public static function fixFileName(string $name) : string |
368 | 368 | { |
369 | 369 | return NameFixer::fixName($name); |
@@ -423,23 +423,23 @@ discard block |
||
423 | 423 | return self::findFiles($targetFolder, array('php'), $options); |
424 | 424 | } |
425 | 425 | |
426 | - /** |
|
427 | - * Finds files according to the specified options. |
|
428 | - * |
|
429 | - * NOTE: This method only exists for backwards compatibility. |
|
430 | - * Use the {@see FileHelper::createFileFinder()} method instead, |
|
431 | - * which offers an object-oriented interface that is much easier |
|
432 | - * to use. |
|
433 | - * |
|
434 | - * @param string|PathInfoInterface|SplFileInfo $targetFolder |
|
435 | - * @param string[] $extensions |
|
436 | - * @param array<string,mixed> $options |
|
437 | - * @throws FileHelper_Exception |
|
438 | - * @return string[] |
|
439 | - * |
|
440 | - * @see FileHelper::createFileFinder() |
|
441 | - * @deprecated Use the file finder instead. |
|
442 | - */ |
|
426 | + /** |
|
427 | + * Finds files according to the specified options. |
|
428 | + * |
|
429 | + * NOTE: This method only exists for backwards compatibility. |
|
430 | + * Use the {@see FileHelper::createFileFinder()} method instead, |
|
431 | + * which offers an object-oriented interface that is much easier |
|
432 | + * to use. |
|
433 | + * |
|
434 | + * @param string|PathInfoInterface|SplFileInfo $targetFolder |
|
435 | + * @param string[] $extensions |
|
436 | + * @param array<string,mixed> $options |
|
437 | + * @throws FileHelper_Exception |
|
438 | + * @return string[] |
|
439 | + * |
|
440 | + * @see FileHelper::createFileFinder() |
|
441 | + * @deprecated Use the file finder instead. |
|
442 | + */ |
|
443 | 443 | public static function findFiles($targetFolder, array $extensions=array(), array $options=array()) : array |
444 | 444 | { |
445 | 445 | $finder = self::createFileFinder($targetFolder); |
@@ -498,13 +498,13 @@ discard block |
||
498 | 498 | return self::$unicodeHandling; |
499 | 499 | } |
500 | 500 | |
501 | - /** |
|
502 | - * Normalizes the slash style in a file or folder path, |
|
503 | - * by replacing any anti-slashes with forward slashes. |
|
504 | - * |
|
505 | - * @param string $path |
|
506 | - * @return string |
|
507 | - */ |
|
501 | + /** |
|
502 | + * Normalizes the slash style in a file or folder path, |
|
503 | + * by replacing any anti-slashes with forward slashes. |
|
504 | + * |
|
505 | + * @param string $path |
|
506 | + * @return string |
|
507 | + */ |
|
508 | 508 | public static function normalizePath(string $path) : string |
509 | 509 | { |
510 | 510 | return str_replace(array('\\', '//'), array('/', '/'), $path); |
@@ -629,70 +629,70 @@ discard block |
||
629 | 629 | ->getPaths(); |
630 | 630 | } |
631 | 631 | |
632 | - /** |
|
633 | - * Retrieves the maximum allowed upload file size, in bytes. |
|
634 | - * Takes into account the PHP ini settings <code>post_max_size</code> |
|
635 | - * and <code>upload_max_filesize</code>. Since these cannot |
|
636 | - * be modified at runtime, they are the hard limits for uploads. |
|
637 | - * |
|
638 | - * NOTE: Based on binary values, where 1KB = 1024 Bytes. |
|
639 | - * |
|
640 | - * @return int Will return <code>-1</code> if no limit. |
|
641 | - */ |
|
632 | + /** |
|
633 | + * Retrieves the maximum allowed upload file size, in bytes. |
|
634 | + * Takes into account the PHP ini settings <code>post_max_size</code> |
|
635 | + * and <code>upload_max_filesize</code>. Since these cannot |
|
636 | + * be modified at runtime, they are the hard limits for uploads. |
|
637 | + * |
|
638 | + * NOTE: Based on binary values, where 1KB = 1024 Bytes. |
|
639 | + * |
|
640 | + * @return int Will return <code>-1</code> if no limit. |
|
641 | + */ |
|
642 | 642 | public static function getMaxUploadFilesize() : int |
643 | 643 | { |
644 | 644 | return UploadFileSizeInfo::getFileSize(); |
645 | 645 | } |
646 | 646 | |
647 | - /** |
|
648 | - * Makes a path relative using a folder depth: will reduce the |
|
649 | - * length of the path so that only the amount of folders defined |
|
650 | - * in the <code>$depth</code> attribute are shown below the actual |
|
651 | - * folder or file in the path. |
|
652 | - * |
|
653 | - * @param string $path The absolute or relative path |
|
654 | - * @param int $depth The folder depth to reduce the path to |
|
655 | - * @return string |
|
656 | - */ |
|
647 | + /** |
|
648 | + * Makes a path relative using a folder depth: will reduce the |
|
649 | + * length of the path so that only the amount of folders defined |
|
650 | + * in the <code>$depth</code> attribute are shown below the actual |
|
651 | + * folder or file in the path. |
|
652 | + * |
|
653 | + * @param string $path The absolute or relative path |
|
654 | + * @param int $depth The folder depth to reduce the path to |
|
655 | + * @return string |
|
656 | + */ |
|
657 | 657 | public static function relativizePathByDepth(string $path, int $depth=2) : string |
658 | 658 | { |
659 | 659 | return PathRelativizer::relativizeByDepth($path, $depth); |
660 | 660 | } |
661 | 661 | |
662 | - /** |
|
663 | - * Makes the specified path relative to another path, |
|
664 | - * by removing one from the other if found. Also |
|
665 | - * normalizes the path to use forward slashes. |
|
666 | - * |
|
667 | - * Example: |
|
668 | - * |
|
669 | - * <pre> |
|
670 | - * relativizePath('c:\some\folder\to\file.txt', 'c:\some\folder'); |
|
671 | - * </pre> |
|
672 | - * |
|
673 | - * Result: <code>to/file.txt</code> |
|
674 | - * |
|
675 | - * @param string $path |
|
676 | - * @param string $relativeTo |
|
677 | - * @return string |
|
678 | - */ |
|
662 | + /** |
|
663 | + * Makes the specified path relative to another path, |
|
664 | + * by removing one from the other if found. Also |
|
665 | + * normalizes the path to use forward slashes. |
|
666 | + * |
|
667 | + * Example: |
|
668 | + * |
|
669 | + * <pre> |
|
670 | + * relativizePath('c:\some\folder\to\file.txt', 'c:\some\folder'); |
|
671 | + * </pre> |
|
672 | + * |
|
673 | + * Result: <code>to/file.txt</code> |
|
674 | + * |
|
675 | + * @param string $path |
|
676 | + * @param string $relativeTo |
|
677 | + * @return string |
|
678 | + */ |
|
679 | 679 | public static function relativizePath(string $path, string $relativeTo) : string |
680 | 680 | { |
681 | 681 | return PathRelativizer::relativize($path, $relativeTo); |
682 | 682 | } |
683 | 683 | |
684 | - /** |
|
685 | - * Checks that the target file exists, and throws an exception |
|
686 | - * if it does not. |
|
687 | - * |
|
688 | - * @param string|SplFileInfo $path |
|
689 | - * @param int|NULL $errorCode Optional custom error code |
|
690 | - * @throws FileHelper_Exception |
|
691 | - * @return string The real path to the file |
|
692 | - * |
|
693 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
694 | - * @see FileHelper::ERROR_REAL_PATH_NOT_FOUND |
|
695 | - */ |
|
684 | + /** |
|
685 | + * Checks that the target file exists, and throws an exception |
|
686 | + * if it does not. |
|
687 | + * |
|
688 | + * @param string|SplFileInfo $path |
|
689 | + * @param int|NULL $errorCode Optional custom error code |
|
690 | + * @throws FileHelper_Exception |
|
691 | + * @return string The real path to the file |
|
692 | + * |
|
693 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
694 | + * @see FileHelper::ERROR_REAL_PATH_NOT_FOUND |
|
695 | + */ |
|
696 | 696 | public static function requireFileExists($path, ?int $errorCode=null) : string |
697 | 697 | { |
698 | 698 | return self::getPathInfo($path) |
@@ -715,18 +715,18 @@ discard block |
||
715 | 715 | ->getPath(); |
716 | 716 | } |
717 | 717 | |
718 | - /** |
|
719 | - * Reads a specific line number from the target file and returns its |
|
720 | - * contents, if the file has such a line. Does so with little memory |
|
721 | - * usage, as the file is not read entirely into memory. |
|
722 | - * |
|
723 | - * @param string|PathInfoInterface|SplFileInfo $path |
|
724 | - * @param int $lineNumber Note: 1-based; the first line is number 1. |
|
725 | - * @return string|NULL Will return null if the requested line does not exist. |
|
726 | - * @throws FileHelper_Exception |
|
727 | - * |
|
728 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
729 | - */ |
|
718 | + /** |
|
719 | + * Reads a specific line number from the target file and returns its |
|
720 | + * contents, if the file has such a line. Does so with little memory |
|
721 | + * usage, as the file is not read entirely into memory. |
|
722 | + * |
|
723 | + * @param string|PathInfoInterface|SplFileInfo $path |
|
724 | + * @param int $lineNumber Note: 1-based; the first line is number 1. |
|
725 | + * @return string|NULL Will return null if the requested line does not exist. |
|
726 | + * @throws FileHelper_Exception |
|
727 | + * |
|
728 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
729 | + */ |
|
730 | 730 | public static function getLineFromFile($path, int $lineNumber) : ?string |
731 | 731 | { |
732 | 732 | return self::getFileInfo($path)->getLine($lineNumber); |
@@ -792,33 +792,33 @@ discard block |
||
792 | 792 | ->getLines($amount); |
793 | 793 | } |
794 | 794 | |
795 | - /** |
|
796 | - * Reads all content from a file. |
|
797 | - * |
|
798 | - * @param string|PathInfoInterface|SplFileInfo $filePath |
|
799 | - * @throws FileHelper_Exception |
|
800 | - * @return string |
|
801 | - * |
|
802 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
803 | - * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS |
|
804 | - */ |
|
795 | + /** |
|
796 | + * Reads all content from a file. |
|
797 | + * |
|
798 | + * @param string|PathInfoInterface|SplFileInfo $filePath |
|
799 | + * @throws FileHelper_Exception |
|
800 | + * @return string |
|
801 | + * |
|
802 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
803 | + * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS |
|
804 | + */ |
|
805 | 805 | public static function readContents($filePath) : string |
806 | 806 | { |
807 | 807 | return self::getFileInfo($filePath)->getContents(); |
808 | 808 | } |
809 | 809 | |
810 | - /** |
|
811 | - * Ensures that the target path exists on disk, and is a folder. |
|
812 | - * |
|
813 | - * @param string|PathInfoInterface|SplFileInfo $path |
|
814 | - * @return string The real path, with normalized slashes. |
|
815 | - * @throws FileHelper_Exception |
|
816 | - * |
|
817 | - * @see FileHelper::normalizePath() |
|
818 | - * |
|
819 | - * @see FileHelper::ERROR_FOLDER_DOES_NOT_EXIST |
|
820 | - * @see FileHelper::ERROR_PATH_IS_NOT_A_FOLDER |
|
821 | - */ |
|
810 | + /** |
|
811 | + * Ensures that the target path exists on disk, and is a folder. |
|
812 | + * |
|
813 | + * @param string|PathInfoInterface|SplFileInfo $path |
|
814 | + * @return string The real path, with normalized slashes. |
|
815 | + * @throws FileHelper_Exception |
|
816 | + * |
|
817 | + * @see FileHelper::normalizePath() |
|
818 | + * |
|
819 | + * @see FileHelper::ERROR_FOLDER_DOES_NOT_EXIST |
|
820 | + * @see FileHelper::ERROR_PATH_IS_NOT_A_FOLDER |
|
821 | + */ |
|
822 | 822 | public static function requireFolderExists($path) : string |
823 | 823 | { |
824 | 824 | return self::getFolderInfo($path) |
@@ -208,7 +208,7 @@ discard block |
||
208 | 208 | public static function detectMimeType($fileName) : ?string |
209 | 209 | { |
210 | 210 | $ext = self::getExtension($fileName); |
211 | - if(empty($ext)) { |
|
211 | + if (empty($ext)) { |
|
212 | 212 | return null; |
213 | 213 | } |
214 | 214 | |
@@ -252,7 +252,7 @@ discard block |
||
252 | 252 | * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
253 | 253 | * @see FileHelper::ERROR_UNKNOWN_FILE_MIME_TYPE |
254 | 254 | */ |
255 | - public static function sendFile($filePath, ?string $fileName = null, bool $asAttachment=true) : void |
|
255 | + public static function sendFile($filePath, ?string $fileName = null, bool $asAttachment = true) : void |
|
256 | 256 | { |
257 | 257 | self::getFileInfo($filePath)->getDownloader()->send($fileName, $asAttachment); |
258 | 258 | } |
@@ -269,7 +269,7 @@ discard block |
||
269 | 269 | * @throws FileHelper_Exception |
270 | 270 | * @see FileHelper::ERROR_CANNOT_OPEN_URL |
271 | 271 | */ |
272 | - public static function downloadFile(string $url, int $timeout=0, bool $SSLEnabled=false) : string |
|
272 | + public static function downloadFile(string $url, int $timeout = 0, bool $SSLEnabled = false) : string |
|
273 | 273 | { |
274 | 274 | return FileDownloader::factory($url) |
275 | 275 | ->setTimeout($timeout) |
@@ -324,7 +324,7 @@ discard block |
||
324 | 324 | { |
325 | 325 | $info = self::getPathInfo($pathOrDirIterator); |
326 | 326 | |
327 | - if($extension === true || $info instanceof FolderInfo) |
|
327 | + if ($extension === true || $info instanceof FolderInfo) |
|
328 | 328 | { |
329 | 329 | return $info->getName(); |
330 | 330 | } |
@@ -346,7 +346,7 @@ discard block |
||
346 | 346 | * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE |
347 | 347 | * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE |
348 | 348 | */ |
349 | - public static function parseJSONFile($file, string $targetEncoding='', $sourceEncoding=null) : array |
|
349 | + public static function parseJSONFile($file, string $targetEncoding = '', $sourceEncoding = null) : array |
|
350 | 350 | { |
351 | 351 | return JSONFile::factory($file) |
352 | 352 | ->setTargetEncoding($targetEncoding) |
@@ -399,7 +399,7 @@ discard block |
||
399 | 399 | * @throws FileHelper_Exception |
400 | 400 | * @see FileHelper::createFileFinder() |
401 | 401 | */ |
402 | - public static function findHTMLFiles($targetFolder, array $options=array()) : array |
|
402 | + public static function findHTMLFiles($targetFolder, array $options = array()) : array |
|
403 | 403 | { |
404 | 404 | return self::findFiles($targetFolder, array('html'), $options); |
405 | 405 | } |
@@ -418,7 +418,7 @@ discard block |
||
418 | 418 | * @throws FileHelper_Exception |
419 | 419 | * @see FileHelper::createFileFinder() |
420 | 420 | */ |
421 | - public static function findPHPFiles($targetFolder, array $options=array()) : array |
|
421 | + public static function findPHPFiles($targetFolder, array $options = array()) : array |
|
422 | 422 | { |
423 | 423 | return self::findFiles($targetFolder, array('php'), $options); |
424 | 424 | } |
@@ -440,7 +440,7 @@ discard block |
||
440 | 440 | * @see FileHelper::createFileFinder() |
441 | 441 | * @deprecated Use the file finder instead. |
442 | 442 | */ |
443 | - public static function findFiles($targetFolder, array $extensions=array(), array $options=array()) : array |
|
443 | + public static function findFiles($targetFolder, array $extensions = array(), array $options = array()) : array |
|
444 | 444 | { |
445 | 445 | $finder = self::createFileFinder($targetFolder); |
446 | 446 | |
@@ -450,16 +450,16 @@ discard block |
||
450 | 450 | |
451 | 451 | $finder->setPathmodeStrip(); |
452 | 452 | |
453 | - if(isset($options['relative-path']) && $options['relative-path'] === true) |
|
453 | + if (isset($options['relative-path']) && $options['relative-path'] === true) |
|
454 | 454 | { |
455 | 455 | $finder->setPathmodeRelative(); |
456 | 456 | } |
457 | - else if(isset($options['absolute-path']) && $options['absolute-path'] === true) |
|
457 | + else if (isset($options['absolute-path']) && $options['absolute-path'] === true) |
|
458 | 458 | { |
459 | 459 | $finder->setPathmodeAbsolute(); |
460 | 460 | } |
461 | 461 | |
462 | - if(isset($options['strip-extension'])) |
|
462 | + if (isset($options['strip-extension'])) |
|
463 | 463 | { |
464 | 464 | $finder->stripExtensions(); |
465 | 465 | } |
@@ -478,7 +478,7 @@ discard block |
||
478 | 478 | * @return string |
479 | 479 | * @throws FileHelper_Exception |
480 | 480 | */ |
481 | - public static function removeExtension($filename, bool $keepPath=false) : string |
|
481 | + public static function removeExtension($filename, bool $keepPath = false) : string |
|
482 | 482 | { |
483 | 483 | return self::getFileInfo($filename)->removeExtension($keepPath); |
484 | 484 | } |
@@ -490,7 +490,7 @@ discard block |
||
490 | 490 | |
491 | 491 | public static function createUnicodeHandling() : UnicodeHandling |
492 | 492 | { |
493 | - if(!isset(self::$unicodeHandling)) |
|
493 | + if (!isset(self::$unicodeHandling)) |
|
494 | 494 | { |
495 | 495 | self::$unicodeHandling = new UnicodeHandling(); |
496 | 496 | } |
@@ -524,7 +524,7 @@ discard block |
||
524 | 524 | * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
525 | 525 | * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
526 | 526 | */ |
527 | - public static function saveAsJSON($data, $file, bool $pretty=false) : JSONFile |
|
527 | + public static function saveAsJSON($data, $file, bool $pretty = false) : JSONFile |
|
528 | 528 | { |
529 | 529 | return JSONFile::factory($file)->putData($data, $pretty); |
530 | 530 | } |
@@ -542,7 +542,7 @@ discard block |
||
542 | 542 | * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
543 | 543 | * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
544 | 544 | */ |
545 | - public static function saveFile($filePath, string $content='') : FileInfo |
|
545 | + public static function saveFile($filePath, string $content = '') : FileInfo |
|
546 | 546 | { |
547 | 547 | return self::getFileInfo($filePath)->putContents($content); |
548 | 548 | } |
@@ -654,7 +654,7 @@ discard block |
||
654 | 654 | * @param int $depth The folder depth to reduce the path to |
655 | 655 | * @return string |
656 | 656 | */ |
657 | - public static function relativizePathByDepth(string $path, int $depth=2) : string |
|
657 | + public static function relativizePathByDepth(string $path, int $depth = 2) : string |
|
658 | 658 | { |
659 | 659 | return PathRelativizer::relativizeByDepth($path, $depth); |
660 | 660 | } |
@@ -693,7 +693,7 @@ discard block |
||
693 | 693 | * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
694 | 694 | * @see FileHelper::ERROR_REAL_PATH_NOT_FOUND |
695 | 695 | */ |
696 | - public static function requireFileExists($path, ?int $errorCode=null) : string |
|
696 | + public static function requireFileExists($path, ?int $errorCode = null) : string |
|
697 | 697 | { |
698 | 698 | return self::getPathInfo($path) |
699 | 699 | ->requireIsFile() |
@@ -707,7 +707,7 @@ discard block |
||
707 | 707 | * @return string |
708 | 708 | * @throws FileHelper_Exception |
709 | 709 | */ |
710 | - public static function requireFileReadable($path, ?int $errorCode=null) : string |
|
710 | + public static function requireFileReadable($path, ?int $errorCode = null) : string |
|
711 | 711 | { |
712 | 712 | return self::getPathInfo($path) |
713 | 713 | ->requireIsFile() |
@@ -785,7 +785,7 @@ discard block |
||
785 | 785 | * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
786 | 786 | * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES |
787 | 787 | */ |
788 | - public static function readLines($filePath, int $amount=0) : array |
|
788 | + public static function readLines($filePath, int $amount = 0) : array |
|
789 | 789 | { |
790 | 790 | return self::getFileInfo($filePath) |
791 | 791 | ->getLineReader() |
@@ -835,7 +835,7 @@ discard block |
||
835 | 835 | * |
836 | 836 | * @throws FileHelper_Exception |
837 | 837 | */ |
838 | - public static function createPathsReducer(array $paths=array()) : PathsReducer |
|
838 | + public static function createPathsReducer(array $paths = array()) : PathsReducer |
|
839 | 839 | { |
840 | 840 | return new PathsReducer($paths); |
841 | 841 | } |
@@ -74,7 +74,7 @@ |
||
74 | 74 | * @param bool $enabled |
75 | 75 | * @return $this |
76 | 76 | */ |
77 | - public function prop(string $name, bool $enabled=true) : self |
|
77 | + public function prop(string $name, bool $enabled = true) : self |
|
78 | 78 | { |
79 | 79 | $this->getAttributes()->prop($name, $enabled); |
80 | 80 | return $this; |
@@ -25,9 +25,9 @@ discard block |
||
25 | 25 | */ |
26 | 26 | trait Traits_Classable |
27 | 27 | { |
28 | - /** |
|
29 | - * @var string[] |
|
30 | - */ |
|
28 | + /** |
|
29 | + * @var string[] |
|
30 | + */ |
|
31 | 31 | protected array $classes = array(); |
32 | 32 | |
33 | 33 | public function hasClasses() : bool |
@@ -82,30 +82,30 @@ discard block |
||
82 | 82 | return $this; |
83 | 83 | } |
84 | 84 | |
85 | - /** |
|
86 | - * Retrieves a list of all classes, if any. |
|
87 | - * |
|
88 | - * @return string[] |
|
89 | - */ |
|
85 | + /** |
|
86 | + * Retrieves a list of all classes, if any. |
|
87 | + * |
|
88 | + * @return string[] |
|
89 | + */ |
|
90 | 90 | public function getClasses() : array |
91 | 91 | { |
92 | 92 | return $this->classes; |
93 | 93 | } |
94 | 94 | |
95 | - /** |
|
96 | - * Renders the class names list as space-separated string for use in an HTML tag. |
|
97 | - * |
|
98 | - * @return string |
|
99 | - */ |
|
95 | + /** |
|
96 | + * Renders the class names list as space-separated string for use in an HTML tag. |
|
97 | + * |
|
98 | + * @return string |
|
99 | + */ |
|
100 | 100 | public function classesToString() : string |
101 | 101 | { |
102 | 102 | return implode(' ', $this->classes); |
103 | 103 | } |
104 | 104 | |
105 | - /** |
|
106 | - * Renders the "class" attribute string for inserting into an HTML tag. |
|
107 | - * @return string |
|
108 | - */ |
|
105 | + /** |
|
106 | + * Renders the "class" attribute string for inserting into an HTML tag. |
|
107 | + * @return string |
|
108 | + */ |
|
109 | 109 | public function classesToAttribute() : string |
110 | 110 | { |
111 | 111 | if(!empty($this->classes)) |
@@ -41,7 +41,7 @@ discard block |
||
41 | 41 | */ |
42 | 42 | public function addClass($name) |
43 | 43 | { |
44 | - if(!in_array($name, $this->classes, true)) { |
|
44 | + if (!in_array($name, $this->classes, true)) { |
|
45 | 45 | $this->classes[] = $name; |
46 | 46 | } |
47 | 47 | |
@@ -54,7 +54,7 @@ discard block |
||
54 | 54 | */ |
55 | 55 | public function addClasses(array $names) : self |
56 | 56 | { |
57 | - foreach($names as $name) { |
|
57 | + foreach ($names as $name) { |
|
58 | 58 | $this->addClass($name); |
59 | 59 | } |
60 | 60 | |
@@ -74,7 +74,7 @@ discard block |
||
74 | 74 | { |
75 | 75 | $idx = array_search($name, $this->classes, true); |
76 | 76 | |
77 | - if($idx !== false) { |
|
77 | + if ($idx !== false) { |
|
78 | 78 | unset($this->classes[$idx]); |
79 | 79 | sort($this->classes); |
80 | 80 | } |
@@ -108,7 +108,7 @@ discard block |
||
108 | 108 | */ |
109 | 109 | public function classesToAttribute() : string |
110 | 110 | { |
111 | - if(!empty($this->classes)) |
|
111 | + if (!empty($this->classes)) |
|
112 | 112 | { |
113 | 113 | return sprintf( |
114 | 114 | ' class="%s" ', |
@@ -26,9 +26,9 @@ discard block |
||
26 | 26 | */ |
27 | 27 | trait Traits_Optionable |
28 | 28 | { |
29 | - /** |
|
30 | - * @var array<string,mixed>|NULL |
|
31 | - */ |
|
29 | + /** |
|
30 | + * @var array<string,mixed>|NULL |
|
31 | + */ |
|
32 | 32 | protected ?array $options = null; |
33 | 33 | |
34 | 34 | /** |
@@ -49,13 +49,13 @@ discard block |
||
49 | 49 | return $this; |
50 | 50 | } |
51 | 51 | |
52 | - /** |
|
53 | - * Sets a collection of options at once, from an |
|
54 | - * associative array. |
|
55 | - * |
|
56 | - * @param array<string,mixed> $options |
|
57 | - * @return $this |
|
58 | - */ |
|
52 | + /** |
|
53 | + * Sets a collection of options at once, from an |
|
54 | + * associative array. |
|
55 | + * |
|
56 | + * @param array<string,mixed> $options |
|
57 | + * @return $this |
|
58 | + */ |
|
59 | 59 | public function setOptions(array $options) : self |
60 | 60 | { |
61 | 61 | foreach($options as $name => $value) { |
@@ -65,16 +65,16 @@ discard block |
||
65 | 65 | return $this; |
66 | 66 | } |
67 | 67 | |
68 | - /** |
|
69 | - * Retrieves an option's value. |
|
70 | - * |
|
71 | - * NOTE: Use the specialized type getters to ensure an option |
|
72 | - * contains the expected type (for ex. getArrayOption()). |
|
73 | - * |
|
74 | - * @param string $name |
|
75 | - * @param mixed $default The default value to return if the option does not exist. |
|
76 | - * @return mixed |
|
77 | - */ |
|
68 | + /** |
|
69 | + * Retrieves an option's value. |
|
70 | + * |
|
71 | + * NOTE: Use the specialized type getters to ensure an option |
|
72 | + * contains the expected type (for ex. getArrayOption()). |
|
73 | + * |
|
74 | + * @param string $name |
|
75 | + * @param mixed $default The default value to return if the option does not exist. |
|
76 | + * @return mixed |
|
77 | + */ |
|
78 | 78 | public function getOption(string $name, $default=null) |
79 | 79 | { |
80 | 80 | if(!isset($this->options)) |
@@ -85,16 +85,16 @@ discard block |
||
85 | 85 | return $this->options[$name] ?? $default; |
86 | 86 | } |
87 | 87 | |
88 | - /** |
|
89 | - * Enforces that the option value is a string. Numbers are converted |
|
90 | - * to string, strings are passed through, and all other types will |
|
91 | - * return the default value. The default value is also returned if |
|
92 | - * the string is empty. |
|
93 | - * |
|
94 | - * @param string $name |
|
95 | - * @param string $default Used if the option does not exist, is invalid, or empty. |
|
96 | - * @return string |
|
97 | - */ |
|
88 | + /** |
|
89 | + * Enforces that the option value is a string. Numbers are converted |
|
90 | + * to string, strings are passed through, and all other types will |
|
91 | + * return the default value. The default value is also returned if |
|
92 | + * the string is empty. |
|
93 | + * |
|
94 | + * @param string $name |
|
95 | + * @param string $default Used if the option does not exist, is invalid, or empty. |
|
96 | + * @return string |
|
97 | + */ |
|
98 | 98 | public function getStringOption(string $name, string $default='') : string |
99 | 99 | { |
100 | 100 | $value = $this->getOption($name, false); |
@@ -126,15 +126,15 @@ discard block |
||
126 | 126 | return $default; |
127 | 127 | } |
128 | 128 | |
129 | - /** |
|
130 | - * Treats the option value as an integer value: will return |
|
131 | - * valid integer values (also from integer strings), or the |
|
132 | - * default value otherwise. |
|
133 | - * |
|
134 | - * @param string $name |
|
135 | - * @param int $default |
|
136 | - * @return int |
|
137 | - */ |
|
129 | + /** |
|
130 | + * Treats the option value as an integer value: will return |
|
131 | + * valid integer values (also from integer strings), or the |
|
132 | + * default value otherwise. |
|
133 | + * |
|
134 | + * @param string $name |
|
135 | + * @param int $default |
|
136 | + * @return int |
|
137 | + */ |
|
138 | 138 | public function getIntOption(string $name, int $default=0) : int |
139 | 139 | { |
140 | 140 | $value = $this->getOption($name); |
@@ -145,14 +145,14 @@ discard block |
||
145 | 145 | return $default; |
146 | 146 | } |
147 | 147 | |
148 | - /** |
|
149 | - * Treats an option as an array, and returns its value |
|
150 | - * only if it contains an array - otherwise, an empty |
|
151 | - * array is returned. |
|
152 | - * |
|
153 | - * @param string $name |
|
154 | - * @return array<int|string,mixed> |
|
155 | - */ |
|
148 | + /** |
|
149 | + * Treats an option as an array, and returns its value |
|
150 | + * only if it contains an array - otherwise, an empty |
|
151 | + * array is returned. |
|
152 | + * |
|
153 | + * @param string $name |
|
154 | + * @return array<int|string,mixed> |
|
155 | + */ |
|
156 | 156 | public function getArrayOption(string $name) : array |
157 | 157 | { |
158 | 158 | $val = $this->getOption($name); |
@@ -163,13 +163,13 @@ discard block |
||
163 | 163 | return array(); |
164 | 164 | } |
165 | 165 | |
166 | - /** |
|
167 | - * Checks whether the specified option exists - even |
|
168 | - * if it has a NULL value. |
|
169 | - * |
|
170 | - * @param string $name |
|
171 | - * @return bool |
|
172 | - */ |
|
166 | + /** |
|
167 | + * Checks whether the specified option exists - even |
|
168 | + * if it has a NULL value. |
|
169 | + * |
|
170 | + * @param string $name |
|
171 | + * @return bool |
|
172 | + */ |
|
173 | 173 | public function hasOption(string $name) : bool |
174 | 174 | { |
175 | 175 | if(!isset($this->options)) { |
@@ -179,11 +179,11 @@ discard block |
||
179 | 179 | return array_key_exists($name, $this->options); |
180 | 180 | } |
181 | 181 | |
182 | - /** |
|
183 | - * Returns all options in one associative array. |
|
184 | - * |
|
185 | - * @return array<string,mixed> |
|
186 | - */ |
|
182 | + /** |
|
183 | + * Returns all options in one associative array. |
|
184 | + * |
|
185 | + * @return array<string,mixed> |
|
186 | + */ |
|
187 | 187 | public function getOptions() : array |
188 | 188 | { |
189 | 189 | if(!isset($this->options)) { |
@@ -193,13 +193,13 @@ discard block |
||
193 | 193 | return $this->options; |
194 | 194 | } |
195 | 195 | |
196 | - /** |
|
197 | - * Checks whether the option's value is the one specified. |
|
198 | - * |
|
199 | - * @param string $name |
|
200 | - * @param mixed $value |
|
201 | - * @return bool |
|
202 | - */ |
|
196 | + /** |
|
197 | + * Checks whether the option's value is the one specified. |
|
198 | + * |
|
199 | + * @param string $name |
|
200 | + * @param mixed $value |
|
201 | + * @return bool |
|
202 | + */ |
|
203 | 203 | public function isOption(string $name, $value) : bool |
204 | 204 | { |
205 | 205 | return $this->getOption($name) === $value; |
@@ -41,7 +41,7 @@ discard block |
||
41 | 41 | */ |
42 | 42 | public function setOption(string $name, $value) : self |
43 | 43 | { |
44 | - if(!isset($this->options)) { |
|
44 | + if (!isset($this->options)) { |
|
45 | 45 | $this->options = $this->getDefaultOptions(); |
46 | 46 | } |
47 | 47 | |
@@ -58,7 +58,7 @@ discard block |
||
58 | 58 | */ |
59 | 59 | public function setOptions(array $options) : self |
60 | 60 | { |
61 | - foreach($options as $name => $value) { |
|
61 | + foreach ($options as $name => $value) { |
|
62 | 62 | $this->setOption($name, $value); |
63 | 63 | } |
64 | 64 | |
@@ -75,9 +75,9 @@ discard block |
||
75 | 75 | * @param mixed $default The default value to return if the option does not exist. |
76 | 76 | * @return mixed |
77 | 77 | */ |
78 | - public function getOption(string $name, $default=null) |
|
78 | + public function getOption(string $name, $default = null) |
|
79 | 79 | { |
80 | - if(!isset($this->options)) |
|
80 | + if (!isset($this->options)) |
|
81 | 81 | { |
82 | 82 | $this->options = $this->getDefaultOptions(); |
83 | 83 | } |
@@ -95,11 +95,11 @@ discard block |
||
95 | 95 | * @param string $default Used if the option does not exist, is invalid, or empty. |
96 | 96 | * @return string |
97 | 97 | */ |
98 | - public function getStringOption(string $name, string $default='') : string |
|
98 | + public function getStringOption(string $name, string $default = '') : string |
|
99 | 99 | { |
100 | 100 | $value = $this->getOption($name, false); |
101 | 101 | |
102 | - if((is_string($value) || is_numeric($value)) && !empty($value)) { |
|
102 | + if ((is_string($value) || is_numeric($value)) && !empty($value)) { |
|
103 | 103 | return (string)$value; |
104 | 104 | } |
105 | 105 | |
@@ -116,9 +116,9 @@ discard block |
||
116 | 116 | * @param bool $default |
117 | 117 | * @return bool |
118 | 118 | */ |
119 | - public function getBoolOption(string $name, bool $default=false) : bool |
|
119 | + public function getBoolOption(string $name, bool $default = false) : bool |
|
120 | 120 | { |
121 | - if($this->getOption($name) === true) |
|
121 | + if ($this->getOption($name) === true) |
|
122 | 122 | { |
123 | 123 | return true; |
124 | 124 | } |
@@ -135,10 +135,10 @@ discard block |
||
135 | 135 | * @param int $default |
136 | 136 | * @return int |
137 | 137 | */ |
138 | - public function getIntOption(string $name, int $default=0) : int |
|
138 | + public function getIntOption(string $name, int $default = 0) : int |
|
139 | 139 | { |
140 | 140 | $value = $this->getOption($name); |
141 | - if(ConvertHelper::isInteger($value)) { |
|
141 | + if (ConvertHelper::isInteger($value)) { |
|
142 | 142 | return (int)$value; |
143 | 143 | } |
144 | 144 | |
@@ -156,7 +156,7 @@ discard block |
||
156 | 156 | public function getArrayOption(string $name) : array |
157 | 157 | { |
158 | 158 | $val = $this->getOption($name); |
159 | - if(is_array($val)) { |
|
159 | + if (is_array($val)) { |
|
160 | 160 | return $val; |
161 | 161 | } |
162 | 162 | |
@@ -172,7 +172,7 @@ discard block |
||
172 | 172 | */ |
173 | 173 | public function hasOption(string $name) : bool |
174 | 174 | { |
175 | - if(!isset($this->options)) { |
|
175 | + if (!isset($this->options)) { |
|
176 | 176 | $this->options = $this->getDefaultOptions(); |
177 | 177 | } |
178 | 178 | |
@@ -186,7 +186,7 @@ discard block |
||
186 | 186 | */ |
187 | 187 | public function getOptions() : array |
188 | 188 | { |
189 | - if(!isset($this->options)) { |
|
189 | + if (!isset($this->options)) { |
|
190 | 190 | $this->options = $this->getDefaultOptions(); |
191 | 191 | } |
192 | 192 |
@@ -56,12 +56,12 @@ |
||
56 | 56 | */ |
57 | 57 | public static function value2string($value) : string |
58 | 58 | { |
59 | - if($value === true) |
|
59 | + if ($value === true) |
|
60 | 60 | { |
61 | 61 | return 'true'; |
62 | 62 | } |
63 | 63 | |
64 | - if($value === false) |
|
64 | + if ($value === false) |
|
65 | 65 | { |
66 | 66 | return 'false'; |
67 | 67 | } |
@@ -53,7 +53,7 @@ |
||
53 | 53 | * @param bool $enabled |
54 | 54 | * @return $this |
55 | 55 | */ |
56 | - public function prop(string $name, bool $enabled=true) : self; |
|
56 | + public function prop(string $name, bool $enabled = true) : self; |
|
57 | 57 | |
58 | 58 | /** |
59 | 59 | * @param string $name |
@@ -45,7 +45,7 @@ discard block |
||
45 | 45 | * @param mixed $default The default value to return if the option does not exist. |
46 | 46 | * @return mixed |
47 | 47 | */ |
48 | - public function getOption(string $name, $default=null); |
|
48 | + public function getOption(string $name, $default = null); |
|
49 | 49 | |
50 | 50 | /** |
51 | 51 | * @param string $name |
@@ -53,11 +53,11 @@ discard block |
||
53 | 53 | */ |
54 | 54 | public function getArrayOption(string $name) : array; |
55 | 55 | |
56 | - public function getIntOption(string $name, int $default=0) : int; |
|
56 | + public function getIntOption(string $name, int $default = 0) : int; |
|
57 | 57 | |
58 | - public function getBoolOption(string $name, bool $default=false) : bool; |
|
58 | + public function getBoolOption(string $name, bool $default = false) : bool; |
|
59 | 59 | |
60 | - public function getStringOption(string $name, string $default='') : string; |
|
60 | + public function getStringOption(string $name, string $default = '') : string; |
|
61 | 61 | |
62 | 62 | /** |
63 | 63 | * Sets a collection of options at once, from an |
@@ -23,44 +23,44 @@ |
||
23 | 23 | */ |
24 | 24 | class Request_URLComparer |
25 | 25 | { |
26 | - /** |
|
27 | - * @var Request |
|
28 | - */ |
|
26 | + /** |
|
27 | + * @var Request |
|
28 | + */ |
|
29 | 29 | protected Request $request; |
30 | 30 | |
31 | - /** |
|
32 | - * @var string |
|
33 | - */ |
|
31 | + /** |
|
32 | + * @var string |
|
33 | + */ |
|
34 | 34 | protected string $sourceURL; |
35 | 35 | |
36 | - /** |
|
37 | - * @var string |
|
38 | - */ |
|
36 | + /** |
|
37 | + * @var string |
|
38 | + */ |
|
39 | 39 | protected string $targetURL; |
40 | 40 | |
41 | - /** |
|
42 | - * @var string[] |
|
43 | - */ |
|
41 | + /** |
|
42 | + * @var string[] |
|
43 | + */ |
|
44 | 44 | protected array $limitParams = array(); |
45 | 45 | |
46 | - /** |
|
47 | - * @var bool |
|
48 | - */ |
|
46 | + /** |
|
47 | + * @var bool |
|
48 | + */ |
|
49 | 49 | protected bool $isMatch = false; |
50 | 50 | |
51 | - /** |
|
52 | - * @var bool |
|
53 | - */ |
|
51 | + /** |
|
52 | + * @var bool |
|
53 | + */ |
|
54 | 54 | protected bool $ignoreFragment = true; |
55 | 55 | |
56 | - /** |
|
57 | - * @var URLInfo |
|
58 | - */ |
|
56 | + /** |
|
57 | + * @var URLInfo |
|
58 | + */ |
|
59 | 59 | protected URLInfo $sourceInfo; |
60 | 60 | |
61 | - /** |
|
62 | - * @var URLInfo |
|
63 | - */ |
|
61 | + /** |
|
62 | + * @var URLInfo |
|
63 | + */ |
|
64 | 64 | protected URLInfo $targetInfo; |
65 | 65 | |
66 | 66 | public function __construct(Request $request, string $sourceURL, string $targetURL) |
@@ -81,7 +81,7 @@ discard block |
||
81 | 81 | |
82 | 82 | public function addLimitParam(string $name) : Request_URLComparer |
83 | 83 | { |
84 | - if(!in_array($name, $this->limitParams, true)) |
|
84 | + if (!in_array($name, $this->limitParams, true)) |
|
85 | 85 | { |
86 | 86 | $this->limitParams[] = $name; |
87 | 87 | } |
@@ -95,7 +95,7 @@ discard block |
||
95 | 95 | */ |
96 | 96 | public function addLimitParams(array $names) : Request_URLComparer |
97 | 97 | { |
98 | - foreach($names as $name) |
|
98 | + foreach ($names as $name) |
|
99 | 99 | { |
100 | 100 | $this->addLimitParam($name); |
101 | 101 | } |
@@ -103,7 +103,7 @@ discard block |
||
103 | 103 | return $this; |
104 | 104 | } |
105 | 105 | |
106 | - public function setIgnoreFragment(bool $ignore=true) : Request_URLComparer |
|
106 | + public function setIgnoreFragment(bool $ignore = true) : Request_URLComparer |
|
107 | 107 | { |
108 | 108 | $this->ignoreFragment = $ignore; |
109 | 109 | return $this; |
@@ -126,13 +126,13 @@ discard block |
||
126 | 126 | 'query' |
127 | 127 | ); |
128 | 128 | |
129 | - if(!$this->ignoreFragment) { |
|
129 | + if (!$this->ignoreFragment) { |
|
130 | 130 | $keys[] = 'fragment'; |
131 | 131 | } |
132 | 132 | |
133 | - foreach($keys as $key) |
|
133 | + foreach ($keys as $key) |
|
134 | 134 | { |
135 | - if(!$this->compareKey($key)) { |
|
135 | + if (!$this->compareKey($key)) { |
|
136 | 136 | return false; |
137 | 137 | } |
138 | 138 | } |
@@ -147,7 +147,7 @@ discard block |
||
147 | 147 | |
148 | 148 | $filter = 'filter_'.$key; |
149 | 149 | |
150 | - if(method_exists($this, $filter)) |
|
150 | + if (method_exists($this, $filter)) |
|
151 | 151 | { |
152 | 152 | $sVal = $this->$filter($sVal); |
153 | 153 | $tVal = $this->$filter($tVal); |
@@ -159,7 +159,7 @@ discard block |
||
159 | 159 | protected function filter_path(string $path) : string |
160 | 160 | { |
161 | 161 | // fix double slashes in URLs |
162 | - while(strpos($path, '//') !== false) |
|
162 | + while (strpos($path, '//') !== false) |
|
163 | 163 | { |
164 | 164 | $path = str_replace('//', '/', $path); |
165 | 165 | } |
@@ -169,7 +169,7 @@ discard block |
||
169 | 169 | |
170 | 170 | protected function filter_query(string $query) : string |
171 | 171 | { |
172 | - if(empty($query)) { |
|
172 | + if (empty($query)) { |
|
173 | 173 | return ''; |
174 | 174 | } |
175 | 175 | |
@@ -188,15 +188,15 @@ discard block |
||
188 | 188 | */ |
189 | 189 | protected function limitParams(array $params) : array |
190 | 190 | { |
191 | - if(empty($this->limitParams)) { |
|
191 | + if (empty($this->limitParams)) { |
|
192 | 192 | return $params; |
193 | 193 | } |
194 | 194 | |
195 | 195 | $keep = array(); |
196 | 196 | |
197 | - foreach($this->limitParams as $name) |
|
197 | + foreach ($this->limitParams as $name) |
|
198 | 198 | { |
199 | - if(isset($params[$name])) { |
|
199 | + if (isset($params[$name])) { |
|
200 | 200 | $keep[$name] = $params[$name]; |
201 | 201 | } |
202 | 202 | } |