@@ -197,8 +197,7 @@ discard block |
||
197 | 197 | if ($item->isDir()) |
198 | 198 | { |
199 | 199 | FileHelper::copyTree(str_replace('\\', '/', $itemPath), $target . '/' . $baseName); |
200 | - } |
|
201 | - else if($item->isFile()) |
|
200 | + } else if($item->isFile()) |
|
202 | 201 | { |
203 | 202 | self::copyFile($itemPath, $target . '/' . $baseName); |
204 | 203 | } |
@@ -242,8 +241,7 @@ discard block |
||
242 | 241 | if(!file_exists($targetFolder)) |
243 | 242 | { |
244 | 243 | self::createFolder($targetFolder); |
245 | - } |
|
246 | - else if(!is_writable($targetFolder)) |
|
244 | + } else if(!is_writable($targetFolder)) |
|
247 | 245 | { |
248 | 246 | throw new FileHelper_Exception( |
249 | 247 | sprintf('Target folder [%s] is not writable.', basename($targetFolder)), |
@@ -80,32 +80,32 @@ discard block |
||
80 | 80 | |
81 | 81 | const ERROR_CANNOT_OPEN_FILE_TO_DETECT_BOM = 340032; |
82 | 82 | |
83 | - /** |
|
84 | - * Opens a serialized file and returns the unserialized data. |
|
85 | - * |
|
86 | - * @param string $file |
|
87 | - * @throws FileHelper_Exception |
|
88 | - * @return array |
|
89 | - * @deprecated Use parseSerializedFile() instead. |
|
90 | - * @see FileHelper::parseSerializedFile() |
|
91 | - */ |
|
83 | + /** |
|
84 | + * Opens a serialized file and returns the unserialized data. |
|
85 | + * |
|
86 | + * @param string $file |
|
87 | + * @throws FileHelper_Exception |
|
88 | + * @return array |
|
89 | + * @deprecated Use parseSerializedFile() instead. |
|
90 | + * @see FileHelper::parseSerializedFile() |
|
91 | + */ |
|
92 | 92 | public static function openUnserialized(string $file) : array |
93 | 93 | { |
94 | 94 | return self::parseSerializedFile($file); |
95 | 95 | } |
96 | 96 | |
97 | - /** |
|
98 | - * Opens a serialized file and returns the unserialized data. |
|
99 | - * |
|
100 | - * @param string $file |
|
101 | - * @throws FileHelper_Exception |
|
102 | - * @return array |
|
103 | - * @see FileHelper::parseSerializedFile() |
|
104 | - * |
|
105 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
106 | - * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ |
|
107 | - * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED |
|
108 | - */ |
|
97 | + /** |
|
98 | + * Opens a serialized file and returns the unserialized data. |
|
99 | + * |
|
100 | + * @param string $file |
|
101 | + * @throws FileHelper_Exception |
|
102 | + * @return array |
|
103 | + * @see FileHelper::parseSerializedFile() |
|
104 | + * |
|
105 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
106 | + * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ |
|
107 | + * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED |
|
108 | + */ |
|
109 | 109 | public static function parseSerializedFile(string $file) |
110 | 110 | { |
111 | 111 | self::requireFileExists($file); |
@@ -174,13 +174,13 @@ discard block |
||
174 | 174 | return rmdir($rootFolder); |
175 | 175 | } |
176 | 176 | |
177 | - /** |
|
178 | - * Create a folder, if it does not exist yet. |
|
179 | - * |
|
180 | - * @param string $path |
|
181 | - * @throws FileHelper_Exception |
|
182 | - * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER |
|
183 | - */ |
|
177 | + /** |
|
178 | + * Create a folder, if it does not exist yet. |
|
179 | + * |
|
180 | + * @param string $path |
|
181 | + * @throws FileHelper_Exception |
|
182 | + * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER |
|
183 | + */ |
|
184 | 184 | public static function createFolder($path) |
185 | 185 | { |
186 | 186 | if(is_dir($path) || mkdir($path, 0777, true)) { |
@@ -227,22 +227,22 @@ discard block |
||
227 | 227 | } |
228 | 228 | } |
229 | 229 | |
230 | - /** |
|
231 | - * Copies a file to the target location. Includes checks |
|
232 | - * for most error sources, like the source file not being |
|
233 | - * readable. Automatically creates the target folder if it |
|
234 | - * does not exist yet. |
|
235 | - * |
|
236 | - * @param string $sourcePath |
|
237 | - * @param string $targetPath |
|
238 | - * @throws FileHelper_Exception |
|
239 | - * |
|
240 | - * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER |
|
241 | - * @see FileHelper::ERROR_SOURCE_FILE_NOT_FOUND |
|
242 | - * @see FileHelper::ERROR_SOURCE_FILE_NOT_READABLE |
|
243 | - * @see FileHelper::ERROR_TARGET_COPY_FOLDER_NOT_WRITABLE |
|
244 | - * @see FileHelper::ERROR_CANNOT_COPY_FILE |
|
245 | - */ |
|
230 | + /** |
|
231 | + * Copies a file to the target location. Includes checks |
|
232 | + * for most error sources, like the source file not being |
|
233 | + * readable. Automatically creates the target folder if it |
|
234 | + * does not exist yet. |
|
235 | + * |
|
236 | + * @param string $sourcePath |
|
237 | + * @param string $targetPath |
|
238 | + * @throws FileHelper_Exception |
|
239 | + * |
|
240 | + * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER |
|
241 | + * @see FileHelper::ERROR_SOURCE_FILE_NOT_FOUND |
|
242 | + * @see FileHelper::ERROR_SOURCE_FILE_NOT_READABLE |
|
243 | + * @see FileHelper::ERROR_TARGET_COPY_FOLDER_NOT_WRITABLE |
|
244 | + * @see FileHelper::ERROR_CANNOT_COPY_FILE |
|
245 | + */ |
|
246 | 246 | public static function copyFile($sourcePath, $targetPath) |
247 | 247 | { |
248 | 248 | self::requireFileExists($sourcePath, self::ERROR_SOURCE_FILE_NOT_FOUND); |
@@ -293,15 +293,15 @@ discard block |
||
293 | 293 | ); |
294 | 294 | } |
295 | 295 | |
296 | - /** |
|
297 | - * Deletes the target file. Ignored if it cannot be found, |
|
298 | - * and throws an exception if it fails. |
|
299 | - * |
|
300 | - * @param string $filePath |
|
301 | - * @throws FileHelper_Exception |
|
302 | - * |
|
303 | - * @see FileHelper::ERROR_CANNOT_DELETE_FILE |
|
304 | - */ |
|
296 | + /** |
|
297 | + * Deletes the target file. Ignored if it cannot be found, |
|
298 | + * and throws an exception if it fails. |
|
299 | + * |
|
300 | + * @param string $filePath |
|
301 | + * @throws FileHelper_Exception |
|
302 | + * |
|
303 | + * @see FileHelper::ERROR_CANNOT_DELETE_FILE |
|
304 | + */ |
|
305 | 305 | public static function deleteFile(string $filePath) : void |
306 | 306 | { |
307 | 307 | if(!file_exists($filePath)) { |
@@ -323,15 +323,15 @@ discard block |
||
323 | 323 | } |
324 | 324 | |
325 | 325 | /** |
326 | - * Creates a new CSV parser instance and returns it. |
|
327 | - * |
|
328 | - * @param string $delimiter |
|
329 | - * @param string $enclosure |
|
330 | - * @param string $escape |
|
331 | - * @param bool $heading |
|
332 | - * @return \parseCSV |
|
333 | - * @todo Move this to the CSV helper. |
|
334 | - */ |
|
326 | + * Creates a new CSV parser instance and returns it. |
|
327 | + * |
|
328 | + * @param string $delimiter |
|
329 | + * @param string $enclosure |
|
330 | + * @param string $escape |
|
331 | + * @param bool $heading |
|
332 | + * @return \parseCSV |
|
333 | + * @todo Move this to the CSV helper. |
|
334 | + */ |
|
335 | 335 | public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : \parseCSV |
336 | 336 | { |
337 | 337 | if($delimiter==='') { $delimiter = ';'; } |
@@ -346,23 +346,23 @@ discard block |
||
346 | 346 | return $parser; |
347 | 347 | } |
348 | 348 | |
349 | - /** |
|
350 | - * Parses all lines in the specified string and returns an |
|
351 | - * indexed array with all csv values in each line. |
|
352 | - * |
|
353 | - * @param string $csv |
|
354 | - * @param string $delimiter |
|
355 | - * @param string $enclosure |
|
356 | - * @param string $escape |
|
357 | - * @param bool $heading |
|
358 | - * @return array |
|
359 | - * @throws FileHelper_Exception |
|
360 | - * |
|
361 | - * @todo Move this to the CSVHelper. |
|
362 | - * |
|
363 | - * @see parseCSVFile() |
|
364 | - * @see FileHelper::ERROR_PARSING_CSV |
|
365 | - */ |
|
349 | + /** |
|
350 | + * Parses all lines in the specified string and returns an |
|
351 | + * indexed array with all csv values in each line. |
|
352 | + * |
|
353 | + * @param string $csv |
|
354 | + * @param string $delimiter |
|
355 | + * @param string $enclosure |
|
356 | + * @param string $escape |
|
357 | + * @param bool $heading |
|
358 | + * @return array |
|
359 | + * @throws FileHelper_Exception |
|
360 | + * |
|
361 | + * @todo Move this to the CSVHelper. |
|
362 | + * |
|
363 | + * @see parseCSVFile() |
|
364 | + * @see FileHelper::ERROR_PARSING_CSV |
|
365 | + */ |
|
366 | 366 | public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array |
367 | 367 | { |
368 | 368 | $parser = self::createCSVParser($delimiter, $enclosure, $escape, $heading); |
@@ -541,31 +541,31 @@ discard block |
||
541 | 541 | ); |
542 | 542 | } |
543 | 543 | |
544 | - /** |
|
545 | - * Verifies whether the target file is a PHP file. The path |
|
546 | - * to the file can be a path to a file as a string, or a |
|
547 | - * DirectoryIterator object instance. |
|
548 | - * |
|
549 | - * @param string|\DirectoryIterator $pathOrDirIterator |
|
550 | - * @return boolean |
|
551 | - */ |
|
544 | + /** |
|
545 | + * Verifies whether the target file is a PHP file. The path |
|
546 | + * to the file can be a path to a file as a string, or a |
|
547 | + * DirectoryIterator object instance. |
|
548 | + * |
|
549 | + * @param string|\DirectoryIterator $pathOrDirIterator |
|
550 | + * @return boolean |
|
551 | + */ |
|
552 | 552 | public static function isPHPFile($pathOrDirIterator) |
553 | 553 | { |
554 | - if(self::getExtension($pathOrDirIterator) == 'php') { |
|
555 | - return true; |
|
556 | - } |
|
554 | + if(self::getExtension($pathOrDirIterator) == 'php') { |
|
555 | + return true; |
|
556 | + } |
|
557 | 557 | |
558 | - return false; |
|
558 | + return false; |
|
559 | 559 | } |
560 | 560 | |
561 | - /** |
|
562 | - * Retrieves the extension of the specified file. Can be a path |
|
563 | - * to a file as a string, or a DirectoryIterator object instance. |
|
564 | - * |
|
565 | - * @param string|\DirectoryIterator $pathOrDirIterator |
|
566 | - * @param bool $lowercase |
|
567 | - * @return string |
|
568 | - */ |
|
561 | + /** |
|
562 | + * Retrieves the extension of the specified file. Can be a path |
|
563 | + * to a file as a string, or a DirectoryIterator object instance. |
|
564 | + * |
|
565 | + * @param string|\DirectoryIterator $pathOrDirIterator |
|
566 | + * @param bool $lowercase |
|
567 | + * @return string |
|
568 | + */ |
|
569 | 569 | public static function getExtension($pathOrDirIterator, bool $lowercase = true) : string |
570 | 570 | { |
571 | 571 | if($pathOrDirIterator instanceof \DirectoryIterator) { |
@@ -576,51 +576,51 @@ discard block |
||
576 | 576 | |
577 | 577 | $ext = pathinfo($filename, PATHINFO_EXTENSION); |
578 | 578 | if($lowercase) { |
579 | - $ext = mb_strtolower($ext); |
|
579 | + $ext = mb_strtolower($ext); |
|
580 | 580 | } |
581 | 581 | |
582 | 582 | return $ext; |
583 | 583 | } |
584 | 584 | |
585 | - /** |
|
586 | - * Retrieves the file name from a path, with or without extension. |
|
587 | - * The path to the file can be a string, or a DirectoryIterator object |
|
588 | - * instance. |
|
589 | - * |
|
590 | - * In case of folders, behaves like the pathinfo function: returns |
|
591 | - * the name of the folder. |
|
592 | - * |
|
593 | - * @param string|\DirectoryIterator $pathOrDirIterator |
|
594 | - * @param bool $extension |
|
595 | - * @return string |
|
596 | - */ |
|
585 | + /** |
|
586 | + * Retrieves the file name from a path, with or without extension. |
|
587 | + * The path to the file can be a string, or a DirectoryIterator object |
|
588 | + * instance. |
|
589 | + * |
|
590 | + * In case of folders, behaves like the pathinfo function: returns |
|
591 | + * the name of the folder. |
|
592 | + * |
|
593 | + * @param string|\DirectoryIterator $pathOrDirIterator |
|
594 | + * @param bool $extension |
|
595 | + * @return string |
|
596 | + */ |
|
597 | 597 | public static function getFilename($pathOrDirIterator, $extension = true) |
598 | 598 | { |
599 | 599 | $path = $pathOrDirIterator; |
600 | - if($pathOrDirIterator instanceof \DirectoryIterator) { |
|
601 | - $path = $pathOrDirIterator->getFilename(); |
|
602 | - } |
|
600 | + if($pathOrDirIterator instanceof \DirectoryIterator) { |
|
601 | + $path = $pathOrDirIterator->getFilename(); |
|
602 | + } |
|
603 | 603 | |
604 | - $path = self::normalizePath($path); |
|
604 | + $path = self::normalizePath($path); |
|
605 | 605 | |
606 | - if(!$extension) { |
|
607 | - return pathinfo($path, PATHINFO_FILENAME); |
|
608 | - } |
|
606 | + if(!$extension) { |
|
607 | + return pathinfo($path, PATHINFO_FILENAME); |
|
608 | + } |
|
609 | 609 | |
610 | - return pathinfo($path, PATHINFO_BASENAME); |
|
610 | + return pathinfo($path, PATHINFO_BASENAME); |
|
611 | 611 | } |
612 | 612 | |
613 | - /** |
|
614 | - * Tries to read the contents of the target file and |
|
615 | - * treat it as JSON to return the decoded JSON data. |
|
616 | - * |
|
617 | - * @param string $file |
|
618 | - * @throws FileHelper_Exception |
|
619 | - * @return array |
|
620 | - * |
|
621 | - * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE |
|
622 | - * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE |
|
623 | - */ |
|
613 | + /** |
|
614 | + * Tries to read the contents of the target file and |
|
615 | + * treat it as JSON to return the decoded JSON data. |
|
616 | + * |
|
617 | + * @param string $file |
|
618 | + * @throws FileHelper_Exception |
|
619 | + * @return array |
|
620 | + * |
|
621 | + * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE |
|
622 | + * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE |
|
623 | + */ |
|
624 | 624 | public static function parseJSONFile(string $file, $targetEncoding=null, $sourceEncoding=null) |
625 | 625 | { |
626 | 626 | self::requireFileExists($file, self::ERROR_CANNOT_FIND_JSON_FILE); |
@@ -656,16 +656,16 @@ discard block |
||
656 | 656 | return $json; |
657 | 657 | } |
658 | 658 | |
659 | - /** |
|
660 | - * Corrects common formatting mistakes when users enter |
|
661 | - * file names, like too many spaces, dots and the like. |
|
662 | - * |
|
663 | - * NOTE: if the file name contains a path, the path is |
|
664 | - * stripped, leaving only the file name. |
|
665 | - * |
|
666 | - * @param string $name |
|
667 | - * @return string |
|
668 | - */ |
|
659 | + /** |
|
660 | + * Corrects common formatting mistakes when users enter |
|
661 | + * file names, like too many spaces, dots and the like. |
|
662 | + * |
|
663 | + * NOTE: if the file name contains a path, the path is |
|
664 | + * stripped, leaving only the file name. |
|
665 | + * |
|
666 | + * @param string $name |
|
667 | + * @return string |
|
668 | + */ |
|
669 | 669 | public static function fixFileName(string $name) : string |
670 | 670 | { |
671 | 671 | $name = trim($name); |
@@ -695,60 +695,60 @@ discard block |
||
695 | 695 | return $name; |
696 | 696 | } |
697 | 697 | |
698 | - /** |
|
699 | - * Creates an instance of the file finder, which is an easier |
|
700 | - * alternative to the other manual findFile methods, since all |
|
701 | - * options can be set by chaining. |
|
702 | - * |
|
703 | - * @param string $path |
|
704 | - * @return FileHelper_FileFinder |
|
705 | - */ |
|
698 | + /** |
|
699 | + * Creates an instance of the file finder, which is an easier |
|
700 | + * alternative to the other manual findFile methods, since all |
|
701 | + * options can be set by chaining. |
|
702 | + * |
|
703 | + * @param string $path |
|
704 | + * @return FileHelper_FileFinder |
|
705 | + */ |
|
706 | 706 | public static function createFileFinder(string $path) : FileHelper_FileFinder |
707 | 707 | { |
708 | 708 | return new FileHelper_FileFinder($path); |
709 | 709 | } |
710 | 710 | |
711 | - /** |
|
712 | - * Searches for all HTML files in the target folder. |
|
713 | - * |
|
714 | - * @param string $targetFolder |
|
715 | - * @param array $options |
|
716 | - * @return array An indexed array with files. |
|
717 | - * @see FileHelper::createFileFinder() |
|
718 | - * |
|
719 | - * @todo Convert this to use the file finder. |
|
720 | - */ |
|
711 | + /** |
|
712 | + * Searches for all HTML files in the target folder. |
|
713 | + * |
|
714 | + * @param string $targetFolder |
|
715 | + * @param array $options |
|
716 | + * @return array An indexed array with files. |
|
717 | + * @see FileHelper::createFileFinder() |
|
718 | + * |
|
719 | + * @todo Convert this to use the file finder. |
|
720 | + */ |
|
721 | 721 | public static function findHTMLFiles(string $targetFolder, array $options=array()) : array |
722 | 722 | { |
723 | 723 | return self::findFiles($targetFolder, array('html'), $options); |
724 | 724 | } |
725 | 725 | |
726 | - /** |
|
727 | - * Searches for all PHP files in the target folder. |
|
728 | - * |
|
729 | - * @param string $targetFolder |
|
730 | - * @param array $options |
|
731 | - * @return array An indexed array of PHP files. |
|
732 | - * @see FileHelper::createFileFinder() |
|
733 | - * |
|
734 | - * @todo Convert this to use the file finder. |
|
735 | - */ |
|
726 | + /** |
|
727 | + * Searches for all PHP files in the target folder. |
|
728 | + * |
|
729 | + * @param string $targetFolder |
|
730 | + * @param array $options |
|
731 | + * @return array An indexed array of PHP files. |
|
732 | + * @see FileHelper::createFileFinder() |
|
733 | + * |
|
734 | + * @todo Convert this to use the file finder. |
|
735 | + */ |
|
736 | 736 | public static function findPHPFiles(string $targetFolder, array $options=array()) : array |
737 | 737 | { |
738 | 738 | return self::findFiles($targetFolder, array('php'), $options); |
739 | 739 | } |
740 | 740 | |
741 | - /** |
|
742 | - * |
|
743 | - * @param string $targetFolder |
|
744 | - * @param array $extensions |
|
745 | - * @param array $options |
|
746 | - * @param array $files |
|
747 | - * @throws FileHelper_Exception |
|
748 | - * @return array |
|
749 | - * @see FileHelper::createFileFinder() |
|
750 | - * @todo Convert this to use the file finder. |
|
751 | - */ |
|
741 | + /** |
|
742 | + * |
|
743 | + * @param string $targetFolder |
|
744 | + * @param array $extensions |
|
745 | + * @param array $options |
|
746 | + * @param array $files |
|
747 | + * @throws FileHelper_Exception |
|
748 | + * @return array |
|
749 | + * @see FileHelper::createFileFinder() |
|
750 | + * @todo Convert this to use the file finder. |
|
751 | + */ |
|
752 | 752 | public static function findFiles(string $targetFolder, array $extensions=array(), array $options=array(), array $files=array()) : array |
753 | 753 | { |
754 | 754 | if(!isset($options['strip-extension'])) { |
@@ -829,13 +829,13 @@ discard block |
||
829 | 829 | return $files; |
830 | 830 | } |
831 | 831 | |
832 | - /** |
|
833 | - * Removes the extension from the specified path or file name, |
|
834 | - * if any, and returns the name without the extension. |
|
835 | - * |
|
836 | - * @param string $filename |
|
837 | - * @return sTring |
|
838 | - */ |
|
832 | + /** |
|
833 | + * Removes the extension from the specified path or file name, |
|
834 | + * if any, and returns the name without the extension. |
|
835 | + * |
|
836 | + * @param string $filename |
|
837 | + * @return sTring |
|
838 | + */ |
|
839 | 839 | public static function removeExtension(string $filename) : string |
840 | 840 | { |
841 | 841 | // normalize paths to allow windows style slashes even on nix servers |
@@ -844,22 +844,22 @@ discard block |
||
844 | 844 | return pathinfo($filename, PATHINFO_FILENAME); |
845 | 845 | } |
846 | 846 | |
847 | - /** |
|
848 | - * Detects the UTF BOM in the target file, if any. Returns |
|
849 | - * the encoding matching the BOM, which can be any of the |
|
850 | - * following: |
|
851 | - * |
|
852 | - * <ul> |
|
853 | - * <li>UTF32-BE</li> |
|
854 | - * <li>UTF32-LE</li> |
|
855 | - * <li>UTF16-BE</li> |
|
856 | - * <li>UTF16-LE</li> |
|
857 | - * <li>UTF8</li> |
|
858 | - * </ul> |
|
859 | - * |
|
860 | - * @param string $filename |
|
861 | - * @return string|NULL |
|
862 | - */ |
|
847 | + /** |
|
848 | + * Detects the UTF BOM in the target file, if any. Returns |
|
849 | + * the encoding matching the BOM, which can be any of the |
|
850 | + * following: |
|
851 | + * |
|
852 | + * <ul> |
|
853 | + * <li>UTF32-BE</li> |
|
854 | + * <li>UTF32-LE</li> |
|
855 | + * <li>UTF16-BE</li> |
|
856 | + * <li>UTF16-LE</li> |
|
857 | + * <li>UTF8</li> |
|
858 | + * </ul> |
|
859 | + * |
|
860 | + * @param string $filename |
|
861 | + * @return string|NULL |
|
862 | + */ |
|
863 | 863 | public static function detectUTFBom(string $filename) : ?string |
864 | 864 | { |
865 | 865 | $fp = fopen($filename, 'r'); |
@@ -891,13 +891,13 @@ discard block |
||
891 | 891 | |
892 | 892 | protected static $utfBoms; |
893 | 893 | |
894 | - /** |
|
895 | - * Retrieves a list of all UTF byte order mark character |
|
896 | - * sequences, as an assocative array with UTF encoding => bom sequence |
|
897 | - * pairs. |
|
898 | - * |
|
899 | - * @return array |
|
900 | - */ |
|
894 | + /** |
|
895 | + * Retrieves a list of all UTF byte order mark character |
|
896 | + * sequences, as an assocative array with UTF encoding => bom sequence |
|
897 | + * pairs. |
|
898 | + * |
|
899 | + * @return array |
|
900 | + */ |
|
901 | 901 | public static function getUTFBOMs() |
902 | 902 | { |
903 | 903 | if(!isset(self::$utfBoms)) { |
@@ -913,15 +913,15 @@ discard block |
||
913 | 913 | return self::$utfBoms; |
914 | 914 | } |
915 | 915 | |
916 | - /** |
|
917 | - * Checks whether the specified encoding is a valid |
|
918 | - * unicode encoding, for example "UTF16-LE" or "UTF8". |
|
919 | - * Also accounts for alternate way to write the, like |
|
920 | - * "UTF-8", and omitting little/big endian suffixes. |
|
921 | - * |
|
922 | - * @param string $encoding |
|
923 | - * @return boolean |
|
924 | - */ |
|
916 | + /** |
|
917 | + * Checks whether the specified encoding is a valid |
|
918 | + * unicode encoding, for example "UTF16-LE" or "UTF8". |
|
919 | + * Also accounts for alternate way to write the, like |
|
920 | + * "UTF-8", and omitting little/big endian suffixes. |
|
921 | + * |
|
922 | + * @param string $encoding |
|
923 | + * @return boolean |
|
924 | + */ |
|
925 | 925 | public static function isValidUnicodeEncoding(string $encoding) : bool |
926 | 926 | { |
927 | 927 | $encodings = self::getKnownUnicodeEncodings(); |
@@ -940,22 +940,22 @@ discard block |
||
940 | 940 | return in_array($encoding, $keep); |
941 | 941 | } |
942 | 942 | |
943 | - /** |
|
944 | - * Retrieves a list of all known unicode file encodings. |
|
945 | - * @return array |
|
946 | - */ |
|
943 | + /** |
|
944 | + * Retrieves a list of all known unicode file encodings. |
|
945 | + * @return array |
|
946 | + */ |
|
947 | 947 | public static function getKnownUnicodeEncodings() |
948 | 948 | { |
949 | 949 | return array_keys(self::getUTFBOMs()); |
950 | 950 | } |
951 | 951 | |
952 | - /** |
|
953 | - * Normalizes the slash style in a file or folder path, |
|
954 | - * by replacing any antislashes with forward slashes. |
|
955 | - * |
|
956 | - * @param string $path |
|
957 | - * @return string |
|
958 | - */ |
|
952 | + /** |
|
953 | + * Normalizes the slash style in a file or folder path, |
|
954 | + * by replacing any antislashes with forward slashes. |
|
955 | + * |
|
956 | + * @param string $path |
|
957 | + * @return string |
|
958 | + */ |
|
959 | 959 | public static function normalizePath(string $path) : string |
960 | 960 | { |
961 | 961 | return str_replace(array('\\', '//'), array('/', '/'), $path); |
@@ -988,18 +988,18 @@ discard block |
||
988 | 988 | } |
989 | 989 | } |
990 | 990 | |
991 | - /** |
|
992 | - * Saves the specified content to the target file, creating |
|
993 | - * the file and the folder as necessary. |
|
994 | - * |
|
995 | - * @param string $filePath |
|
996 | - * @param string $content |
|
997 | - * @throws FileHelper_Exception |
|
998 | - * |
|
999 | - * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE |
|
1000 | - * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
|
1001 | - * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
|
1002 | - */ |
|
991 | + /** |
|
992 | + * Saves the specified content to the target file, creating |
|
993 | + * the file and the folder as necessary. |
|
994 | + * |
|
995 | + * @param string $filePath |
|
996 | + * @param string $content |
|
997 | + * @throws FileHelper_Exception |
|
998 | + * |
|
999 | + * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE |
|
1000 | + * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
|
1001 | + * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
|
1002 | + */ |
|
1003 | 1003 | public static function saveFile(string $filePath, string $content='') : void |
1004 | 1004 | { |
1005 | 1005 | // target file already exists |
@@ -1052,12 +1052,12 @@ discard block |
||
1052 | 1052 | ); |
1053 | 1053 | } |
1054 | 1054 | |
1055 | - /** |
|
1056 | - * Checks whether it is possible to run PHP command |
|
1057 | - * line commands. |
|
1058 | - * |
|
1059 | - * @return boolean |
|
1060 | - */ |
|
1055 | + /** |
|
1056 | + * Checks whether it is possible to run PHP command |
|
1057 | + * line commands. |
|
1058 | + * |
|
1059 | + * @return boolean |
|
1060 | + */ |
|
1061 | 1061 | public static function canMakePHPCalls() : bool |
1062 | 1062 | { |
1063 | 1063 | return self::cliCommandExists('php'); |
@@ -1132,16 +1132,16 @@ discard block |
||
1132 | 1132 | return $result; |
1133 | 1133 | } |
1134 | 1134 | |
1135 | - /** |
|
1136 | - * Validates a PHP file's syntax. |
|
1137 | - * |
|
1138 | - * NOTE: This will fail silently if the PHP command line |
|
1139 | - * is not available. Use {@link FileHelper::canMakePHPCalls()} |
|
1140 | - * to check this beforehand as needed. |
|
1141 | - * |
|
1142 | - * @param string $path |
|
1143 | - * @return boolean|array A boolean true if the file is valid, an array with validation messages otherwise. |
|
1144 | - */ |
|
1135 | + /** |
|
1136 | + * Validates a PHP file's syntax. |
|
1137 | + * |
|
1138 | + * NOTE: This will fail silently if the PHP command line |
|
1139 | + * is not available. Use {@link FileHelper::canMakePHPCalls()} |
|
1140 | + * to check this beforehand as needed. |
|
1141 | + * |
|
1142 | + * @param string $path |
|
1143 | + * @return boolean|array A boolean true if the file is valid, an array with validation messages otherwise. |
|
1144 | + */ |
|
1145 | 1145 | public static function checkPHPFileSyntax($path) |
1146 | 1146 | { |
1147 | 1147 | if(!self::canMakePHPCalls()) { |
@@ -1165,14 +1165,14 @@ discard block |
||
1165 | 1165 | return $output; |
1166 | 1166 | } |
1167 | 1167 | |
1168 | - /** |
|
1169 | - * Retrieves the last modified date for the specified file or folder. |
|
1170 | - * |
|
1171 | - * Note: If the target does not exist, returns null. |
|
1172 | - * |
|
1173 | - * @param string $path |
|
1174 | - * @return \DateTime|NULL |
|
1175 | - */ |
|
1168 | + /** |
|
1169 | + * Retrieves the last modified date for the specified file or folder. |
|
1170 | + * |
|
1171 | + * Note: If the target does not exist, returns null. |
|
1172 | + * |
|
1173 | + * @param string $path |
|
1174 | + * @return \DateTime|NULL |
|
1175 | + */ |
|
1176 | 1176 | public static function getModifiedDate($path) |
1177 | 1177 | { |
1178 | 1178 | $time = filemtime($path); |
@@ -1185,22 +1185,22 @@ discard block |
||
1185 | 1185 | return null; |
1186 | 1186 | } |
1187 | 1187 | |
1188 | - /** |
|
1189 | - * Retrieves the names of all subfolders in the specified path. |
|
1190 | - * |
|
1191 | - * Available options: |
|
1192 | - * |
|
1193 | - * - recursive: true/false |
|
1194 | - * Whether to search for subfolders recursively. |
|
1195 | - * |
|
1196 | - * - absolute-paths: true/false |
|
1197 | - * Whether to return a list of absolute paths. |
|
1198 | - * |
|
1199 | - * @param string $targetFolder |
|
1200 | - * @param array $options |
|
1201 | - * @throws FileHelper_Exception |
|
1202 | - * @return string[] |
|
1203 | - */ |
|
1188 | + /** |
|
1189 | + * Retrieves the names of all subfolders in the specified path. |
|
1190 | + * |
|
1191 | + * Available options: |
|
1192 | + * |
|
1193 | + * - recursive: true/false |
|
1194 | + * Whether to search for subfolders recursively. |
|
1195 | + * |
|
1196 | + * - absolute-paths: true/false |
|
1197 | + * Whether to return a list of absolute paths. |
|
1198 | + * |
|
1199 | + * @param string $targetFolder |
|
1200 | + * @param array $options |
|
1201 | + * @throws FileHelper_Exception |
|
1202 | + * @return string[] |
|
1203 | + */ |
|
1204 | 1204 | public static function getSubfolders($targetFolder, $options = array()) |
1205 | 1205 | { |
1206 | 1206 | if(!is_dir($targetFolder)) |
@@ -1261,16 +1261,16 @@ discard block |
||
1261 | 1261 | return $result; |
1262 | 1262 | } |
1263 | 1263 | |
1264 | - /** |
|
1265 | - * Retrieves the maximum allowed upload file size, in bytes. |
|
1266 | - * Takes into account the PHP ini settings <code>post_max_size</code> |
|
1267 | - * and <code>upload_max_filesize</code>. Since these cannot |
|
1268 | - * be modified at runtime, they are the hard limits for uploads. |
|
1269 | - * |
|
1270 | - * NOTE: Based on binary values, where 1KB = 1024 Bytes. |
|
1271 | - * |
|
1272 | - * @return int Will return <code>-1</code> if no limit. |
|
1273 | - */ |
|
1264 | + /** |
|
1265 | + * Retrieves the maximum allowed upload file size, in bytes. |
|
1266 | + * Takes into account the PHP ini settings <code>post_max_size</code> |
|
1267 | + * and <code>upload_max_filesize</code>. Since these cannot |
|
1268 | + * be modified at runtime, they are the hard limits for uploads. |
|
1269 | + * |
|
1270 | + * NOTE: Based on binary values, where 1KB = 1024 Bytes. |
|
1271 | + * |
|
1272 | + * @return int Will return <code>-1</code> if no limit. |
|
1273 | + */ |
|
1274 | 1274 | public static function getMaxUploadFilesize() : int |
1275 | 1275 | { |
1276 | 1276 | static $max_size = -1; |
@@ -1307,16 +1307,16 @@ discard block |
||
1307 | 1307 | return round($size); |
1308 | 1308 | } |
1309 | 1309 | |
1310 | - /** |
|
1311 | - * Makes a path relative using a folder depth: will reduce the |
|
1312 | - * length of the path so that only the amount of folders defined |
|
1313 | - * in the <code>$depth</code> attribute are shown below the actual |
|
1314 | - * folder or file in the path. |
|
1315 | - * |
|
1316 | - * @param string $path The absolute or relative path |
|
1317 | - * @param int $depth The folder depth to reduce the path to |
|
1318 | - * @return string |
|
1319 | - */ |
|
1310 | + /** |
|
1311 | + * Makes a path relative using a folder depth: will reduce the |
|
1312 | + * length of the path so that only the amount of folders defined |
|
1313 | + * in the <code>$depth</code> attribute are shown below the actual |
|
1314 | + * folder or file in the path. |
|
1315 | + * |
|
1316 | + * @param string $path The absolute or relative path |
|
1317 | + * @param int $depth The folder depth to reduce the path to |
|
1318 | + * @return string |
|
1319 | + */ |
|
1320 | 1320 | public static function relativizePathByDepth(string $path, int $depth=2) : string |
1321 | 1321 | { |
1322 | 1322 | $path = self::normalizePath($path); |
@@ -1354,23 +1354,23 @@ discard block |
||
1354 | 1354 | return trim(implode('/', $tokens), '/'); |
1355 | 1355 | } |
1356 | 1356 | |
1357 | - /** |
|
1358 | - * Makes the specified path relative to another path, |
|
1359 | - * by removing one from the other if found. Also |
|
1360 | - * normalizes the path to use forward slashes. |
|
1361 | - * |
|
1362 | - * Example: |
|
1363 | - * |
|
1364 | - * <pre> |
|
1365 | - * relativizePath('c:\some\folder\to\file.txt', 'c:\some\folder'); |
|
1366 | - * </pre> |
|
1367 | - * |
|
1368 | - * Result: <code>to/file.txt</code> |
|
1369 | - * |
|
1370 | - * @param string $path |
|
1371 | - * @param string $relativeTo |
|
1372 | - * @return string |
|
1373 | - */ |
|
1357 | + /** |
|
1358 | + * Makes the specified path relative to another path, |
|
1359 | + * by removing one from the other if found. Also |
|
1360 | + * normalizes the path to use forward slashes. |
|
1361 | + * |
|
1362 | + * Example: |
|
1363 | + * |
|
1364 | + * <pre> |
|
1365 | + * relativizePath('c:\some\folder\to\file.txt', 'c:\some\folder'); |
|
1366 | + * </pre> |
|
1367 | + * |
|
1368 | + * Result: <code>to/file.txt</code> |
|
1369 | + * |
|
1370 | + * @param string $path |
|
1371 | + * @param string $relativeTo |
|
1372 | + * @return string |
|
1373 | + */ |
|
1374 | 1374 | public static function relativizePath(string $path, string $relativeTo) : string |
1375 | 1375 | { |
1376 | 1376 | $path = self::normalizePath($path); |
@@ -1382,17 +1382,17 @@ discard block |
||
1382 | 1382 | return $relative; |
1383 | 1383 | } |
1384 | 1384 | |
1385 | - /** |
|
1386 | - * Checks that the target file exists, and throws an exception |
|
1387 | - * if it does not. |
|
1388 | - * |
|
1389 | - * @param string $path |
|
1390 | - * @param int|NULL $errorCode Optional custom error code |
|
1391 | - * @throws FileHelper_Exception |
|
1392 | - * @return string The real path to the file |
|
1393 | - * |
|
1394 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
1395 | - */ |
|
1385 | + /** |
|
1386 | + * Checks that the target file exists, and throws an exception |
|
1387 | + * if it does not. |
|
1388 | + * |
|
1389 | + * @param string $path |
|
1390 | + * @param int|NULL $errorCode Optional custom error code |
|
1391 | + * @throws FileHelper_Exception |
|
1392 | + * @return string The real path to the file |
|
1393 | + * |
|
1394 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
1395 | + */ |
|
1396 | 1396 | public static function requireFileExists(string $path, $errorCode=null) : string |
1397 | 1397 | { |
1398 | 1398 | $result = realpath($path); |
@@ -1411,18 +1411,18 @@ discard block |
||
1411 | 1411 | ); |
1412 | 1412 | } |
1413 | 1413 | |
1414 | - /** |
|
1415 | - * Reads a specific line number from the target file and returns its |
|
1416 | - * contents, if the file has such a line. Does so with little memory |
|
1417 | - * usage, as the file is not read entirely into memory. |
|
1418 | - * |
|
1419 | - * @param string $path |
|
1420 | - * @param int $lineNumber Note: 1-based; the first line is number 1. |
|
1421 | - * @return string|NULL Will return null if the requested line does not exist. |
|
1422 | - * @throws FileHelper_Exception |
|
1423 | - * |
|
1424 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
1425 | - */ |
|
1414 | + /** |
|
1415 | + * Reads a specific line number from the target file and returns its |
|
1416 | + * contents, if the file has such a line. Does so with little memory |
|
1417 | + * usage, as the file is not read entirely into memory. |
|
1418 | + * |
|
1419 | + * @param string $path |
|
1420 | + * @param int $lineNumber Note: 1-based; the first line is number 1. |
|
1421 | + * @return string|NULL Will return null if the requested line does not exist. |
|
1422 | + * @throws FileHelper_Exception |
|
1423 | + * |
|
1424 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
1425 | + */ |
|
1426 | 1426 | public static function getLineFromFile(string $path, int $lineNumber) : ?string |
1427 | 1427 | { |
1428 | 1428 | self::requireFileExists($path); |
@@ -1438,19 +1438,19 @@ discard block |
||
1438 | 1438 | $file->seek($targetLine); |
1439 | 1439 | |
1440 | 1440 | if($file->key() !== $targetLine) { |
1441 | - return null; |
|
1441 | + return null; |
|
1442 | 1442 | } |
1443 | 1443 | |
1444 | 1444 | return $file->current(); |
1445 | 1445 | } |
1446 | 1446 | |
1447 | - /** |
|
1448 | - * Retrieves the total amount of lines in the file, without |
|
1449 | - * reading the whole file into memory. |
|
1450 | - * |
|
1451 | - * @param string $path |
|
1452 | - * @return int |
|
1453 | - */ |
|
1447 | + /** |
|
1448 | + * Retrieves the total amount of lines in the file, without |
|
1449 | + * reading the whole file into memory. |
|
1450 | + * |
|
1451 | + * @param string $path |
|
1452 | + * @return int |
|
1453 | + */ |
|
1454 | 1454 | public static function countFileLines(string $path) : int |
1455 | 1455 | { |
1456 | 1456 | self::requireFileExists($path); |
@@ -1480,26 +1480,26 @@ discard block |
||
1480 | 1480 | return $number+1; |
1481 | 1481 | } |
1482 | 1482 | |
1483 | - /** |
|
1484 | - * Parses the target file to detect any PHP classes contained |
|
1485 | - * within, and retrieve information on them. Does not use the |
|
1486 | - * PHP reflection API. |
|
1487 | - * |
|
1488 | - * @param string $filePath |
|
1489 | - * @return FileHelper_PHPClassInfo |
|
1490 | - */ |
|
1483 | + /** |
|
1484 | + * Parses the target file to detect any PHP classes contained |
|
1485 | + * within, and retrieve information on them. Does not use the |
|
1486 | + * PHP reflection API. |
|
1487 | + * |
|
1488 | + * @param string $filePath |
|
1489 | + * @return FileHelper_PHPClassInfo |
|
1490 | + */ |
|
1491 | 1491 | public static function findPHPClasses(string $filePath) : FileHelper_PHPClassInfo |
1492 | 1492 | { |
1493 | 1493 | return new FileHelper_PHPClassInfo($filePath); |
1494 | 1494 | } |
1495 | 1495 | |
1496 | - /** |
|
1497 | - * Detects the end of line style used in the target file, if any. |
|
1498 | - * Can be used with large files, because it only reads part of it. |
|
1499 | - * |
|
1500 | - * @param string $filePath The path to the file. |
|
1501 | - * @return NULL|ConvertHelper_EOL The end of line character information, or NULL if none is found. |
|
1502 | - */ |
|
1496 | + /** |
|
1497 | + * Detects the end of line style used in the target file, if any. |
|
1498 | + * Can be used with large files, because it only reads part of it. |
|
1499 | + * |
|
1500 | + * @param string $filePath The path to the file. |
|
1501 | + * @return NULL|ConvertHelper_EOL The end of line character information, or NULL if none is found. |
|
1502 | + */ |
|
1503 | 1503 | public static function detectEOLCharacter(string $filePath) : ?ConvertHelper_EOL |
1504 | 1504 | { |
1505 | 1505 | // 20 lines is enough to get a good picture of the newline style in the file. |
@@ -1512,18 +1512,18 @@ discard block |
||
1512 | 1512 | return ConvertHelper::detectEOLCharacter($string); |
1513 | 1513 | } |
1514 | 1514 | |
1515 | - /** |
|
1516 | - * Reads the specified amount of lines from the target file. |
|
1517 | - * Unicode BOM compatible: any byte order marker is stripped |
|
1518 | - * from the resulting lines. |
|
1519 | - * |
|
1520 | - * @param string $filePath |
|
1521 | - * @param int $amount Set to 0 to read all lines. |
|
1522 | - * @return array |
|
1523 | - * |
|
1524 | - * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES |
|
1525 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
1526 | - */ |
|
1515 | + /** |
|
1516 | + * Reads the specified amount of lines from the target file. |
|
1517 | + * Unicode BOM compatible: any byte order marker is stripped |
|
1518 | + * from the resulting lines. |
|
1519 | + * |
|
1520 | + * @param string $filePath |
|
1521 | + * @param int $amount Set to 0 to read all lines. |
|
1522 | + * @return array |
|
1523 | + * |
|
1524 | + * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES |
|
1525 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
1526 | + */ |
|
1527 | 1527 | public static function readLines(string $filePath, int $amount=0) : array |
1528 | 1528 | { |
1529 | 1529 | self::requireFileExists($filePath); |
@@ -1574,16 +1574,16 @@ discard block |
||
1574 | 1574 | return $result; |
1575 | 1575 | } |
1576 | 1576 | |
1577 | - /** |
|
1578 | - * Reads all content from a file. |
|
1579 | - * |
|
1580 | - * @param string $filePath |
|
1581 | - * @throws FileHelper_Exception |
|
1582 | - * @return string |
|
1583 | - * |
|
1584 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
1585 | - * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS |
|
1586 | - */ |
|
1577 | + /** |
|
1578 | + * Reads all content from a file. |
|
1579 | + * |
|
1580 | + * @param string $filePath |
|
1581 | + * @throws FileHelper_Exception |
|
1582 | + * @return string |
|
1583 | + * |
|
1584 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
1585 | + * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS |
|
1586 | + */ |
|
1587 | 1587 | public static function readContents(string $filePath) : string |
1588 | 1588 | { |
1589 | 1589 | self::requireFileExists($filePath); |
@@ -112,7 +112,7 @@ discard block |
||
112 | 112 | |
113 | 113 | $contents = file_get_contents($file); |
114 | 114 | |
115 | - if($contents === false) |
|
115 | + if ($contents === false) |
|
116 | 116 | { |
117 | 117 | throw new FileHelper_Exception( |
118 | 118 | 'Cannot load serialized content from file.', |
@@ -126,7 +126,7 @@ discard block |
||
126 | 126 | |
127 | 127 | $result = @unserialize($contents); |
128 | 128 | |
129 | - if($result !== false) { |
|
129 | + if ($result !== false) { |
|
130 | 130 | return $result; |
131 | 131 | } |
132 | 132 | |
@@ -142,7 +142,7 @@ discard block |
||
142 | 142 | |
143 | 143 | public static function deleteTree($rootFolder) |
144 | 144 | { |
145 | - if(!file_exists($rootFolder)) { |
|
145 | + if (!file_exists($rootFolder)) { |
|
146 | 146 | return true; |
147 | 147 | } |
148 | 148 | |
@@ -183,7 +183,7 @@ discard block |
||
183 | 183 | */ |
184 | 184 | public static function createFolder($path) |
185 | 185 | { |
186 | - if(is_dir($path) || mkdir($path, 0777, true)) { |
|
186 | + if (is_dir($path) || mkdir($path, 0777, true)) { |
|
187 | 187 | return; |
188 | 188 | } |
189 | 189 | |
@@ -218,11 +218,11 @@ discard block |
||
218 | 218 | |
219 | 219 | if ($item->isDir()) |
220 | 220 | { |
221 | - FileHelper::copyTree(str_replace('\\', '/', $itemPath), $target . '/' . $baseName); |
|
221 | + FileHelper::copyTree(str_replace('\\', '/', $itemPath), $target.'/'.$baseName); |
|
222 | 222 | } |
223 | - else if($item->isFile()) |
|
223 | + else if ($item->isFile()) |
|
224 | 224 | { |
225 | - self::copyFile($itemPath, $target . '/' . $baseName); |
|
225 | + self::copyFile($itemPath, $target.'/'.$baseName); |
|
226 | 226 | } |
227 | 227 | } |
228 | 228 | } |
@@ -247,7 +247,7 @@ discard block |
||
247 | 247 | { |
248 | 248 | self::requireFileExists($sourcePath, self::ERROR_SOURCE_FILE_NOT_FOUND); |
249 | 249 | |
250 | - if(!is_readable($sourcePath)) |
|
250 | + if (!is_readable($sourcePath)) |
|
251 | 251 | { |
252 | 252 | throw new FileHelper_Exception( |
253 | 253 | sprintf('Source file [%s] to copy is not readable.', basename($sourcePath)), |
@@ -261,11 +261,11 @@ discard block |
||
261 | 261 | |
262 | 262 | $targetFolder = dirname($targetPath); |
263 | 263 | |
264 | - if(!file_exists($targetFolder)) |
|
264 | + if (!file_exists($targetFolder)) |
|
265 | 265 | { |
266 | 266 | self::createFolder($targetFolder); |
267 | 267 | } |
268 | - else if(!is_writable($targetFolder)) |
|
268 | + else if (!is_writable($targetFolder)) |
|
269 | 269 | { |
270 | 270 | throw new FileHelper_Exception( |
271 | 271 | sprintf('Target folder [%s] is not writable.', basename($targetFolder)), |
@@ -277,7 +277,7 @@ discard block |
||
277 | 277 | ); |
278 | 278 | } |
279 | 279 | |
280 | - if(copy($sourcePath, $targetPath)) { |
|
280 | + if (copy($sourcePath, $targetPath)) { |
|
281 | 281 | return; |
282 | 282 | } |
283 | 283 | |
@@ -304,11 +304,11 @@ discard block |
||
304 | 304 | */ |
305 | 305 | public static function deleteFile(string $filePath) : void |
306 | 306 | { |
307 | - if(!file_exists($filePath)) { |
|
307 | + if (!file_exists($filePath)) { |
|
308 | 308 | return; |
309 | 309 | } |
310 | 310 | |
311 | - if(unlink($filePath)) { |
|
311 | + if (unlink($filePath)) { |
|
312 | 312 | return; |
313 | 313 | } |
314 | 314 | |
@@ -332,10 +332,10 @@ discard block |
||
332 | 332 | * @return \parseCSV |
333 | 333 | * @todo Move this to the CSV helper. |
334 | 334 | */ |
335 | - public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : \parseCSV |
|
335 | + public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : \parseCSV |
|
336 | 336 | { |
337 | - if($delimiter==='') { $delimiter = ';'; } |
|
338 | - if($enclosure==='') { $enclosure = '"'; } |
|
337 | + if ($delimiter === '') { $delimiter = ';'; } |
|
338 | + if ($enclosure === '') { $enclosure = '"'; } |
|
339 | 339 | |
340 | 340 | $parser = new \parseCSV(null, null, null, array()); |
341 | 341 | |
@@ -363,11 +363,11 @@ discard block |
||
363 | 363 | * @see parseCSVFile() |
364 | 364 | * @see FileHelper::ERROR_PARSING_CSV |
365 | 365 | */ |
366 | - public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array |
|
366 | + public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : array |
|
367 | 367 | { |
368 | 368 | $parser = self::createCSVParser($delimiter, $enclosure, $escape, $heading); |
369 | 369 | $result = $parser->parse_string(/** @scrutinizer ignore-type */ $csv); |
370 | - if(is_array($result)) { |
|
370 | + if (is_array($result)) { |
|
371 | 371 | return $result; |
372 | 372 | } |
373 | 373 | |
@@ -395,7 +395,7 @@ discard block |
||
395 | 395 | * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
396 | 396 | * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS |
397 | 397 | */ |
398 | - public static function parseCSVFile(string $filePath, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array |
|
398 | + public static function parseCSVFile(string $filePath, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : array |
|
399 | 399 | { |
400 | 400 | $content = self::readContents($filePath); |
401 | 401 | |
@@ -412,7 +412,7 @@ discard block |
||
412 | 412 | public static function detectMimeType(string $fileName) : ?string |
413 | 413 | { |
414 | 414 | $ext = self::getExtension($fileName); |
415 | - if(empty($ext)) { |
|
415 | + if (empty($ext)) { |
|
416 | 416 | return null; |
417 | 417 | } |
418 | 418 | |
@@ -433,11 +433,11 @@ discard block |
||
433 | 433 | * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
434 | 434 | * @see FileHelper::ERROR_UNKNOWN_FILE_MIME_TYPE |
435 | 435 | */ |
436 | - public static function sendFile(string $filePath, $fileName = null, bool $asAttachment=true) |
|
436 | + public static function sendFile(string $filePath, $fileName = null, bool $asAttachment = true) |
|
437 | 437 | { |
438 | 438 | self::requireFileExists($filePath); |
439 | 439 | |
440 | - if(empty($fileName)) { |
|
440 | + if (empty($fileName)) { |
|
441 | 441 | $fileName = basename($filePath); |
442 | 442 | } |
443 | 443 | |
@@ -455,10 +455,10 @@ discard block |
||
455 | 455 | |
456 | 456 | header("Cache-Control: public", true); |
457 | 457 | header("Content-Description: File Transfer", true); |
458 | - header("Content-Type: " . $mime, true); |
|
458 | + header("Content-Type: ".$mime, true); |
|
459 | 459 | |
460 | 460 | $disposition = 'inline'; |
461 | - if($asAttachment) { |
|
461 | + if ($asAttachment) { |
|
462 | 462 | $disposition = 'attachment'; |
463 | 463 | } |
464 | 464 | |
@@ -484,7 +484,7 @@ discard block |
||
484 | 484 | */ |
485 | 485 | public static function downloadFile($url) |
486 | 486 | { |
487 | - if(!function_exists('curl_init')) |
|
487 | + if (!function_exists('curl_init')) |
|
488 | 488 | { |
489 | 489 | throw new FileHelper_Exception( |
490 | 490 | 'The cURL extension is not installed.', |
@@ -494,7 +494,7 @@ discard block |
||
494 | 494 | } |
495 | 495 | |
496 | 496 | $ch = curl_init(); |
497 | - if($ch === false) |
|
497 | + if ($ch === false) |
|
498 | 498 | { |
499 | 499 | throw new FileHelper_Exception( |
500 | 500 | 'Could not initialize a new cURL instance.', |
@@ -515,7 +515,7 @@ discard block |
||
515 | 515 | |
516 | 516 | $output = curl_exec($ch); |
517 | 517 | |
518 | - if($output === false) { |
|
518 | + if ($output === false) { |
|
519 | 519 | throw new FileHelper_Exception( |
520 | 520 | 'Unable to open URL', |
521 | 521 | sprintf( |
@@ -529,7 +529,7 @@ discard block |
||
529 | 529 | |
530 | 530 | curl_close($ch); |
531 | 531 | |
532 | - if(is_string($output)) |
|
532 | + if (is_string($output)) |
|
533 | 533 | { |
534 | 534 | return $output; |
535 | 535 | } |
@@ -551,7 +551,7 @@ discard block |
||
551 | 551 | */ |
552 | 552 | public static function isPHPFile($pathOrDirIterator) |
553 | 553 | { |
554 | - if(self::getExtension($pathOrDirIterator) == 'php') { |
|
554 | + if (self::getExtension($pathOrDirIterator) == 'php') { |
|
555 | 555 | return true; |
556 | 556 | } |
557 | 557 | |
@@ -568,14 +568,14 @@ discard block |
||
568 | 568 | */ |
569 | 569 | public static function getExtension($pathOrDirIterator, bool $lowercase = true) : string |
570 | 570 | { |
571 | - if($pathOrDirIterator instanceof \DirectoryIterator) { |
|
571 | + if ($pathOrDirIterator instanceof \DirectoryIterator) { |
|
572 | 572 | $filename = $pathOrDirIterator->getFilename(); |
573 | 573 | } else { |
574 | 574 | $filename = basename($pathOrDirIterator); |
575 | 575 | } |
576 | 576 | |
577 | 577 | $ext = pathinfo($filename, PATHINFO_EXTENSION); |
578 | - if($lowercase) { |
|
578 | + if ($lowercase) { |
|
579 | 579 | $ext = mb_strtolower($ext); |
580 | 580 | } |
581 | 581 | |
@@ -597,13 +597,13 @@ discard block |
||
597 | 597 | public static function getFilename($pathOrDirIterator, $extension = true) |
598 | 598 | { |
599 | 599 | $path = $pathOrDirIterator; |
600 | - if($pathOrDirIterator instanceof \DirectoryIterator) { |
|
600 | + if ($pathOrDirIterator instanceof \DirectoryIterator) { |
|
601 | 601 | $path = $pathOrDirIterator->getFilename(); |
602 | 602 | } |
603 | 603 | |
604 | 604 | $path = self::normalizePath($path); |
605 | 605 | |
606 | - if(!$extension) { |
|
606 | + if (!$extension) { |
|
607 | 607 | return pathinfo($path, PATHINFO_FILENAME); |
608 | 608 | } |
609 | 609 | |
@@ -621,12 +621,12 @@ discard block |
||
621 | 621 | * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE |
622 | 622 | * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE |
623 | 623 | */ |
624 | - public static function parseJSONFile(string $file, $targetEncoding=null, $sourceEncoding=null) |
|
624 | + public static function parseJSONFile(string $file, $targetEncoding = null, $sourceEncoding = null) |
|
625 | 625 | { |
626 | 626 | self::requireFileExists($file, self::ERROR_CANNOT_FIND_JSON_FILE); |
627 | 627 | |
628 | 628 | $content = file_get_contents($file); |
629 | - if(!$content) { |
|
629 | + if (!$content) { |
|
630 | 630 | throw new FileHelper_Exception( |
631 | 631 | 'Cannot get file contents', |
632 | 632 | sprintf( |
@@ -637,12 +637,12 @@ discard block |
||
637 | 637 | ); |
638 | 638 | } |
639 | 639 | |
640 | - if(isset($targetEncoding)) { |
|
640 | + if (isset($targetEncoding)) { |
|
641 | 641 | $content = mb_convert_encoding($content, $targetEncoding, $sourceEncoding); |
642 | 642 | } |
643 | 643 | |
644 | 644 | $json = json_decode($content, true); |
645 | - if($json === false || $json === NULL) { |
|
645 | + if ($json === false || $json === NULL) { |
|
646 | 646 | throw new FileHelper_Exception( |
647 | 647 | 'Cannot decode json data', |
648 | 648 | sprintf( |
@@ -682,13 +682,13 @@ discard block |
||
682 | 682 | |
683 | 683 | $name = str_replace(array_keys($replaces), array_values($replaces), $name); |
684 | 684 | |
685 | - while(strstr($name, ' ')) { |
|
685 | + while (strstr($name, ' ')) { |
|
686 | 686 | $name = str_replace(' ', ' ', $name); |
687 | 687 | } |
688 | 688 | |
689 | 689 | $name = str_replace(array_keys($replaces), array_values($replaces), $name); |
690 | 690 | |
691 | - while(strstr($name, '..')) { |
|
691 | + while (strstr($name, '..')) { |
|
692 | 692 | $name = str_replace('..', '.', $name); |
693 | 693 | } |
694 | 694 | |
@@ -718,7 +718,7 @@ discard block |
||
718 | 718 | * |
719 | 719 | * @todo Convert this to use the file finder. |
720 | 720 | */ |
721 | - public static function findHTMLFiles(string $targetFolder, array $options=array()) : array |
|
721 | + public static function findHTMLFiles(string $targetFolder, array $options = array()) : array |
|
722 | 722 | { |
723 | 723 | return self::findFiles($targetFolder, array('html'), $options); |
724 | 724 | } |
@@ -733,7 +733,7 @@ discard block |
||
733 | 733 | * |
734 | 734 | * @todo Convert this to use the file finder. |
735 | 735 | */ |
736 | - public static function findPHPFiles(string $targetFolder, array $options=array()) : array |
|
736 | + public static function findPHPFiles(string $targetFolder, array $options = array()) : array |
|
737 | 737 | { |
738 | 738 | return self::findFiles($targetFolder, array('php'), $options); |
739 | 739 | } |
@@ -749,39 +749,39 @@ discard block |
||
749 | 749 | * @see FileHelper::createFileFinder() |
750 | 750 | * @todo Convert this to use the file finder. |
751 | 751 | */ |
752 | - public static function findFiles(string $targetFolder, array $extensions=array(), array $options=array(), array $files=array()) : array |
|
752 | + public static function findFiles(string $targetFolder, array $extensions = array(), array $options = array(), array $files = array()) : array |
|
753 | 753 | { |
754 | - if(!isset($options['strip-extension'])) { |
|
754 | + if (!isset($options['strip-extension'])) { |
|
755 | 755 | $options['strip-extension'] = false; |
756 | 756 | } |
757 | 757 | |
758 | - if(!isset($options['absolute-path'])) { |
|
758 | + if (!isset($options['absolute-path'])) { |
|
759 | 759 | $options['absolute-path'] = false; |
760 | 760 | } |
761 | 761 | |
762 | - if(!isset($options['relative-path'])) { |
|
762 | + if (!isset($options['relative-path'])) { |
|
763 | 763 | $options['relative-path'] = false; |
764 | 764 | } |
765 | 765 | |
766 | - if(!isset($options['recursive'])) { |
|
766 | + if (!isset($options['recursive'])) { |
|
767 | 767 | $options['recursive'] = false; |
768 | 768 | } |
769 | 769 | |
770 | - if($options['relative-path']) { |
|
770 | + if ($options['relative-path']) { |
|
771 | 771 | $options['absolute-path'] = true; |
772 | 772 | } |
773 | 773 | |
774 | - if(!isset($options['__root'])) { |
|
774 | + if (!isset($options['__root'])) { |
|
775 | 775 | $options['__root'] = self::normalizePath($targetFolder); |
776 | 776 | } |
777 | 777 | |
778 | 778 | $checkExtensions = false; |
779 | - if(!empty($extensions)) { |
|
779 | + if (!empty($extensions)) { |
|
780 | 780 | $checkExtensions = true; |
781 | 781 | $extensions = array_map('strtolower', $extensions); |
782 | 782 | } |
783 | 783 | |
784 | - if(!is_dir($targetFolder)) |
|
784 | + if (!is_dir($targetFolder)) |
|
785 | 785 | { |
786 | 786 | throw new FileHelper_Exception( |
787 | 787 | 'Target folder does not exist', |
@@ -794,32 +794,32 @@ discard block |
||
794 | 794 | } |
795 | 795 | |
796 | 796 | $d = new \DirectoryIterator($targetFolder); |
797 | - foreach($d as $item) { |
|
798 | - if($item->isDot()) { |
|
797 | + foreach ($d as $item) { |
|
798 | + if ($item->isDot()) { |
|
799 | 799 | continue; |
800 | 800 | } |
801 | 801 | |
802 | - if($item->isDir()) { |
|
803 | - if($options['recursive']) { |
|
802 | + if ($item->isDir()) { |
|
803 | + if ($options['recursive']) { |
|
804 | 804 | $files = self::findFiles($item->getPathname(), $extensions, $options, $files); |
805 | 805 | } |
806 | 806 | continue; |
807 | 807 | } |
808 | 808 | |
809 | - if($checkExtensions && !in_array(self::getExtension($item, true), $extensions)) { |
|
809 | + if ($checkExtensions && !in_array(self::getExtension($item, true), $extensions)) { |
|
810 | 810 | continue; |
811 | 811 | } |
812 | 812 | |
813 | 813 | $filename = $item->getFilename(); |
814 | - if($options['strip-extension']) { |
|
814 | + if ($options['strip-extension']) { |
|
815 | 815 | $filename = self::removeExtension($filename); |
816 | 816 | } |
817 | 817 | |
818 | - if($options['absolute-path']) { |
|
818 | + if ($options['absolute-path']) { |
|
819 | 819 | $filename = self::normalizePath($targetFolder.'/'.$filename); |
820 | 820 | } |
821 | 821 | |
822 | - if($options['relative-path']) { |
|
822 | + if ($options['relative-path']) { |
|
823 | 823 | $filename = ltrim(str_replace($options['__root'], '', $filename), '/'); |
824 | 824 | } |
825 | 825 | |
@@ -863,7 +863,7 @@ discard block |
||
863 | 863 | public static function detectUTFBom(string $filename) : ?string |
864 | 864 | { |
865 | 865 | $fp = fopen($filename, 'r'); |
866 | - if($fp === false) |
|
866 | + if ($fp === false) |
|
867 | 867 | { |
868 | 868 | throw new FileHelper_Exception( |
869 | 869 | 'Cannot open file for reading', |
@@ -878,10 +878,10 @@ discard block |
||
878 | 878 | |
879 | 879 | $boms = self::getUTFBOMs(); |
880 | 880 | |
881 | - foreach($boms as $bom => $value) |
|
881 | + foreach ($boms as $bom => $value) |
|
882 | 882 | { |
883 | 883 | $length = mb_strlen($value); |
884 | - if(mb_substr($text, 0, $length) == $value) { |
|
884 | + if (mb_substr($text, 0, $length) == $value) { |
|
885 | 885 | return $bom; |
886 | 886 | } |
887 | 887 | } |
@@ -900,13 +900,13 @@ discard block |
||
900 | 900 | */ |
901 | 901 | public static function getUTFBOMs() |
902 | 902 | { |
903 | - if(!isset(self::$utfBoms)) { |
|
903 | + if (!isset(self::$utfBoms)) { |
|
904 | 904 | self::$utfBoms = array( |
905 | - 'UTF32-BE' => chr(0x00) . chr(0x00) . chr(0xFE) . chr(0xFF), |
|
906 | - 'UTF32-LE' => chr(0xFF) . chr(0xFE) . chr(0x00) . chr(0x00), |
|
907 | - 'UTF16-BE' => chr(0xFE) . chr(0xFF), |
|
908 | - 'UTF16-LE' => chr(0xFF) . chr(0xFE), |
|
909 | - 'UTF8' => chr(0xEF) . chr(0xBB) . chr(0xBF) |
|
905 | + 'UTF32-BE' => chr(0x00).chr(0x00).chr(0xFE).chr(0xFF), |
|
906 | + 'UTF32-LE' => chr(0xFF).chr(0xFE).chr(0x00).chr(0x00), |
|
907 | + 'UTF16-BE' => chr(0xFE).chr(0xFF), |
|
908 | + 'UTF16-LE' => chr(0xFF).chr(0xFE), |
|
909 | + 'UTF8' => chr(0xEF).chr(0xBB).chr(0xBF) |
|
910 | 910 | ); |
911 | 911 | } |
912 | 912 | |
@@ -927,7 +927,7 @@ discard block |
||
927 | 927 | $encodings = self::getKnownUnicodeEncodings(); |
928 | 928 | |
929 | 929 | $keep = array(); |
930 | - foreach($encodings as $string) |
|
930 | + foreach ($encodings as $string) |
|
931 | 931 | { |
932 | 932 | $withHyphen = str_replace('UTF', 'UTF-', $string); |
933 | 933 | |
@@ -961,15 +961,15 @@ discard block |
||
961 | 961 | return str_replace(array('\\', '//'), array('/', '/'), $path); |
962 | 962 | } |
963 | 963 | |
964 | - public static function saveAsJSON($data, $file, $pretty=false) |
|
964 | + public static function saveAsJSON($data, $file, $pretty = false) |
|
965 | 965 | { |
966 | 966 | $options = null; |
967 | - if($pretty) { |
|
967 | + if ($pretty) { |
|
968 | 968 | $options = JSON_PRETTY_PRINT; |
969 | 969 | } |
970 | 970 | |
971 | 971 | $json = json_encode($data, $options); |
972 | - if($json===false) |
|
972 | + if ($json === false) |
|
973 | 973 | { |
974 | 974 | $errorCode = json_last_error(); |
975 | 975 | throw new FileHelper_Exception( |
@@ -979,7 +979,7 @@ discard block |
||
979 | 979 | ); |
980 | 980 | } |
981 | 981 | |
982 | - if(!file_put_contents($file, $json)) { |
|
982 | + if (!file_put_contents($file, $json)) { |
|
983 | 983 | throw new FileHelper_Exception( |
984 | 984 | sprintf('Could not write the JSON file [%s] to disk.', basename($file)), |
985 | 985 | sprintf('Full path: [%s].', $file), |
@@ -1000,12 +1000,12 @@ discard block |
||
1000 | 1000 | * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
1001 | 1001 | * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
1002 | 1002 | */ |
1003 | - public static function saveFile(string $filePath, string $content='') : void |
|
1003 | + public static function saveFile(string $filePath, string $content = '') : void |
|
1004 | 1004 | { |
1005 | 1005 | // target file already exists |
1006 | - if(file_exists($filePath)) |
|
1006 | + if (file_exists($filePath)) |
|
1007 | 1007 | { |
1008 | - if(!is_writable($filePath)) |
|
1008 | + if (!is_writable($filePath)) |
|
1009 | 1009 | { |
1010 | 1010 | throw new FileHelper_Exception( |
1011 | 1011 | sprintf('Cannot save file: target file [%s] exists, but is not writable.', basename($filePath)), |
@@ -1025,7 +1025,7 @@ discard block |
||
1025 | 1025 | // create the folder as needed |
1026 | 1026 | self::createFolder($targetFolder); |
1027 | 1027 | |
1028 | - if(!is_writable($targetFolder)) |
|
1028 | + if (!is_writable($targetFolder)) |
|
1029 | 1029 | { |
1030 | 1030 | throw new FileHelper_Exception( |
1031 | 1031 | sprintf('Cannot save file: target folder [%s] is not writable.', basename($targetFolder)), |
@@ -1038,7 +1038,7 @@ discard block |
||
1038 | 1038 | } |
1039 | 1039 | } |
1040 | 1040 | |
1041 | - if(file_put_contents($filePath, $content) !== false) { |
|
1041 | + if (file_put_contents($filePath, $content) !== false) { |
|
1042 | 1042 | return; |
1043 | 1043 | } |
1044 | 1044 | |
@@ -1074,7 +1074,7 @@ discard block |
||
1074 | 1074 | { |
1075 | 1075 | static $checked = array(); |
1076 | 1076 | |
1077 | - if(isset($checked[$command])) { |
|
1077 | + if (isset($checked[$command])) { |
|
1078 | 1078 | return $checked[$command]; |
1079 | 1079 | } |
1080 | 1080 | |
@@ -1087,7 +1087,7 @@ discard block |
||
1087 | 1087 | |
1088 | 1088 | $os = strtolower(PHP_OS_FAMILY); |
1089 | 1089 | |
1090 | - if(!isset($osCommands[$os])) |
|
1090 | + if (!isset($osCommands[$os])) |
|
1091 | 1091 | { |
1092 | 1092 | throw new FileHelper_Exception( |
1093 | 1093 | 'Unsupported OS for CLI commands', |
@@ -1113,7 +1113,7 @@ discard block |
||
1113 | 1113 | $pipes |
1114 | 1114 | ); |
1115 | 1115 | |
1116 | - if($process === false) { |
|
1116 | + if ($process === false) { |
|
1117 | 1117 | $checked[$command] = false; |
1118 | 1118 | return false; |
1119 | 1119 | } |
@@ -1144,7 +1144,7 @@ discard block |
||
1144 | 1144 | */ |
1145 | 1145 | public static function checkPHPFileSyntax($path) |
1146 | 1146 | { |
1147 | - if(!self::canMakePHPCalls()) { |
|
1147 | + if (!self::canMakePHPCalls()) { |
|
1148 | 1148 | return true; |
1149 | 1149 | } |
1150 | 1150 | |
@@ -1155,7 +1155,7 @@ discard block |
||
1155 | 1155 | // when the validation is successful, the first entry |
1156 | 1156 | // in the array contains the success message. When it |
1157 | 1157 | // is invalid, the first entry is always empty. |
1158 | - if(!empty($output[0])) { |
|
1158 | + if (!empty($output[0])) { |
|
1159 | 1159 | return true; |
1160 | 1160 | } |
1161 | 1161 | |
@@ -1176,7 +1176,7 @@ discard block |
||
1176 | 1176 | public static function getModifiedDate($path) |
1177 | 1177 | { |
1178 | 1178 | $time = filemtime($path); |
1179 | - if($time !== false) { |
|
1179 | + if ($time !== false) { |
|
1180 | 1180 | $date = new \DateTime(); |
1181 | 1181 | $date->setTimestamp($time); |
1182 | 1182 | return $date; |
@@ -1203,7 +1203,7 @@ discard block |
||
1203 | 1203 | */ |
1204 | 1204 | public static function getSubfolders($targetFolder, $options = array()) |
1205 | 1205 | { |
1206 | - if(!is_dir($targetFolder)) |
|
1206 | + if (!is_dir($targetFolder)) |
|
1207 | 1207 | { |
1208 | 1208 | throw new FileHelper_Exception( |
1209 | 1209 | 'Target folder does not exist', |
@@ -1227,29 +1227,29 @@ discard block |
||
1227 | 1227 | |
1228 | 1228 | $d = new \DirectoryIterator($targetFolder); |
1229 | 1229 | |
1230 | - foreach($d as $item) |
|
1230 | + foreach ($d as $item) |
|
1231 | 1231 | { |
1232 | - if($item->isDir() && !$item->isDot()) |
|
1232 | + if ($item->isDir() && !$item->isDot()) |
|
1233 | 1233 | { |
1234 | 1234 | $name = $item->getFilename(); |
1235 | 1235 | |
1236 | - if(!$options['absolute-path']) { |
|
1236 | + if (!$options['absolute-path']) { |
|
1237 | 1237 | $result[] = $name; |
1238 | 1238 | } else { |
1239 | 1239 | $result[] = $targetFolder.'/'.$name; |
1240 | 1240 | } |
1241 | 1241 | |
1242 | - if(!$options['recursive']) |
|
1242 | + if (!$options['recursive']) |
|
1243 | 1243 | { |
1244 | 1244 | continue; |
1245 | 1245 | } |
1246 | 1246 | |
1247 | 1247 | $subs = self::getSubfolders($targetFolder.'/'.$name, $options); |
1248 | - foreach($subs as $sub) |
|
1248 | + foreach ($subs as $sub) |
|
1249 | 1249 | { |
1250 | 1250 | $relative = $name.'/'.$sub; |
1251 | 1251 | |
1252 | - if(!$options['absolute-path']) { |
|
1252 | + if (!$options['absolute-path']) { |
|
1253 | 1253 | $result[] = $relative; |
1254 | 1254 | } else { |
1255 | 1255 | $result[] = $targetFolder.'/'.$relative; |
@@ -1317,7 +1317,7 @@ discard block |
||
1317 | 1317 | * @param int $depth The folder depth to reduce the path to |
1318 | 1318 | * @return string |
1319 | 1319 | */ |
1320 | - public static function relativizePathByDepth(string $path, int $depth=2) : string |
|
1320 | + public static function relativizePathByDepth(string $path, int $depth = 2) : string |
|
1321 | 1321 | { |
1322 | 1322 | $path = self::normalizePath($path); |
1323 | 1323 | |
@@ -1325,17 +1325,17 @@ discard block |
||
1325 | 1325 | $tokens = array_filter($tokens); // remove empty entries (trailing slash for example) |
1326 | 1326 | $tokens = array_values($tokens); // re-index keys |
1327 | 1327 | |
1328 | - if(empty($tokens)) { |
|
1328 | + if (empty($tokens)) { |
|
1329 | 1329 | return ''; |
1330 | 1330 | } |
1331 | 1331 | |
1332 | 1332 | // remove the drive if present |
1333 | - if(strstr($tokens[0], ':')) { |
|
1333 | + if (strstr($tokens[0], ':')) { |
|
1334 | 1334 | array_shift($tokens); |
1335 | 1335 | } |
1336 | 1336 | |
1337 | 1337 | // path was only the drive |
1338 | - if(count($tokens) == 0) { |
|
1338 | + if (count($tokens) == 0) { |
|
1339 | 1339 | return ''; |
1340 | 1340 | } |
1341 | 1341 | |
@@ -1344,8 +1344,8 @@ discard block |
||
1344 | 1344 | |
1345 | 1345 | // reduce the path to the specified depth |
1346 | 1346 | $length = count($tokens); |
1347 | - if($length > $depth) { |
|
1348 | - $tokens = array_slice($tokens, $length-$depth); |
|
1347 | + if ($length > $depth) { |
|
1348 | + $tokens = array_slice($tokens, $length - $depth); |
|
1349 | 1349 | } |
1350 | 1350 | |
1351 | 1351 | // append the last element again |
@@ -1393,14 +1393,14 @@ discard block |
||
1393 | 1393 | * |
1394 | 1394 | * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
1395 | 1395 | */ |
1396 | - public static function requireFileExists(string $path, $errorCode=null) : string |
|
1396 | + public static function requireFileExists(string $path, $errorCode = null) : string |
|
1397 | 1397 | { |
1398 | 1398 | $result = realpath($path); |
1399 | - if($result !== false) { |
|
1399 | + if ($result !== false) { |
|
1400 | 1400 | return $result; |
1401 | 1401 | } |
1402 | 1402 | |
1403 | - if($errorCode === null) { |
|
1403 | + if ($errorCode === null) { |
|
1404 | 1404 | $errorCode = self::ERROR_FILE_DOES_NOT_EXIST; |
1405 | 1405 | } |
1406 | 1406 | |
@@ -1429,15 +1429,15 @@ discard block |
||
1429 | 1429 | |
1430 | 1430 | $file = new \SplFileObject($path); |
1431 | 1431 | |
1432 | - if($file->eof()) { |
|
1432 | + if ($file->eof()) { |
|
1433 | 1433 | return ''; |
1434 | 1434 | } |
1435 | 1435 | |
1436 | - $targetLine = $lineNumber-1; |
|
1436 | + $targetLine = $lineNumber - 1; |
|
1437 | 1437 | |
1438 | 1438 | $file->seek($targetLine); |
1439 | 1439 | |
1440 | - if($file->key() !== $targetLine) { |
|
1440 | + if ($file->key() !== $targetLine) { |
|
1441 | 1441 | return null; |
1442 | 1442 | } |
1443 | 1443 | |
@@ -1463,7 +1463,7 @@ discard block |
||
1463 | 1463 | $number = $spl->key(); |
1464 | 1464 | |
1465 | 1465 | // if seeking to the end the cursor is still at 0, there are no lines. |
1466 | - if($number === 0) |
|
1466 | + if ($number === 0) |
|
1467 | 1467 | { |
1468 | 1468 | // since it's a very small file, to get reliable results, |
1469 | 1469 | // we read its contents and use that to determine what |
@@ -1471,13 +1471,13 @@ discard block |
||
1471 | 1471 | // that this is not pactical to solve with the SplFileObject. |
1472 | 1472 | $content = file_get_contents($path); |
1473 | 1473 | |
1474 | - if(empty($content)) { |
|
1474 | + if (empty($content)) { |
|
1475 | 1475 | return 0; |
1476 | 1476 | } |
1477 | 1477 | } |
1478 | 1478 | |
1479 | 1479 | // return the line number we were able to reach + 1 (key is zero-based) |
1480 | - return $number+1; |
|
1480 | + return $number + 1; |
|
1481 | 1481 | } |
1482 | 1482 | |
1483 | 1483 | /** |
@@ -1524,13 +1524,13 @@ discard block |
||
1524 | 1524 | * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES |
1525 | 1525 | * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
1526 | 1526 | */ |
1527 | - public static function readLines(string $filePath, int $amount=0) : array |
|
1527 | + public static function readLines(string $filePath, int $amount = 0) : array |
|
1528 | 1528 | { |
1529 | 1529 | self::requireFileExists($filePath); |
1530 | 1530 | |
1531 | 1531 | $fn = fopen($filePath, "r"); |
1532 | 1532 | |
1533 | - if($fn === false) |
|
1533 | + if ($fn === false) |
|
1534 | 1534 | { |
1535 | 1535 | throw new FileHelper_Exception( |
1536 | 1536 | 'Could not open file for reading.', |
@@ -1546,25 +1546,25 @@ discard block |
||
1546 | 1546 | $counter = 0; |
1547 | 1547 | $first = true; |
1548 | 1548 | |
1549 | - while(!feof($fn)) |
|
1549 | + while (!feof($fn)) |
|
1550 | 1550 | { |
1551 | 1551 | $counter++; |
1552 | 1552 | |
1553 | 1553 | $line = fgets($fn); |
1554 | 1554 | |
1555 | 1555 | // can happen with zero length files |
1556 | - if($line === false) { |
|
1556 | + if ($line === false) { |
|
1557 | 1557 | continue; |
1558 | 1558 | } |
1559 | 1559 | |
1560 | 1560 | // the first line may contain a unicode BOM marker. |
1561 | - if($first) { |
|
1561 | + if ($first) { |
|
1562 | 1562 | $line = ConvertHelper::stripUTFBom($line); |
1563 | 1563 | } |
1564 | 1564 | |
1565 | 1565 | $result[] = $line; |
1566 | 1566 | |
1567 | - if($amount > 0 && $counter == $amount) { |
|
1567 | + if ($amount > 0 && $counter == $amount) { |
|
1568 | 1568 | break; |
1569 | 1569 | } |
1570 | 1570 | } |
@@ -1590,7 +1590,7 @@ discard block |
||
1590 | 1590 | |
1591 | 1591 | $result = file_get_contents($filePath); |
1592 | 1592 | |
1593 | - if($result !== false) { |
|
1593 | + if ($result !== false) { |
|
1594 | 1594 | return $result; |
1595 | 1595 | } |
1596 | 1596 |
@@ -7,9 +7,9 @@ |
||
7 | 7 | * @author Sebastian Mordziol <[email protected]> |
8 | 8 | */ |
9 | 9 | |
10 | - /** |
|
11 | - * Examples environment config |
|
12 | - */ |
|
10 | + /** |
|
11 | + * Examples environment config |
|
12 | + */ |
|
13 | 13 | require_once '../prepend.php'; |
14 | 14 | |
15 | 15 | use function AppUtils\parseURL; |
@@ -42,7 +42,7 @@ |
||
42 | 42 | <br> |
43 | 43 | <?php |
44 | 44 | |
45 | - foreach($urls as $url) |
|
45 | + foreach ($urls as $url) |
|
46 | 46 | { |
47 | 47 | $info = parseURL($url); |
48 | 48 |
@@ -17,33 +17,33 @@ |
||
17 | 17 | die('<b>ERROR:</b> Autoloader not present. Run composer update first.'); |
18 | 18 | } |
19 | 19 | |
20 | - /** |
|
21 | - * The composer autoloader |
|
22 | - */ |
|
20 | + /** |
|
21 | + * The composer autoloader |
|
22 | + */ |
|
23 | 23 | require_once $autoload; |
24 | 24 | |
25 | - /** |
|
26 | - * Translation global function. |
|
27 | - * @return string |
|
28 | - */ |
|
25 | + /** |
|
26 | + * Translation global function. |
|
27 | + * @return string |
|
28 | + */ |
|
29 | 29 | function t() |
30 | 30 | { |
31 | 31 | return call_user_func_array('\AppLocalize\t', func_get_args()); |
32 | 32 | } |
33 | 33 | |
34 | - /** |
|
35 | - * Translation global function. |
|
36 | - * @return string |
|
37 | - */ |
|
34 | + /** |
|
35 | + * Translation global function. |
|
36 | + * @return string |
|
37 | + */ |
|
38 | 38 | function pt() |
39 | 39 | { |
40 | 40 | return call_user_func_array('\AppLocalize\pt', func_get_args()); |
41 | 41 | } |
42 | 42 | |
43 | - /** |
|
44 | - * Translation global function. |
|
45 | - * @return string |
|
46 | - */ |
|
43 | + /** |
|
44 | + * Translation global function. |
|
45 | + * @return string |
|
46 | + */ |
|
47 | 47 | function pts() |
48 | 48 | { |
49 | 49 | return call_user_func_array('\AppLocalize\pts', func_get_args()); |
@@ -12,7 +12,7 @@ |
||
12 | 12 | $autoload = realpath($root.'/../vendor/autoload.php'); |
13 | 13 | |
14 | 14 | // we need the autoloader to be present |
15 | - if($autoload === false) |
|
15 | + if ($autoload === false) |
|
16 | 16 | { |
17 | 17 | die('<b>ERROR:</b> Autoloader not present. Run composer update first.'); |
18 | 18 | } |
@@ -50,20 +50,20 @@ discard block |
||
50 | 50 | |
51 | 51 | } |
52 | 52 | |
53 | - /** |
|
54 | - * Creates and returns a new instance of the CSV builder which |
|
55 | - * can be used to build CSV from scratch. |
|
56 | - * |
|
57 | - * @return CSVHelper_Builder |
|
58 | - */ |
|
53 | + /** |
|
54 | + * Creates and returns a new instance of the CSV builder which |
|
55 | + * can be used to build CSV from scratch. |
|
56 | + * |
|
57 | + * @return CSVHelper_Builder |
|
58 | + */ |
|
59 | 59 | public static function createBuilder() |
60 | 60 | { |
61 | 61 | return new CSVHelper_Builder(); |
62 | 62 | } |
63 | 63 | |
64 | - /** |
|
65 | - * @var string |
|
66 | - */ |
|
64 | + /** |
|
65 | + * @var string |
|
66 | + */ |
|
67 | 67 | protected $csv = ''; |
68 | 68 | |
69 | 69 | protected $data = array(); |
@@ -72,16 +72,16 @@ discard block |
||
72 | 72 | |
73 | 73 | protected $headersPosition = self::HEADERS_NONE; |
74 | 74 | |
75 | - /** |
|
76 | - * Loads CSV data from a string. |
|
77 | - * |
|
78 | - * Note: Use the {@link hasErrors()} method to |
|
79 | - * check if the string could be parsed correctly |
|
80 | - * afterwards. |
|
81 | - * |
|
82 | - * @param string $string |
|
83 | - * @return CSVHelper |
|
84 | - */ |
|
75 | + /** |
|
76 | + * Loads CSV data from a string. |
|
77 | + * |
|
78 | + * Note: Use the {@link hasErrors()} method to |
|
79 | + * check if the string could be parsed correctly |
|
80 | + * afterwards. |
|
81 | + * |
|
82 | + * @param string $string |
|
83 | + * @return CSVHelper |
|
84 | + */ |
|
85 | 85 | public function loadString($string) |
86 | 86 | { |
87 | 87 | // remove any UTF byte order marks that may still be present in the string |
@@ -95,20 +95,20 @@ discard block |
||
95 | 95 | return $this; |
96 | 96 | } |
97 | 97 | |
98 | - /** |
|
99 | - * Loads CSV data from a file. |
|
100 | - * |
|
101 | - * Note: Use the {@link hasErrors()} method to |
|
102 | - * check if the string could be parsed correctly |
|
103 | - * afterwards. |
|
104 | - * |
|
105 | - * @param string $file |
|
106 | - * @throws FileHelper_Exception |
|
107 | - * @return CSVHelper |
|
108 | - * |
|
109 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
110 | - * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS |
|
111 | - */ |
|
98 | + /** |
|
99 | + * Loads CSV data from a file. |
|
100 | + * |
|
101 | + * Note: Use the {@link hasErrors()} method to |
|
102 | + * check if the string could be parsed correctly |
|
103 | + * afterwards. |
|
104 | + * |
|
105 | + * @param string $file |
|
106 | + * @throws FileHelper_Exception |
|
107 | + * @return CSVHelper |
|
108 | + * |
|
109 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
110 | + * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS |
|
111 | + */ |
|
112 | 112 | public function loadFile(string $file) : CSVHelper |
113 | 113 | { |
114 | 114 | $csv = FileHelper::readContents($file); |
@@ -122,28 +122,28 @@ discard block |
||
122 | 122 | |
123 | 123 | protected $rowCount = 0; |
124 | 124 | |
125 | - /** |
|
126 | - * Specifies that headers are positioned on top, horizontally. |
|
127 | - * @return CSVHelper |
|
128 | - */ |
|
125 | + /** |
|
126 | + * Specifies that headers are positioned on top, horizontally. |
|
127 | + * @return CSVHelper |
|
128 | + */ |
|
129 | 129 | public function setHeadersTop() |
130 | 130 | { |
131 | 131 | return $this->setHeadersPosition(self::HEADERS_TOP); |
132 | 132 | } |
133 | 133 | |
134 | - /** |
|
135 | - * Specifies that headers are positioned on the left, vertically. |
|
136 | - * @return CSVHelper |
|
137 | - */ |
|
134 | + /** |
|
135 | + * Specifies that headers are positioned on the left, vertically. |
|
136 | + * @return CSVHelper |
|
137 | + */ |
|
138 | 138 | public function setHeadersLeft() |
139 | 139 | { |
140 | 140 | return $this->setHeadersPosition(self::HEADERS_LEFT); |
141 | 141 | } |
142 | 142 | |
143 | - /** |
|
144 | - * Specifies that there are no headers in the file (default). |
|
145 | - * @return CSVHelper |
|
146 | - */ |
|
143 | + /** |
|
144 | + * Specifies that there are no headers in the file (default). |
|
145 | + * @return CSVHelper |
|
146 | + */ |
|
147 | 147 | public function setHeadersNone() |
148 | 148 | { |
149 | 149 | return $this->setHeadersPosition(self::HEADERS_NONE); |
@@ -173,18 +173,18 @@ discard block |
||
173 | 173 | return false; |
174 | 174 | } |
175 | 175 | |
176 | - /** |
|
177 | - * Specifies where the headers are positioned in the |
|
178 | - * CSV, or turns them off entirely. Use the class constants |
|
179 | - * to ensure the value is correct. |
|
180 | - * |
|
181 | - * @param string $position |
|
182 | - * @throws CSVHelper_Exception |
|
183 | - * @return CSVHelper |
|
184 | - * @see CSVHelper::HEADERS_LEFT |
|
185 | - * @see CSVHelper::HEADERS_TOP |
|
186 | - * @see CSVHelper::HEADERS_NONE |
|
187 | - */ |
|
176 | + /** |
|
177 | + * Specifies where the headers are positioned in the |
|
178 | + * CSV, or turns them off entirely. Use the class constants |
|
179 | + * to ensure the value is correct. |
|
180 | + * |
|
181 | + * @param string $position |
|
182 | + * @throws CSVHelper_Exception |
|
183 | + * @return CSVHelper |
|
184 | + * @see CSVHelper::HEADERS_LEFT |
|
185 | + * @see CSVHelper::HEADERS_TOP |
|
186 | + * @see CSVHelper::HEADERS_NONE |
|
187 | + */ |
|
188 | 188 | public function setHeadersPosition($position) |
189 | 189 | { |
190 | 190 | $validPositions = array( |
@@ -211,13 +211,13 @@ discard block |
||
211 | 211 | return $this; |
212 | 212 | } |
213 | 213 | |
214 | - /** |
|
215 | - * Resets all internal data, allowing to start entirely anew |
|
216 | - * with a new file, or to start building a new CSV file from |
|
217 | - * scratch. |
|
218 | - * |
|
219 | - * @return CSVHelper |
|
220 | - */ |
|
214 | + /** |
|
215 | + * Resets all internal data, allowing to start entirely anew |
|
216 | + * with a new file, or to start building a new CSV file from |
|
217 | + * scratch. |
|
218 | + * |
|
219 | + * @return CSVHelper |
|
220 | + */ |
|
221 | 221 | public function reset() |
222 | 222 | { |
223 | 223 | $this->data = array(); |
@@ -234,19 +234,19 @@ discard block |
||
234 | 234 | return $this->data; |
235 | 235 | } |
236 | 236 | |
237 | - /** |
|
238 | - * Retrieves the row at the specified index. |
|
239 | - * If there is no data at the index, this will |
|
240 | - * return an array populated with empty strings |
|
241 | - * for all available columns. |
|
242 | - * |
|
243 | - * Tip: Use the {@link rowExists()} method to check |
|
244 | - * whether the specified row exists. |
|
245 | - * |
|
246 | - * @param integer $index |
|
247 | - * @return array() |
|
248 | - * @see rowExists() |
|
249 | - */ |
|
237 | + /** |
|
238 | + * Retrieves the row at the specified index. |
|
239 | + * If there is no data at the index, this will |
|
240 | + * return an array populated with empty strings |
|
241 | + * for all available columns. |
|
242 | + * |
|
243 | + * Tip: Use the {@link rowExists()} method to check |
|
244 | + * whether the specified row exists. |
|
245 | + * |
|
246 | + * @param integer $index |
|
247 | + * @return array() |
|
248 | + * @see rowExists() |
|
249 | + */ |
|
250 | 250 | public function getRow($index) |
251 | 251 | { |
252 | 252 | if(isset($this->data[$index])) { |
@@ -256,63 +256,63 @@ discard block |
||
256 | 256 | return array_fill(0, $this->rowCount, ''); |
257 | 257 | } |
258 | 258 | |
259 | - /** |
|
260 | - * Checks whether the specified row exists in the data set. |
|
261 | - * @param integer $index |
|
262 | - * @return boolean |
|
263 | - */ |
|
259 | + /** |
|
260 | + * Checks whether the specified row exists in the data set. |
|
261 | + * @param integer $index |
|
262 | + * @return boolean |
|
263 | + */ |
|
264 | 264 | public function rowExists($index) |
265 | 265 | { |
266 | 266 | return isset($this->data[$index]); |
267 | 267 | } |
268 | 268 | |
269 | - /** |
|
270 | - * Counts the amount of rows in the parsed CSV, |
|
271 | - * excluding the headers if any, depending on |
|
272 | - * their position. |
|
273 | - * |
|
274 | - * @return integer |
|
275 | - */ |
|
269 | + /** |
|
270 | + * Counts the amount of rows in the parsed CSV, |
|
271 | + * excluding the headers if any, depending on |
|
272 | + * their position. |
|
273 | + * |
|
274 | + * @return integer |
|
275 | + */ |
|
276 | 276 | public function countRows() |
277 | 277 | { |
278 | 278 | return $this->rowCount; |
279 | 279 | } |
280 | 280 | |
281 | - /** |
|
282 | - * Counts the amount of rows in the parsed CSV, |
|
283 | - * excluding the headers if any, depending on |
|
284 | - * their position. |
|
285 | - * |
|
286 | - * @return integer |
|
287 | - */ |
|
281 | + /** |
|
282 | + * Counts the amount of rows in the parsed CSV, |
|
283 | + * excluding the headers if any, depending on |
|
284 | + * their position. |
|
285 | + * |
|
286 | + * @return integer |
|
287 | + */ |
|
288 | 288 | public function countColumns() |
289 | 289 | { |
290 | 290 | return $this->columnCount; |
291 | 291 | } |
292 | 292 | |
293 | - /** |
|
294 | - * Retrieves the headers, if any. Specify the position of the |
|
295 | - * headers first to ensure this works correctly. |
|
296 | - * |
|
297 | - * @return array Indexed array with header names. |
|
298 | - */ |
|
293 | + /** |
|
294 | + * Retrieves the headers, if any. Specify the position of the |
|
295 | + * headers first to ensure this works correctly. |
|
296 | + * |
|
297 | + * @return array Indexed array with header names. |
|
298 | + */ |
|
299 | 299 | public function getHeaders() |
300 | 300 | { |
301 | 301 | return $this->headers; |
302 | 302 | } |
303 | 303 | |
304 | - /** |
|
305 | - * Retrieves the column at the specified index. If there |
|
306 | - * is no column at the index, this returns an array |
|
307 | - * populated with empty strings. |
|
308 | - * |
|
309 | - * Tip: Use the {@link columnExists()} method to check |
|
310 | - * whether a column exists. |
|
311 | - * |
|
312 | - * @param integer $index |
|
313 | - * @return string[] |
|
314 | - * @see columnExists() |
|
315 | - */ |
|
304 | + /** |
|
305 | + * Retrieves the column at the specified index. If there |
|
306 | + * is no column at the index, this returns an array |
|
307 | + * populated with empty strings. |
|
308 | + * |
|
309 | + * Tip: Use the {@link columnExists()} method to check |
|
310 | + * whether a column exists. |
|
311 | + * |
|
312 | + * @param integer $index |
|
313 | + * @return string[] |
|
314 | + * @see columnExists() |
|
315 | + */ |
|
316 | 316 | public function getColumn($index) |
317 | 317 | { |
318 | 318 | $data = array(); |
@@ -328,11 +328,11 @@ discard block |
||
328 | 328 | return $data; |
329 | 329 | } |
330 | 330 | |
331 | - /** |
|
332 | - * Checks whether the specified column exists in the data set. |
|
333 | - * @param integer $index |
|
334 | - * @return boolean |
|
335 | - */ |
|
331 | + /** |
|
332 | + * Checks whether the specified column exists in the data set. |
|
333 | + * @param integer $index |
|
334 | + * @return boolean |
|
335 | + */ |
|
336 | 336 | public function columnExists($index) |
337 | 337 | { |
338 | 338 | if($index < $this->columnCount) { |
@@ -396,22 +396,22 @@ discard block |
||
396 | 396 | } |
397 | 397 | } |
398 | 398 | |
399 | - /** |
|
400 | - * Checks whether any errors have been encountered |
|
401 | - * while parsing the CSV. |
|
402 | - * |
|
403 | - * @return boolean |
|
404 | - * @see getErrorMessages() |
|
405 | - */ |
|
399 | + /** |
|
400 | + * Checks whether any errors have been encountered |
|
401 | + * while parsing the CSV. |
|
402 | + * |
|
403 | + * @return boolean |
|
404 | + * @see getErrorMessages() |
|
405 | + */ |
|
406 | 406 | public function hasErrors() |
407 | 407 | { |
408 | 408 | return !empty($this->errors); |
409 | 409 | } |
410 | 410 | |
411 | - /** |
|
412 | - * Retrieves all error messages. |
|
413 | - * @return array |
|
414 | - */ |
|
411 | + /** |
|
412 | + * Retrieves all error messages. |
|
413 | + * @return array |
|
414 | + */ |
|
415 | 415 | public function getErrorMessages() |
416 | 416 | { |
417 | 417 | return $this->errors; |
@@ -166,7 +166,7 @@ discard block |
||
166 | 166 | |
167 | 167 | public function isHeadersPosition($position) |
168 | 168 | { |
169 | - if($this->headersPosition === $position) { |
|
169 | + if ($this->headersPosition === $position) { |
|
170 | 170 | return true; |
171 | 171 | } |
172 | 172 | |
@@ -193,7 +193,7 @@ discard block |
||
193 | 193 | self::HEADERS_TOP |
194 | 194 | ); |
195 | 195 | |
196 | - if(!in_array($position, $validPositions)) { |
|
196 | + if (!in_array($position, $validPositions)) { |
|
197 | 197 | throw new CSVHelper_Exception( |
198 | 198 | 'Invalid headers position', |
199 | 199 | sprintf( |
@@ -249,7 +249,7 @@ discard block |
||
249 | 249 | */ |
250 | 250 | public function getRow($index) |
251 | 251 | { |
252 | - if(isset($this->data[$index])) { |
|
252 | + if (isset($this->data[$index])) { |
|
253 | 253 | return $this->data[$index]; |
254 | 254 | } |
255 | 255 | |
@@ -316,9 +316,9 @@ discard block |
||
316 | 316 | public function getColumn($index) |
317 | 317 | { |
318 | 318 | $data = array(); |
319 | - for($i=0; $i < $this->rowCount; $i++) { |
|
319 | + for ($i = 0; $i < $this->rowCount; $i++) { |
|
320 | 320 | $value = ''; |
321 | - if(isset($this->data[$i][$index])) { |
|
321 | + if (isset($this->data[$i][$index])) { |
|
322 | 322 | $value = $this->data[$i][$index]; |
323 | 323 | } |
324 | 324 | |
@@ -335,7 +335,7 @@ discard block |
||
335 | 335 | */ |
336 | 336 | public function columnExists($index) |
337 | 337 | { |
338 | - if($index < $this->columnCount) { |
|
338 | + if ($index < $this->columnCount) { |
|
339 | 339 | return true; |
340 | 340 | } |
341 | 341 | |
@@ -346,7 +346,7 @@ discard block |
||
346 | 346 | { |
347 | 347 | $this->reset(); |
348 | 348 | |
349 | - if(empty(trim($this->csv))) { |
|
349 | + if (empty(trim($this->csv))) { |
|
350 | 350 | $this->addError('Tried to parse an empty CSV string.'); |
351 | 351 | return; |
352 | 352 | } |
@@ -361,12 +361,12 @@ discard block |
||
361 | 361 | $parser->delimiter = $this->detectSeparator(); |
362 | 362 | |
363 | 363 | $result = $parser->parse_string(/** @scrutinizer ignore-type */ $this->csv); |
364 | - if(!$result) { |
|
364 | + if (!$result) { |
|
365 | 365 | $this->addError('The CSV string could not be parsed.'); |
366 | 366 | return; |
367 | 367 | } |
368 | 368 | |
369 | - switch($this->headersPosition) |
|
369 | + switch ($this->headersPosition) |
|
370 | 370 | { |
371 | 371 | case self::HEADERS_TOP: |
372 | 372 | $this->headers = array_shift($result); |
@@ -375,7 +375,7 @@ discard block |
||
375 | 375 | case self::HEADERS_LEFT: |
376 | 376 | $keep = array(); |
377 | 377 | $total = count($result); |
378 | - for($i=0; $i < $total; $i++) { |
|
378 | + for ($i = 0; $i < $total; $i++) { |
|
379 | 379 | $row = $result[$i]; |
380 | 380 | $this->headers[] = array_shift($row); |
381 | 381 | $keep[] = $row; |
@@ -388,9 +388,9 @@ discard block |
||
388 | 388 | $this->data = $result; |
389 | 389 | $this->rowCount = count($this->data); |
390 | 390 | |
391 | - for($i=0; $i < $this->rowCount; $i++) { |
|
391 | + for ($i = 0; $i < $this->rowCount; $i++) { |
|
392 | 392 | $amount = count($this->data[$i]); |
393 | - if($amount > $this->columnCount) { |
|
393 | + if ($amount > $this->columnCount) { |
|
394 | 394 | $this->columnCount = $amount; |
395 | 395 | } |
396 | 396 | } |
@@ -434,8 +434,8 @@ discard block |
||
434 | 434 | ',,' => ',' |
435 | 435 | ); |
436 | 436 | |
437 | - foreach($search as $char => $separator) { |
|
438 | - if(strstr($this->csv, $char)) { |
|
437 | + foreach ($search as $char => $separator) { |
|
438 | + if (strstr($this->csv, $char)) { |
|
439 | 439 | return $separator; |
440 | 440 | } |
441 | 441 | } |
@@ -29,19 +29,19 @@ discard block |
||
29 | 29 | const TYPE_LF = 'LF'; |
30 | 30 | const TYPE_CR = 'CR'; |
31 | 31 | |
32 | - /** |
|
33 | - * @var string |
|
34 | - */ |
|
32 | + /** |
|
33 | + * @var string |
|
34 | + */ |
|
35 | 35 | protected $char; |
36 | 36 | |
37 | - /** |
|
38 | - * @var string |
|
39 | - */ |
|
37 | + /** |
|
38 | + * @var string |
|
39 | + */ |
|
40 | 40 | protected $type; |
41 | 41 | |
42 | - /** |
|
43 | - * @var string |
|
44 | - */ |
|
42 | + /** |
|
43 | + * @var string |
|
44 | + */ |
|
45 | 45 | protected $description; |
46 | 46 | |
47 | 47 | public function __construct(string $char, string $type, string $description) |
@@ -51,33 +51,33 @@ discard block |
||
51 | 51 | $this->description = $description; |
52 | 52 | } |
53 | 53 | |
54 | - /** |
|
55 | - * The actual EOL character. |
|
56 | - * @return string |
|
57 | - */ |
|
54 | + /** |
|
55 | + * The actual EOL character. |
|
56 | + * @return string |
|
57 | + */ |
|
58 | 58 | public function getCharacter() : string |
59 | 59 | { |
60 | 60 | return $this->char; |
61 | 61 | } |
62 | 62 | |
63 | - /** |
|
64 | - * A more detailed, human readable description of the character. |
|
65 | - * @return string |
|
66 | - */ |
|
63 | + /** |
|
64 | + * A more detailed, human readable description of the character. |
|
65 | + * @return string |
|
66 | + */ |
|
67 | 67 | public function getDescription() : string |
68 | 68 | { |
69 | 69 | return $this->description; |
70 | 70 | } |
71 | 71 | |
72 | - /** |
|
73 | - * The EOL character type, e.g. "CR+LF", "CR"... |
|
74 | - * @return string |
|
75 | - * |
|
76 | - * @see ConvertHelper_EOL::TYPE_CR |
|
77 | - * @see ConvertHelper_EOL::TYPE_CRLF |
|
78 | - * @see ConvertHelper_EOL::TYPE_LF |
|
79 | - * @see ConvertHelper_EOL::TYPE_LFCR |
|
80 | - */ |
|
72 | + /** |
|
73 | + * The EOL character type, e.g. "CR+LF", "CR"... |
|
74 | + * @return string |
|
75 | + * |
|
76 | + * @see ConvertHelper_EOL::TYPE_CR |
|
77 | + * @see ConvertHelper_EOL::TYPE_CRLF |
|
78 | + * @see ConvertHelper_EOL::TYPE_LF |
|
79 | + * @see ConvertHelper_EOL::TYPE_LFCR |
|
80 | + */ |
|
81 | 81 | public function getType() : string |
82 | 82 | { |
83 | 83 | return $this->type; |
@@ -84,7 +84,7 @@ discard block |
||
84 | 84 | */ |
85 | 85 | public function setValue($value) : NumberInfo |
86 | 86 | { |
87 | - if($value instanceof NumberInfo) { |
|
87 | + if ($value instanceof NumberInfo) { |
|
88 | 88 | $value = $value->getValue(); |
89 | 89 | } |
90 | 90 | |
@@ -117,7 +117,7 @@ discard block |
||
117 | 117 | |
118 | 118 | public function isPositive() : bool |
119 | 119 | { |
120 | - if(!$this->isEmpty()) { |
|
120 | + if (!$this->isEmpty()) { |
|
121 | 121 | $number = $this->getNumber(); |
122 | 122 | return $number > 0; |
123 | 123 | } |
@@ -148,7 +148,7 @@ discard block |
||
148 | 148 | */ |
149 | 149 | public function hasValue() : bool |
150 | 150 | { |
151 | - if(!$this->isEmpty() && !$this->isZero()) { |
|
151 | + if (!$this->isEmpty() && !$this->isZero()) { |
|
152 | 152 | return true; |
153 | 153 | } |
154 | 154 | |
@@ -221,7 +221,7 @@ discard block |
||
221 | 221 | */ |
222 | 222 | public function getUnits() |
223 | 223 | { |
224 | - if(!$this->hasUnits()) { |
|
224 | + if (!$this->hasUnits()) { |
|
225 | 225 | return 'px'; |
226 | 226 | } |
227 | 227 | |
@@ -255,15 +255,15 @@ discard block |
||
255 | 255 | */ |
256 | 256 | public function toAttribute() |
257 | 257 | { |
258 | - if($this->isEmpty()) { |
|
258 | + if ($this->isEmpty()) { |
|
259 | 259 | return null; |
260 | 260 | } |
261 | 261 | |
262 | - if($this->isZero()) { |
|
262 | + if ($this->isZero()) { |
|
263 | 263 | return '0'; |
264 | 264 | } |
265 | 265 | |
266 | - if($this->isPercent()) { |
|
266 | + if ($this->isPercent()) { |
|
267 | 267 | return $this->getNumber().$this->getUnits(); |
268 | 268 | } |
269 | 269 | |
@@ -276,11 +276,11 @@ discard block |
||
276 | 276 | */ |
277 | 277 | public function toCSS() |
278 | 278 | { |
279 | - if($this->isEmpty()) { |
|
279 | + if ($this->isEmpty()) { |
|
280 | 280 | return null; |
281 | 281 | } |
282 | 282 | |
283 | - if($this->isZero()) { |
|
283 | + if ($this->isZero()) { |
|
284 | 284 | return '0'; |
285 | 285 | } |
286 | 286 | |
@@ -289,7 +289,7 @@ discard block |
||
289 | 289 | |
290 | 290 | public function __toString() |
291 | 291 | { |
292 | - if($this->isEmpty()) { |
|
292 | + if ($this->isEmpty()) { |
|
293 | 293 | return ''; |
294 | 294 | } |
295 | 295 | |
@@ -307,7 +307,7 @@ discard block |
||
307 | 307 | public function isBiggerThan($number) |
308 | 308 | { |
309 | 309 | $number = parseNumber($number); |
310 | - if($number->getUnits() != $this->getUnits()) { |
|
310 | + if ($number->getUnits() != $this->getUnits()) { |
|
311 | 311 | return false; |
312 | 312 | } |
313 | 313 | |
@@ -325,7 +325,7 @@ discard block |
||
325 | 325 | public function isSmallerThan($number) |
326 | 326 | { |
327 | 327 | $number = parseNumber($number); |
328 | - if($number->getUnits() != $this->getUnits()) { |
|
328 | + if ($number->getUnits() != $this->getUnits()) { |
|
329 | 329 | return false; |
330 | 330 | } |
331 | 331 | |
@@ -335,7 +335,7 @@ discard block |
||
335 | 335 | public function isBiggerEqual($number) |
336 | 336 | { |
337 | 337 | $number = parseNumber($number); |
338 | - if($number->getUnits() != $this->getUnits()) { |
|
338 | + if ($number->getUnits() != $this->getUnits()) { |
|
339 | 339 | return false; |
340 | 340 | } |
341 | 341 | |
@@ -352,14 +352,14 @@ discard block |
||
352 | 352 | */ |
353 | 353 | public function add($value) |
354 | 354 | { |
355 | - if($this->isEmpty()) { |
|
355 | + if ($this->isEmpty()) { |
|
356 | 356 | $this->setValue($value); |
357 | 357 | return $this; |
358 | 358 | } |
359 | 359 | |
360 | 360 | $number = parseNumber($value); |
361 | 361 | |
362 | - if($number->getUnits() == $this->getUnits() || !$number->hasUnits()) |
|
362 | + if ($number->getUnits() == $this->getUnits() || !$number->hasUnits()) |
|
363 | 363 | { |
364 | 364 | $new = $this->getNumber() + $number->getNumber(); |
365 | 365 | $this->setValue($new.$this->getUnits()); |
@@ -378,14 +378,14 @@ discard block |
||
378 | 378 | */ |
379 | 379 | public function subtract($value) |
380 | 380 | { |
381 | - if($this->isEmpty()) { |
|
381 | + if ($this->isEmpty()) { |
|
382 | 382 | $this->setValue($value); |
383 | 383 | return $this; |
384 | 384 | } |
385 | 385 | |
386 | 386 | $number = parseNumber($value); |
387 | 387 | |
388 | - if($number->getUnits() == $this->getUnits() || !$number->hasUnits()) |
|
388 | + if ($number->getUnits() == $this->getUnits() || !$number->hasUnits()) |
|
389 | 389 | { |
390 | 390 | $new = $this->getNumber() - $number->getNumber(); |
391 | 391 | $this->setValue($new.$this->getUnits()); |
@@ -412,25 +412,25 @@ discard block |
||
412 | 412 | |
413 | 413 | protected function percentOperation($operation, $percent) |
414 | 414 | { |
415 | - if($this->isZeroOrEmpty()) { |
|
415 | + if ($this->isZeroOrEmpty()) { |
|
416 | 416 | return $this; |
417 | 417 | } |
418 | 418 | |
419 | 419 | $percent = parseNumber($percent); |
420 | - if($percent->hasUnits() && !$percent->isPercent()) { |
|
420 | + if ($percent->hasUnits() && !$percent->isPercent()) { |
|
421 | 421 | return $this; |
422 | 422 | } |
423 | 423 | |
424 | 424 | $number = $this->getNumber(); |
425 | 425 | $value = $number * $percent->getNumber() / 100; |
426 | 426 | |
427 | - if($operation == '-') { |
|
427 | + if ($operation == '-') { |
|
428 | 428 | $number = $number - $value; |
429 | 429 | } else { |
430 | 430 | $number = $number + $value; |
431 | 431 | } |
432 | 432 | |
433 | - if($this->isUnitInteger()) { |
|
433 | + if ($this->isUnitInteger()) { |
|
434 | 434 | $number = intval($number); |
435 | 435 | } |
436 | 436 | |
@@ -479,7 +479,7 @@ discard block |
||
479 | 479 | { |
480 | 480 | static $cache = array(); |
481 | 481 | |
482 | - if(!is_string($value) && !is_numeric($value)) |
|
482 | + if (!is_string($value) && !is_numeric($value)) |
|
483 | 483 | { |
484 | 484 | $value = ''; |
485 | 485 | $key = '_EMPTY_'; |
@@ -489,7 +489,7 @@ discard block |
||
489 | 489 | $key = (string)$value; |
490 | 490 | } |
491 | 491 | |
492 | - if(array_key_exists($key, $cache)) { |
|
492 | + if (array_key_exists($key, $cache)) { |
|
493 | 493 | return $cache[$key]; |
494 | 494 | } |
495 | 495 | |
@@ -499,31 +499,31 @@ discard block |
||
499 | 499 | 'number' => null |
500 | 500 | ); |
501 | 501 | |
502 | - if($value === '') { |
|
502 | + if ($value === '') { |
|
503 | 503 | $cache[$key]['empty'] = true; |
504 | 504 | return $cache[$key]; |
505 | 505 | } |
506 | 506 | |
507 | - if($value === 0 || $value === '0') { |
|
507 | + if ($value === 0 || $value === '0') { |
|
508 | 508 | $cache[$key]['number'] = 0; |
509 | 509 | $cache[$key] = $this->filterInfo($cache[$key]); |
510 | 510 | return $cache[$key]; |
511 | 511 | } |
512 | 512 | |
513 | 513 | $test = trim((string)$value); |
514 | - if($test === '') { |
|
514 | + if ($test === '') { |
|
515 | 515 | $cache[$key]['empty'] = true; |
516 | 516 | return $cache[$key]; |
517 | 517 | } |
518 | 518 | |
519 | 519 | // replace comma notation (which is only possible if it's a string) |
520 | - if(is_string($value)) |
|
520 | + if (is_string($value)) |
|
521 | 521 | { |
522 | 522 | $test = $this->preProcess($test, $cache, $value); |
523 | 523 | } |
524 | 524 | |
525 | 525 | // convert to a number if it's numeric |
526 | - if(is_numeric($test)) { |
|
526 | + if (is_numeric($test)) { |
|
527 | 527 | $cache[$key]['number'] = $test * 1; |
528 | 528 | $cache[$key] = $this->filterInfo($cache[$key]); |
529 | 529 | return $cache[$key]; |
@@ -536,16 +536,16 @@ discard block |
||
536 | 536 | |
537 | 537 | $vlength = strlen($test); |
538 | 538 | $names = array_keys($this->knownUnits); |
539 | - foreach($names as $unit) |
|
539 | + foreach ($names as $unit) |
|
540 | 540 | { |
541 | 541 | $ulength = strlen($unit); |
542 | - $start = $vlength-$ulength; |
|
543 | - if($start < 0) { |
|
542 | + $start = $vlength - $ulength; |
|
543 | + if ($start < 0) { |
|
544 | 544 | continue; |
545 | 545 | } |
546 | 546 | |
547 | 547 | $search = substr($test, $start, $ulength); |
548 | - if($search==$unit) { |
|
548 | + if ($search == $unit) { |
|
549 | 549 | $units = $unit; |
550 | 550 | $number = substr($test, 0, $start); |
551 | 551 | break; |
@@ -553,12 +553,12 @@ discard block |
||
553 | 553 | } |
554 | 554 | |
555 | 555 | // the filters have to restore the value |
556 | - if($this->postProcess) |
|
556 | + if ($this->postProcess) |
|
557 | 557 | { |
558 | 558 | $number = $this->postProcess($number, $test); |
559 | 559 | } |
560 | 560 | // empty number |
561 | - else if($number === '' || $number === null || is_bool($number)) |
|
561 | + else if ($number === '' || $number === null || is_bool($number)) |
|
562 | 562 | { |
563 | 563 | $number = null; |
564 | 564 | $cache[$key]['empty'] = true; |
@@ -569,7 +569,7 @@ discard block |
||
569 | 569 | $number = trim($number); |
570 | 570 | |
571 | 571 | // may be an arbitrary string in some cases |
572 | - if(!is_numeric($number)) |
|
572 | + if (!is_numeric($number)) |
|
573 | 573 | { |
574 | 574 | $number = null; |
575 | 575 | $cache[$key]['empty'] = true; |
@@ -648,12 +648,12 @@ discard block |
||
648 | 648 | protected function filterInfo(array $info) : array |
649 | 649 | { |
650 | 650 | $useUnits = 'px'; |
651 | - if($info['units'] !== null) { |
|
651 | + if ($info['units'] !== null) { |
|
652 | 652 | $useUnits = $info['units']; |
653 | 653 | } |
654 | 654 | |
655 | 655 | // the units are non-decimal: convert decimal values |
656 | - if($useUnits !== null && $this->knownUnits[$useUnits] === false && !$info['empty'] && is_numeric($info['number'])) |
|
656 | + if ($useUnits !== null && $this->knownUnits[$useUnits] === false && !$info['empty'] && is_numeric($info['number'])) |
|
657 | 657 | { |
658 | 658 | $info['number'] = intval($info['number']); |
659 | 659 | } |
@@ -483,8 +483,7 @@ discard block |
||
483 | 483 | { |
484 | 484 | $value = ''; |
485 | 485 | $key = '_EMPTY_'; |
486 | - } |
|
487 | - else |
|
486 | + } else |
|
488 | 487 | { |
489 | 488 | $key = (string)$value; |
490 | 489 | } |
@@ -573,8 +572,7 @@ discard block |
||
573 | 572 | { |
574 | 573 | $number = null; |
575 | 574 | $cache[$key]['empty'] = true; |
576 | - } |
|
577 | - else |
|
575 | + } else |
|
578 | 576 | { |
579 | 577 | $number = $number * 1; |
580 | 578 | } |
@@ -38,24 +38,24 @@ discard block |
||
38 | 38 | */ |
39 | 39 | class NumberInfo |
40 | 40 | { |
41 | - /** |
|
42 | - * @var mixed |
|
43 | - */ |
|
41 | + /** |
|
42 | + * @var mixed |
|
43 | + */ |
|
44 | 44 | protected $rawValue; |
45 | 45 | |
46 | - /** |
|
47 | - * @var array |
|
48 | - */ |
|
46 | + /** |
|
47 | + * @var array |
|
48 | + */ |
|
49 | 49 | protected $info; |
50 | 50 | |
51 | - /** |
|
52 | - * @var bool |
|
53 | - */ |
|
51 | + /** |
|
52 | + * @var bool |
|
53 | + */ |
|
54 | 54 | protected $empty = false; |
55 | 55 | |
56 | - /** |
|
57 | - * @var array |
|
58 | - */ |
|
56 | + /** |
|
57 | + * @var array |
|
58 | + */ |
|
59 | 59 | protected $knownUnits = array( |
60 | 60 | '%' => true, |
61 | 61 | 'rem' => true, |
@@ -95,21 +95,21 @@ discard block |
||
95 | 95 | return $this; |
96 | 96 | } |
97 | 97 | |
98 | - /** |
|
99 | - * Retrieves the raw, internal information array resulting |
|
100 | - * from the parsing of the number. |
|
101 | - * |
|
102 | - * @return array |
|
103 | - */ |
|
98 | + /** |
|
99 | + * Retrieves the raw, internal information array resulting |
|
100 | + * from the parsing of the number. |
|
101 | + * |
|
102 | + * @return array |
|
103 | + */ |
|
104 | 104 | public function getRawInfo() : array |
105 | 105 | { |
106 | 106 | return $this->info; |
107 | 107 | } |
108 | 108 | |
109 | - /** |
|
110 | - * Whether the number was empty (null or empty string). |
|
111 | - * @return boolean |
|
112 | - */ |
|
109 | + /** |
|
110 | + * Whether the number was empty (null or empty string). |
|
111 | + * @return boolean |
|
112 | + */ |
|
113 | 113 | public function isEmpty() : bool |
114 | 114 | { |
115 | 115 | return $this->empty; |
@@ -590,59 +590,59 @@ discard block |
||
590 | 590 | |
591 | 591 | protected $postProcess = false; |
592 | 592 | |
593 | - /** |
|
594 | - * Called if explicitly enabled: allows filtering the |
|
595 | - * number after the detection process has completed. |
|
596 | - * |
|
597 | - * @param string|NULL $number The adjusted number |
|
598 | - * @param string $originalString The original value before it was parsed |
|
599 | - * @return mixed |
|
600 | - */ |
|
593 | + /** |
|
594 | + * Called if explicitly enabled: allows filtering the |
|
595 | + * number after the detection process has completed. |
|
596 | + * |
|
597 | + * @param string|NULL $number The adjusted number |
|
598 | + * @param string $originalString The original value before it was parsed |
|
599 | + * @return mixed |
|
600 | + */ |
|
601 | 601 | protected function postProcess(?string $number, /** @scrutinizer ignore-unused */ string $originalString) |
602 | 602 | { |
603 | 603 | return $number; |
604 | 604 | } |
605 | 605 | |
606 | - /** |
|
607 | - * Filters the value before it is parsed, but only if it is a string. |
|
608 | - * |
|
609 | - * NOTE: This may be overwritten in a subclass, to allow custom filtering |
|
610 | - * the the values. An example of a use case would be a preprocessor for |
|
611 | - * variables in a templating system. |
|
612 | - * |
|
613 | - * @param string $trimmedString The trimmed value. |
|
614 | - * @param array $cache The internal values cache array. |
|
615 | - * @param string $originalValue The original value that the NumberInfo was created for. |
|
616 | - * @return string |
|
617 | - * |
|
618 | - * @see NumberInfo::enablePostProcess() |
|
619 | - */ |
|
606 | + /** |
|
607 | + * Filters the value before it is parsed, but only if it is a string. |
|
608 | + * |
|
609 | + * NOTE: This may be overwritten in a subclass, to allow custom filtering |
|
610 | + * the the values. An example of a use case would be a preprocessor for |
|
611 | + * variables in a templating system. |
|
612 | + * |
|
613 | + * @param string $trimmedString The trimmed value. |
|
614 | + * @param array $cache The internal values cache array. |
|
615 | + * @param string $originalValue The original value that the NumberInfo was created for. |
|
616 | + * @return string |
|
617 | + * |
|
618 | + * @see NumberInfo::enablePostProcess() |
|
619 | + */ |
|
620 | 620 | protected function preProcess(string $trimmedString, /** @scrutinizer ignore-unused */ array &$cache, /** @scrutinizer ignore-unused */ string $originalValue) : string |
621 | 621 | { |
622 | 622 | return str_replace(',', '.', $trimmedString); |
623 | 623 | } |
624 | 624 | |
625 | - /** |
|
626 | - * Enables the post processing so the postProcess method gets called. |
|
627 | - * This should be called in the {@link NumberInfo::preProcess()} |
|
628 | - * method as needed. |
|
629 | - * |
|
630 | - * @return NumberInfo |
|
631 | - * @see NumberInfo::postProcess() |
|
632 | - */ |
|
625 | + /** |
|
626 | + * Enables the post processing so the postProcess method gets called. |
|
627 | + * This should be called in the {@link NumberInfo::preProcess()} |
|
628 | + * method as needed. |
|
629 | + * |
|
630 | + * @return NumberInfo |
|
631 | + * @see NumberInfo::postProcess() |
|
632 | + */ |
|
633 | 633 | private function enablePostProcess() : NumberInfo |
634 | 634 | { |
635 | 635 | $this->postProcess = true; |
636 | 636 | return $this; |
637 | 637 | } |
638 | 638 | |
639 | - /** |
|
640 | - * Filters the number info array to adjust the units |
|
641 | - * and number according to the required rules. |
|
642 | - * |
|
643 | - * @param array $info |
|
644 | - * @return array |
|
645 | - */ |
|
639 | + /** |
|
640 | + * Filters the number info array to adjust the units |
|
641 | + * and number according to the required rules. |
|
642 | + * |
|
643 | + * @param array $info |
|
644 | + * @return array |
|
645 | + */ |
|
646 | 646 | protected function filterInfo(array $info) : array |
647 | 647 | { |
648 | 648 | $useUnits = 'px'; |
@@ -41,7 +41,7 @@ discard block |
||
41 | 41 | */ |
42 | 42 | public function setOption(string $name, $value) |
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) |
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,13 +75,13 @@ 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 | $this->options = $this->getDefaultOptions(); |
82 | 82 | } |
83 | 83 | |
84 | - if(isset($this->options[$name])) { |
|
84 | + if (isset($this->options[$name])) { |
|
85 | 85 | return $this->options[$name]; |
86 | 86 | } |
87 | 87 | |
@@ -98,11 +98,11 @@ discard block |
||
98 | 98 | * @param string $default Used if the option does not exist, is invalid, or empty. |
99 | 99 | * @return string |
100 | 100 | */ |
101 | - public function getStringOption(string $name, string $default='') : string |
|
101 | + public function getStringOption(string $name, string $default = '') : string |
|
102 | 102 | { |
103 | 103 | $value = $this->getOption($name, false); |
104 | 104 | |
105 | - if((is_string($value) || is_numeric($value)) && !empty($value)) { |
|
105 | + if ((is_string($value) || is_numeric($value)) && !empty($value)) { |
|
106 | 106 | return (string)$value; |
107 | 107 | } |
108 | 108 | |
@@ -118,9 +118,9 @@ discard block |
||
118 | 118 | * @param string $name |
119 | 119 | * @return bool |
120 | 120 | */ |
121 | - public function getBoolOption(string $name, bool $default=false) : bool |
|
121 | + public function getBoolOption(string $name, bool $default = false) : bool |
|
122 | 122 | { |
123 | - if($this->getOption($name) === true) { |
|
123 | + if ($this->getOption($name) === true) { |
|
124 | 124 | return true; |
125 | 125 | } |
126 | 126 | |
@@ -136,10 +136,10 @@ discard block |
||
136 | 136 | * @param int $default |
137 | 137 | * @return int |
138 | 138 | */ |
139 | - public function getIntOption(string $name, int $default=0) : int |
|
139 | + public function getIntOption(string $name, int $default = 0) : int |
|
140 | 140 | { |
141 | 141 | $value = $this->getOption($name); |
142 | - if(ConvertHelper::isInteger($value)) { |
|
142 | + if (ConvertHelper::isInteger($value)) { |
|
143 | 143 | return (int)$value; |
144 | 144 | } |
145 | 145 | |
@@ -157,7 +157,7 @@ discard block |
||
157 | 157 | public function getArrayOption(string $name) : array |
158 | 158 | { |
159 | 159 | $val = $this->getOption($name); |
160 | - if(is_array($val)) { |
|
160 | + if (is_array($val)) { |
|
161 | 161 | return $val; |
162 | 162 | } |
163 | 163 | |
@@ -173,7 +173,7 @@ discard block |
||
173 | 173 | */ |
174 | 174 | public function hasOption(string $name) : bool |
175 | 175 | { |
176 | - if(!isset($this->options)) { |
|
176 | + if (!isset($this->options)) { |
|
177 | 177 | $this->options = $this->getDefaultOptions(); |
178 | 178 | } |
179 | 179 | |
@@ -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 | |
@@ -240,7 +240,7 @@ discard block |
||
240 | 240 | * @param mixed $default |
241 | 241 | * @return Interface_Optionable |
242 | 242 | */ |
243 | - function getOption(string $name, $default=null); |
|
243 | + function getOption(string $name, $default = null); |
|
244 | 244 | |
245 | 245 | /** |
246 | 246 | * @param array $options |
@@ -26,18 +26,18 @@ discard block |
||
26 | 26 | */ |
27 | 27 | trait Traits_Optionable |
28 | 28 | { |
29 | - /** |
|
30 | - * @var array |
|
31 | - */ |
|
29 | + /** |
|
30 | + * @var array |
|
31 | + */ |
|
32 | 32 | protected $options; |
33 | 33 | |
34 | - /** |
|
35 | - * Sets an option to the specified value. This can be any |
|
36 | - * kind of variable type, including objects, as needed. |
|
37 | - * |
|
38 | - * @param string $name |
|
39 | - * @param mixed $default |
|
40 | - */ |
|
34 | + /** |
|
35 | + * Sets an option to the specified value. This can be any |
|
36 | + * kind of variable type, including objects, as needed. |
|
37 | + * |
|
38 | + * @param string $name |
|
39 | + * @param mixed $default |
|
40 | + */ |
|
41 | 41 | public function setOption(string $name, $value) |
42 | 42 | { |
43 | 43 | if(!isset($this->options)) { |
@@ -48,12 +48,12 @@ discard block |
||
48 | 48 | return $this; |
49 | 49 | } |
50 | 50 | |
51 | - /** |
|
52 | - * Sets a collection of options at once, from an |
|
53 | - * associative array. |
|
54 | - * |
|
55 | - * @param array $options |
|
56 | - */ |
|
51 | + /** |
|
52 | + * Sets a collection of options at once, from an |
|
53 | + * associative array. |
|
54 | + * |
|
55 | + * @param array $options |
|
56 | + */ |
|
57 | 57 | public function setOptions(array $options) |
58 | 58 | { |
59 | 59 | foreach($options as $name => $value) { |
@@ -63,16 +63,16 @@ discard block |
||
63 | 63 | return $this; |
64 | 64 | } |
65 | 65 | |
66 | - /** |
|
67 | - * Retrieves an option's value. |
|
68 | - * |
|
69 | - * NOTE: Use the specialized type getters to ensure an option |
|
70 | - * contains the expected type (for ex. getArrayOption()). |
|
71 | - * |
|
72 | - * @param string $name |
|
73 | - * @param mixed $default The default value to return if the option does not exist. |
|
74 | - * @return mixed |
|
75 | - */ |
|
66 | + /** |
|
67 | + * Retrieves an option's value. |
|
68 | + * |
|
69 | + * NOTE: Use the specialized type getters to ensure an option |
|
70 | + * contains the expected type (for ex. getArrayOption()). |
|
71 | + * |
|
72 | + * @param string $name |
|
73 | + * @param mixed $default The default value to return if the option does not exist. |
|
74 | + * @return mixed |
|
75 | + */ |
|
76 | 76 | public function getOption(string $name, $default=null) |
77 | 77 | { |
78 | 78 | if(!isset($this->options)) { |
@@ -86,16 +86,16 @@ discard block |
||
86 | 86 | return $default; |
87 | 87 | } |
88 | 88 | |
89 | - /** |
|
90 | - * Enforces that the option value is a string. Numbers are converted |
|
91 | - * to string, strings are passed through, and all other types will |
|
92 | - * return the default value. The default value is also returned if |
|
93 | - * the string is empty. |
|
94 | - * |
|
95 | - * @param string $name |
|
96 | - * @param string $default Used if the option does not exist, is invalid, or empty. |
|
97 | - * @return string |
|
98 | - */ |
|
89 | + /** |
|
90 | + * Enforces that the option value is a string. Numbers are converted |
|
91 | + * to string, strings are passed through, and all other types will |
|
92 | + * return the default value. The default value is also returned if |
|
93 | + * the string is empty. |
|
94 | + * |
|
95 | + * @param string $name |
|
96 | + * @param string $default Used if the option does not exist, is invalid, or empty. |
|
97 | + * @return string |
|
98 | + */ |
|
99 | 99 | public function getStringOption(string $name, string $default='') : string |
100 | 100 | { |
101 | 101 | $value = $this->getOption($name, false); |
@@ -107,15 +107,15 @@ discard block |
||
107 | 107 | return $default; |
108 | 108 | } |
109 | 109 | |
110 | - /** |
|
111 | - * Treats the option value as a boolean value: will return |
|
112 | - * true if the value actually is a boolean true. |
|
113 | - * |
|
114 | - * NOTE: boolean string representations are not accepted. |
|
115 | - * |
|
116 | - * @param string $name |
|
117 | - * @return bool |
|
118 | - */ |
|
110 | + /** |
|
111 | + * Treats the option value as a boolean value: will return |
|
112 | + * true if the value actually is a boolean true. |
|
113 | + * |
|
114 | + * NOTE: boolean string representations are not accepted. |
|
115 | + * |
|
116 | + * @param string $name |
|
117 | + * @return bool |
|
118 | + */ |
|
119 | 119 | public function getBoolOption(string $name, bool $default=false) : bool |
120 | 120 | { |
121 | 121 | if($this->getOption($name) === true) { |
@@ -125,15 +125,15 @@ discard block |
||
125 | 125 | return $default; |
126 | 126 | } |
127 | 127 | |
128 | - /** |
|
129 | - * Treats the option value as an integer value: will return |
|
130 | - * valid integer values (also from integer strings), or the |
|
131 | - * default value otherwise. |
|
132 | - * |
|
133 | - * @param string $name |
|
134 | - * @param int $default |
|
135 | - * @return int |
|
136 | - */ |
|
128 | + /** |
|
129 | + * Treats the option value as an integer value: will return |
|
130 | + * valid integer values (also from integer strings), or the |
|
131 | + * default value otherwise. |
|
132 | + * |
|
133 | + * @param string $name |
|
134 | + * @param int $default |
|
135 | + * @return int |
|
136 | + */ |
|
137 | 137 | public function getIntOption(string $name, int $default=0) : int |
138 | 138 | { |
139 | 139 | $value = $this->getOption($name); |
@@ -144,14 +144,14 @@ discard block |
||
144 | 144 | return $default; |
145 | 145 | } |
146 | 146 | |
147 | - /** |
|
148 | - * Treats an option as an array, and returns its value |
|
149 | - * only if it contains an array - otherwise, an empty |
|
150 | - * array is returned. |
|
151 | - * |
|
152 | - * @param string $name |
|
153 | - * @return array |
|
154 | - */ |
|
147 | + /** |
|
148 | + * Treats an option as an array, and returns its value |
|
149 | + * only if it contains an array - otherwise, an empty |
|
150 | + * array is returned. |
|
151 | + * |
|
152 | + * @param string $name |
|
153 | + * @return array |
|
154 | + */ |
|
155 | 155 | public function getArrayOption(string $name) : array |
156 | 156 | { |
157 | 157 | $val = $this->getOption($name); |
@@ -162,13 +162,13 @@ discard block |
||
162 | 162 | return array(); |
163 | 163 | } |
164 | 164 | |
165 | - /** |
|
166 | - * Checks whether the specified option exists - even |
|
167 | - * if it has a NULL value. |
|
168 | - * |
|
169 | - * @param string $name |
|
170 | - * @return bool |
|
171 | - */ |
|
165 | + /** |
|
166 | + * Checks whether the specified option exists - even |
|
167 | + * if it has a NULL value. |
|
168 | + * |
|
169 | + * @param string $name |
|
170 | + * @return bool |
|
171 | + */ |
|
172 | 172 | public function hasOption(string $name) : bool |
173 | 173 | { |
174 | 174 | if(!isset($this->options)) { |
@@ -178,10 +178,10 @@ discard block |
||
178 | 178 | return array_key_exists($name, $this->options); |
179 | 179 | } |
180 | 180 | |
181 | - /** |
|
182 | - * Returns all options in one associative array. |
|
183 | - * @return array |
|
184 | - */ |
|
181 | + /** |
|
182 | + * Returns all options in one associative array. |
|
183 | + * @return array |
|
184 | + */ |
|
185 | 185 | public function getOptions() : array |
186 | 186 | { |
187 | 187 | if(!isset($this->options)) { |
@@ -191,24 +191,24 @@ discard block |
||
191 | 191 | return $this->options; |
192 | 192 | } |
193 | 193 | |
194 | - /** |
|
195 | - * Checks whether the option's value is the one specified. |
|
196 | - * |
|
197 | - * @param string $name |
|
198 | - * @param mixed $value |
|
199 | - * @return bool |
|
200 | - */ |
|
194 | + /** |
|
195 | + * Checks whether the option's value is the one specified. |
|
196 | + * |
|
197 | + * @param string $name |
|
198 | + * @param mixed $value |
|
199 | + * @return bool |
|
200 | + */ |
|
201 | 201 | public function isOption(string $name, $value) : bool |
202 | 202 | { |
203 | 203 | return $this->getOption($name) === $value; |
204 | 204 | } |
205 | 205 | |
206 | - /** |
|
207 | - * Retrieves the default available options as an |
|
208 | - * associative array with option name => value pairs. |
|
209 | - * |
|
210 | - * @return array |
|
211 | - */ |
|
206 | + /** |
|
207 | + * Retrieves the default available options as an |
|
208 | + * associative array with option name => value pairs. |
|
209 | + * |
|
210 | + * @return array |
|
211 | + */ |
|
212 | 212 | abstract public function getDefaultOptions() : array; |
213 | 213 | } |
214 | 214 | |
@@ -226,24 +226,24 @@ discard block |
||
226 | 226 | */ |
227 | 227 | interface Interface_Optionable |
228 | 228 | { |
229 | - /** |
|
230 | - * @param string $name |
|
231 | - * @param mixed $value |
|
232 | - * @return Interface_Optionable |
|
233 | - */ |
|
229 | + /** |
|
230 | + * @param string $name |
|
231 | + * @param mixed $value |
|
232 | + * @return Interface_Optionable |
|
233 | + */ |
|
234 | 234 | function setOption(string $name, $value); |
235 | 235 | |
236 | - /** |
|
237 | - * @param string $name |
|
238 | - * @param mixed $default |
|
239 | - * @return Interface_Optionable |
|
240 | - */ |
|
236 | + /** |
|
237 | + * @param string $name |
|
238 | + * @param mixed $default |
|
239 | + * @return Interface_Optionable |
|
240 | + */ |
|
241 | 241 | function getOption(string $name, $default=null); |
242 | 242 | |
243 | - /** |
|
244 | - * @param array $options |
|
245 | - * @return Interface_Optionable |
|
246 | - */ |
|
243 | + /** |
|
244 | + * @param array $options |
|
245 | + * @return Interface_Optionable |
|
246 | + */ |
|
247 | 247 | function setOptions(array $options); |
248 | 248 | function getOptions() : array; |
249 | 249 | function isOption(string $name, $value) : bool; |
@@ -151,8 +151,7 @@ discard block |
||
151 | 151 | $this->sourceImage = $resource; |
152 | 152 | $this->type = $type; |
153 | 153 | $this->info = self::getImageSize($resource); |
154 | - } |
|
155 | - else |
|
154 | + } else |
|
156 | 155 | { |
157 | 156 | $this->file = $sourceFile; |
158 | 157 | if (!file_exists($this->file)) { |
@@ -561,8 +560,7 @@ discard block |
||
561 | 560 | if ($this->width <= $this->height) |
562 | 561 | { |
563 | 562 | $this->resampleByWidth($width); |
564 | - } |
|
565 | - else |
|
563 | + } else |
|
566 | 564 | { |
567 | 565 | $this->resampleByHeight($height); |
568 | 566 | } |
@@ -1037,8 +1035,7 @@ discard block |
||
1037 | 1035 | { |
1038 | 1036 | $bg2 = imagecolorallocatealpha($im2, $color['red'], $color['green'], $color['blue'], $color['alpha']); |
1039 | 1037 | imagecolortransparent($im2, $bg2); |
1040 | - } |
|
1041 | - else |
|
1038 | + } else |
|
1042 | 1039 | { |
1043 | 1040 | $bg2 = imagecolorallocate($im2, $color['red'], $color['green'], $color['blue']); |
1044 | 1041 | } |
@@ -1348,8 +1345,7 @@ discard block |
||
1348 | 1345 | if(method_exists(__CLASS__, $method)) |
1349 | 1346 | { |
1350 | 1347 | $info = call_user_func(array(__CLASS__, $method), $pathOrResource); |
1351 | - } |
|
1352 | - else |
|
1348 | + } else |
|
1353 | 1349 | { |
1354 | 1350 | $info = getimagesize($pathOrResource); |
1355 | 1351 | } |
@@ -68,54 +68,54 @@ discard block |
||
68 | 68 | |
69 | 69 | const ERROR_UNEXPECTED_COLOR_VALUE = 513025; |
70 | 70 | |
71 | - /** |
|
72 | - * @var string |
|
73 | - */ |
|
71 | + /** |
|
72 | + * @var string |
|
73 | + */ |
|
74 | 74 | protected $file; |
75 | 75 | |
76 | - /** |
|
77 | - * @var ImageHelper_Size |
|
78 | - */ |
|
76 | + /** |
|
77 | + * @var ImageHelper_Size |
|
78 | + */ |
|
79 | 79 | protected $info; |
80 | 80 | |
81 | - /** |
|
82 | - * @var string |
|
83 | - */ |
|
81 | + /** |
|
82 | + * @var string |
|
83 | + */ |
|
84 | 84 | protected $type; |
85 | 85 | |
86 | - /** |
|
87 | - * @var resource|NULL |
|
88 | - */ |
|
86 | + /** |
|
87 | + * @var resource|NULL |
|
88 | + */ |
|
89 | 89 | protected $newImage; |
90 | 90 | |
91 | - /** |
|
92 | - * @var resource |
|
93 | - */ |
|
91 | + /** |
|
92 | + * @var resource |
|
93 | + */ |
|
94 | 94 | protected $sourceImage; |
95 | 95 | |
96 | - /** |
|
97 | - * @var int |
|
98 | - */ |
|
96 | + /** |
|
97 | + * @var int |
|
98 | + */ |
|
99 | 99 | protected $width; |
100 | 100 | |
101 | - /** |
|
102 | - * @var int |
|
103 | - */ |
|
101 | + /** |
|
102 | + * @var int |
|
103 | + */ |
|
104 | 104 | protected $height; |
105 | 105 | |
106 | - /** |
|
107 | - * @var int |
|
108 | - */ |
|
106 | + /** |
|
107 | + * @var int |
|
108 | + */ |
|
109 | 109 | protected $newWidth = 0; |
110 | 110 | |
111 | - /** |
|
112 | - * @var int |
|
113 | - */ |
|
111 | + /** |
|
112 | + * @var int |
|
113 | + */ |
|
114 | 114 | protected $newHeight = 0; |
115 | 115 | |
116 | - /** |
|
117 | - * @var int |
|
118 | - */ |
|
116 | + /** |
|
117 | + * @var int |
|
118 | + */ |
|
119 | 119 | protected $quality = 85; |
120 | 120 | |
121 | 121 | protected static $imageTypes = array( |
@@ -203,17 +203,17 @@ discard block |
||
203 | 203 | } |
204 | 204 | } |
205 | 205 | |
206 | - /** |
|
207 | - * Factory method: creates a new helper with a blank image. |
|
208 | - * |
|
209 | - * @param integer $width |
|
210 | - * @param integer $height |
|
211 | - * @param string $type The target file type when saving |
|
212 | - * @return ImageHelper |
|
213 | - * @throws ImageHelper_Exception |
|
214 | - * |
|
215 | - * @see ImageHelper::ERROR_CANNOT_CREATE_IMAGE_OBJECT |
|
216 | - */ |
|
206 | + /** |
|
207 | + * Factory method: creates a new helper with a blank image. |
|
208 | + * |
|
209 | + * @param integer $width |
|
210 | + * @param integer $height |
|
211 | + * @param string $type The target file type when saving |
|
212 | + * @return ImageHelper |
|
213 | + * @throws ImageHelper_Exception |
|
214 | + * |
|
215 | + * @see ImageHelper::ERROR_CANNOT_CREATE_IMAGE_OBJECT |
|
216 | + */ |
|
217 | 217 | public static function createNew($width, $height, $type='png') |
218 | 218 | { |
219 | 219 | $img = imagecreatetruecolor($width, $height); |
@@ -228,18 +228,18 @@ discard block |
||
228 | 228 | ); |
229 | 229 | } |
230 | 230 | |
231 | - /** |
|
232 | - * Factory method: creates an image helper from an |
|
233 | - * existing image resource. |
|
234 | - * |
|
235 | - * Note: while the resource is type independent, the |
|
236 | - * type parameter is required for some methods, as well |
|
237 | - * as to be able to save the image. |
|
238 | - * |
|
239 | - * @param resource $resource |
|
240 | - * @param string $type The target image type, e.g. "jpeg", "png", etc. |
|
241 | - * @return ImageHelper |
|
242 | - */ |
|
231 | + /** |
|
232 | + * Factory method: creates an image helper from an |
|
233 | + * existing image resource. |
|
234 | + * |
|
235 | + * Note: while the resource is type independent, the |
|
236 | + * type parameter is required for some methods, as well |
|
237 | + * as to be able to save the image. |
|
238 | + * |
|
239 | + * @param resource $resource |
|
240 | + * @param string $type The target image type, e.g. "jpeg", "png", etc. |
|
241 | + * @return ImageHelper |
|
242 | + */ |
|
243 | 243 | public static function createFromResource($resource, ?string $type=null) |
244 | 244 | { |
245 | 245 | self::requireResource($resource); |
@@ -247,29 +247,29 @@ discard block |
||
247 | 247 | return new ImageHelper(null, $resource, $type); |
248 | 248 | } |
249 | 249 | |
250 | - /** |
|
251 | - * Factory method: creates an image helper from an |
|
252 | - * image file on disk. |
|
253 | - * |
|
254 | - * @param string $path |
|
255 | - * @return ImageHelper |
|
256 | - */ |
|
250 | + /** |
|
251 | + * Factory method: creates an image helper from an |
|
252 | + * image file on disk. |
|
253 | + * |
|
254 | + * @param string $path |
|
255 | + * @return ImageHelper |
|
256 | + */ |
|
257 | 257 | public static function createFromFile($file) |
258 | 258 | { |
259 | 259 | return new ImageHelper($file); |
260 | 260 | } |
261 | 261 | |
262 | - /** |
|
263 | - * Sets a global image helper configuration value. Available |
|
264 | - * configuration settings are: |
|
265 | - * |
|
266 | - * <ul> |
|
267 | - * <li><code>auto-memory-adjustment</code> <i>boolean</i> Whether totry and adjust the memory limit automatically so there will be enough to load/process the target image.</li> |
|
268 | - * </ul> |
|
269 | - * |
|
270 | - * @param string $name |
|
271 | - * @param mixed $value |
|
272 | - */ |
|
262 | + /** |
|
263 | + * Sets a global image helper configuration value. Available |
|
264 | + * configuration settings are: |
|
265 | + * |
|
266 | + * <ul> |
|
267 | + * <li><code>auto-memory-adjustment</code> <i>boolean</i> Whether totry and adjust the memory limit automatically so there will be enough to load/process the target image.</li> |
|
268 | + * </ul> |
|
269 | + * |
|
270 | + * @param string $name |
|
271 | + * @param mixed $value |
|
272 | + */ |
|
273 | 273 | public static function setConfig($name, $value) |
274 | 274 | { |
275 | 275 | if(isset(self::$config[$name])) { |
@@ -277,22 +277,22 @@ discard block |
||
277 | 277 | } |
278 | 278 | } |
279 | 279 | |
280 | - /** |
|
281 | - * Shorthand for setting the automatic memory adjustment |
|
282 | - * global configuration setting. |
|
283 | - * |
|
284 | - * @param bool $enabled |
|
285 | - */ |
|
280 | + /** |
|
281 | + * Shorthand for setting the automatic memory adjustment |
|
282 | + * global configuration setting. |
|
283 | + * |
|
284 | + * @param bool $enabled |
|
285 | + */ |
|
286 | 286 | public static function setAutoMemoryAdjustment($enabled=true) |
287 | 287 | { |
288 | 288 | self::setConfig('auto-memory-adjustment', $enabled); |
289 | 289 | } |
290 | 290 | |
291 | - /** |
|
292 | - * Duplicates an image resource. |
|
293 | - * @param resource $img |
|
294 | - * @return resource |
|
295 | - */ |
|
291 | + /** |
|
292 | + * Duplicates an image resource. |
|
293 | + * @param resource $img |
|
294 | + * @return resource |
|
295 | + */ |
|
296 | 296 | protected function duplicateImage($img) |
297 | 297 | { |
298 | 298 | self::requireResource($img); |
@@ -304,12 +304,12 @@ discard block |
||
304 | 304 | return $duplicate; |
305 | 305 | } |
306 | 306 | |
307 | - /** |
|
308 | - * Duplicates the current state of the image into a new |
|
309 | - * image helper instance. |
|
310 | - * |
|
311 | - * @return ImageHelper |
|
312 | - */ |
|
307 | + /** |
|
308 | + * Duplicates the current state of the image into a new |
|
309 | + * image helper instance. |
|
310 | + * |
|
311 | + * @return ImageHelper |
|
312 | + */ |
|
313 | 313 | public function duplicate() |
314 | 314 | { |
315 | 315 | return ImageHelper::createFromResource($this->duplicateImage($this->newImage)); |
@@ -497,13 +497,13 @@ discard block |
||
497 | 497 | )); |
498 | 498 | } |
499 | 499 | |
500 | - /** |
|
501 | - * Resamples the image to a new width, maintaining |
|
502 | - * aspect ratio. |
|
503 | - * |
|
504 | - * @param int $width |
|
505 | - * @return ImageHelper |
|
506 | - */ |
|
500 | + /** |
|
501 | + * Resamples the image to a new width, maintaining |
|
502 | + * aspect ratio. |
|
503 | + * |
|
504 | + * @param int $width |
|
505 | + * @return ImageHelper |
|
506 | + */ |
|
507 | 507 | public function resampleByWidth(int $width) : ImageHelper |
508 | 508 | { |
509 | 509 | $size = $this->getSizeByWidth($width); |
@@ -513,12 +513,12 @@ discard block |
||
513 | 513 | return $this; |
514 | 514 | } |
515 | 515 | |
516 | - /** |
|
517 | - * Resamples the image by height, and creates a new image file on disk. |
|
518 | - * |
|
519 | - * @param int $height |
|
520 | - * @return ImageHelper |
|
521 | - */ |
|
516 | + /** |
|
517 | + * Resamples the image by height, and creates a new image file on disk. |
|
518 | + * |
|
519 | + * @param int $height |
|
520 | + * @return ImageHelper |
|
521 | + */ |
|
522 | 522 | public function resampleByHeight($height) : ImageHelper |
523 | 523 | { |
524 | 524 | $size = $this->getSizeByHeight($height); |
@@ -526,13 +526,13 @@ discard block |
||
526 | 526 | return $this->resampleImage($size->getWidth(), $size->getHeight()); |
527 | 527 | } |
528 | 528 | |
529 | - /** |
|
530 | - * Resamples the image without keeping the aspect ratio. |
|
531 | - * |
|
532 | - * @param int $width |
|
533 | - * @param int $height |
|
534 | - * @return ImageHelper |
|
535 | - */ |
|
529 | + /** |
|
530 | + * Resamples the image without keeping the aspect ratio. |
|
531 | + * |
|
532 | + * @param int $width |
|
533 | + * @param int $height |
|
534 | + * @return ImageHelper |
|
535 | + */ |
|
536 | 536 | public function resample(?int $width = null, ?int $height = null) : ImageHelper |
537 | 537 | { |
538 | 538 | if($this->isVector()) { |
@@ -597,12 +597,12 @@ discard block |
||
597 | 597 | |
598 | 598 | protected $alpha = false; |
599 | 599 | |
600 | - /** |
|
601 | - * Configures the specified image resource to make it alpha compatible. |
|
602 | - * |
|
603 | - * @param resource $canvas |
|
604 | - * @param bool $fill Whether to fill the whole canvas with the transparency |
|
605 | - */ |
|
600 | + /** |
|
601 | + * Configures the specified image resource to make it alpha compatible. |
|
602 | + * |
|
603 | + * @param resource $canvas |
|
604 | + * @param bool $fill Whether to fill the whole canvas with the transparency |
|
605 | + */ |
|
606 | 606 | public static function addAlphaSupport($canvas, $fill=true) |
607 | 607 | { |
608 | 608 | self::requireResource($canvas); |
@@ -717,12 +717,12 @@ discard block |
||
717 | 717 | $this->quality = $quality * 1; |
718 | 718 | } |
719 | 719 | |
720 | - /** |
|
721 | - * Attempts to adjust the memory to the required size |
|
722 | - * to work with the current image. |
|
723 | - * |
|
724 | - * @return boolean |
|
725 | - */ |
|
720 | + /** |
|
721 | + * Attempts to adjust the memory to the required size |
|
722 | + * to work with the current image. |
|
723 | + * |
|
724 | + * @return boolean |
|
725 | + */ |
|
726 | 726 | protected function adjustMemory() : bool |
727 | 727 | { |
728 | 728 | if(!self::$config['auto-memory-adjustment']) { |
@@ -762,27 +762,27 @@ discard block |
||
762 | 762 | return false; |
763 | 763 | } |
764 | 764 | |
765 | - /** |
|
766 | - * Stretches the image to the specified dimensions. |
|
767 | - * |
|
768 | - * @param int $width |
|
769 | - * @param int $height |
|
770 | - * @return ImageHelper |
|
771 | - */ |
|
765 | + /** |
|
766 | + * Stretches the image to the specified dimensions. |
|
767 | + * |
|
768 | + * @param int $width |
|
769 | + * @param int $height |
|
770 | + * @return ImageHelper |
|
771 | + */ |
|
772 | 772 | public function stretch(int $width, int $height) : ImageHelper |
773 | 773 | { |
774 | 774 | return $this->resampleImage($width, $height); |
775 | 775 | } |
776 | 776 | |
777 | - /** |
|
778 | - * Creates a new image from the current image, |
|
779 | - * resampling it to the new size. |
|
780 | - * |
|
781 | - * @param int $newWidth |
|
782 | - * @param int $newHeight |
|
783 | - * @throws ImageHelper_Exception |
|
784 | - * @return ImageHelper |
|
785 | - */ |
|
777 | + /** |
|
778 | + * Creates a new image from the current image, |
|
779 | + * resampling it to the new size. |
|
780 | + * |
|
781 | + * @param int $newWidth |
|
782 | + * @param int $newHeight |
|
783 | + * @throws ImageHelper_Exception |
|
784 | + * @return ImageHelper |
|
785 | + */ |
|
786 | 786 | protected function resampleImage(int $newWidth, int $newHeight) : ImageHelper |
787 | 787 | { |
788 | 788 | if($this->isVector()) { |
@@ -922,31 +922,31 @@ discard block |
||
922 | 922 | readfile($imageFile); |
923 | 923 | } |
924 | 924 | |
925 | - /** |
|
926 | - * Displays the current image. |
|
927 | - */ |
|
925 | + /** |
|
926 | + * Displays the current image. |
|
927 | + */ |
|
928 | 928 | public function display() |
929 | 929 | { |
930 | 930 | $this->displayImageStream($this->newImage, $this->getType(), $this->resolveQuality()); |
931 | 931 | } |
932 | 932 | |
933 | - /** |
|
934 | - * Trims the current loaded image. |
|
935 | - * |
|
936 | - * @param array $color A color definition, as an associative array with red, green, and blue keys. If not specified, the color at pixel position 0,0 will be used. |
|
937 | - */ |
|
933 | + /** |
|
934 | + * Trims the current loaded image. |
|
935 | + * |
|
936 | + * @param array $color A color definition, as an associative array with red, green, and blue keys. If not specified, the color at pixel position 0,0 will be used. |
|
937 | + */ |
|
938 | 938 | public function trim($color=null) |
939 | 939 | { |
940 | 940 | return $this->trimImage($this->newImage, $color); |
941 | 941 | } |
942 | 942 | |
943 | - /** |
|
944 | - * Retrieves a color definition by its index. |
|
945 | - * |
|
946 | - * @param resource $img A valid image resource. |
|
947 | - * @param int $colorIndex The color index, as returned by imagecolorat for example. |
|
948 | - * @return array An array with red, green, blue and alpha keys. |
|
949 | - */ |
|
943 | + /** |
|
944 | + * Retrieves a color definition by its index. |
|
945 | + * |
|
946 | + * @param resource $img A valid image resource. |
|
947 | + * @param int $colorIndex The color index, as returned by imagecolorat for example. |
|
948 | + * @return array An array with red, green, blue and alpha keys. |
|
949 | + */ |
|
950 | 950 | public function getIndexedColors($img, int $colorIndex) : array |
951 | 951 | { |
952 | 952 | $color = imagecolorsforindex($img, $colorIndex); |
@@ -964,14 +964,14 @@ discard block |
||
964 | 964 | ); |
965 | 965 | } |
966 | 966 | |
967 | - /** |
|
968 | - * Trims the specified image resource by removing the specified color. |
|
969 | - * Also works with transparency. |
|
970 | - * |
|
971 | - * @param resource $img |
|
972 | - * @param array $color A color definition, as an associative array with red, green, blue and alpha keys. If not specified, the color at pixel position 0,0 will be used. |
|
973 | - * @return ImageHelper |
|
974 | - */ |
|
967 | + /** |
|
968 | + * Trims the specified image resource by removing the specified color. |
|
969 | + * Also works with transparency. |
|
970 | + * |
|
971 | + * @param resource $img |
|
972 | + * @param array $color A color definition, as an associative array with red, green, blue and alpha keys. If not specified, the color at pixel position 0,0 will be used. |
|
973 | + * @return ImageHelper |
|
974 | + */ |
|
975 | 975 | protected function trimImage($img, ?array $color=null) : ImageHelper |
976 | 976 | { |
977 | 977 | if($this->isVector()) { |
@@ -1059,12 +1059,12 @@ discard block |
||
1059 | 1059 | return $this; |
1060 | 1060 | } |
1061 | 1061 | |
1062 | - /** |
|
1063 | - * Sets the new image after a transformation operation: |
|
1064 | - * automatically adjusts the new size information. |
|
1065 | - * |
|
1066 | - * @param resource $image |
|
1067 | - */ |
|
1062 | + /** |
|
1063 | + * Sets the new image after a transformation operation: |
|
1064 | + * automatically adjusts the new size information. |
|
1065 | + * |
|
1066 | + * @param resource $image |
|
1067 | + */ |
|
1068 | 1068 | protected function setNewImage($image) |
1069 | 1069 | { |
1070 | 1070 | self::requireResource($image); |
@@ -1074,12 +1074,12 @@ discard block |
||
1074 | 1074 | $this->newHeight= imagesy($image); |
1075 | 1075 | } |
1076 | 1076 | |
1077 | - /** |
|
1078 | - * Requires the subject to be a resource. |
|
1079 | - * |
|
1080 | - * @param resource $subject |
|
1081 | - * @throws ImageHelper_Exception |
|
1082 | - */ |
|
1077 | + /** |
|
1078 | + * Requires the subject to be a resource. |
|
1079 | + * |
|
1080 | + * @param resource $subject |
|
1081 | + * @throws ImageHelper_Exception |
|
1082 | + */ |
|
1083 | 1083 | protected static function requireResource($subject) |
1084 | 1084 | { |
1085 | 1085 | if(is_resource($subject)) { |
@@ -1096,14 +1096,14 @@ discard block |
||
1096 | 1096 | ); |
1097 | 1097 | } |
1098 | 1098 | |
1099 | - /** |
|
1100 | - * Creates a new image resource, with transparent background. |
|
1101 | - * |
|
1102 | - * @param int $width |
|
1103 | - * @param int $height |
|
1104 | - * @throws ImageHelper_Exception |
|
1105 | - * @return resource |
|
1106 | - */ |
|
1099 | + /** |
|
1100 | + * Creates a new image resource, with transparent background. |
|
1101 | + * |
|
1102 | + * @param int $width |
|
1103 | + * @param int $height |
|
1104 | + * @throws ImageHelper_Exception |
|
1105 | + * @return resource |
|
1106 | + */ |
|
1107 | 1107 | protected function createNewImage(int $width, int $height) |
1108 | 1108 | { |
1109 | 1109 | $img = imagecreatetruecolor($width, $height); |
@@ -1122,54 +1122,54 @@ discard block |
||
1122 | 1122 | return $img; |
1123 | 1123 | } |
1124 | 1124 | |
1125 | - /** |
|
1126 | - * Whether the two specified colors are the same. |
|
1127 | - * |
|
1128 | - * @param array $a |
|
1129 | - * @param array $b |
|
1130 | - * @return boolean |
|
1131 | - */ |
|
1132 | - protected function colorsMatch($a, $b) : bool |
|
1133 | - { |
|
1134 | - $parts = array('red', 'green', 'blue'); |
|
1135 | - foreach($parts as $part) { |
|
1136 | - if($a[$part] != $b[$part]) { |
|
1137 | - return false; |
|
1138 | - } |
|
1139 | - } |
|
1125 | + /** |
|
1126 | + * Whether the two specified colors are the same. |
|
1127 | + * |
|
1128 | + * @param array $a |
|
1129 | + * @param array $b |
|
1130 | + * @return boolean |
|
1131 | + */ |
|
1132 | + protected function colorsMatch($a, $b) : bool |
|
1133 | + { |
|
1134 | + $parts = array('red', 'green', 'blue'); |
|
1135 | + foreach($parts as $part) { |
|
1136 | + if($a[$part] != $b[$part]) { |
|
1137 | + return false; |
|
1138 | + } |
|
1139 | + } |
|
1140 | 1140 | |
1141 | - return true; |
|
1142 | - } |
|
1141 | + return true; |
|
1142 | + } |
|
1143 | 1143 | |
1144 | - public function fillWhite($x=0, $y=0) |
|
1145 | - { |
|
1146 | - $this->addRGBColor('white', 255, 255, 255); |
|
1144 | + public function fillWhite($x=0, $y=0) |
|
1145 | + { |
|
1146 | + $this->addRGBColor('white', 255, 255, 255); |
|
1147 | 1147 | return $this->fill('white', $x, $y); |
1148 | - } |
|
1148 | + } |
|
1149 | 1149 | |
1150 | - public function fillTransparent() : ImageHelper |
|
1151 | - { |
|
1150 | + public function fillTransparent() : ImageHelper |
|
1151 | + { |
|
1152 | 1152 | $this->enableAlpha(); |
1153 | 1153 | |
1154 | - self::fillImageTransparent($this->newImage); |
|
1154 | + self::fillImageTransparent($this->newImage); |
|
1155 | 1155 | |
1156 | - return $this; |
|
1157 | - } |
|
1156 | + return $this; |
|
1157 | + } |
|
1158 | 1158 | |
1159 | - public static function fillImageTransparent($resource) |
|
1160 | - { |
|
1161 | - self::requireResource($resource); |
|
1159 | + public static function fillImageTransparent($resource) |
|
1160 | + { |
|
1161 | + self::requireResource($resource); |
|
1162 | 1162 | |
1163 | - $transparent = imagecolorallocatealpha($resource, 89, 14, 207, 127); |
|
1164 | - imagecolortransparent ($resource, $transparent); |
|
1165 | - imagefill($resource, 0, 0, $transparent); |
|
1166 | - } |
|
1163 | + $transparent = imagecolorallocatealpha($resource, 89, 14, 207, 127); |
|
1164 | + imagecolortransparent ($resource, $transparent); |
|
1165 | + imagefill($resource, 0, 0, $transparent); |
|
1166 | + } |
|
1167 | 1167 | |
1168 | - public function fill($colorName, $x=0, $y=0) |
|
1169 | - { |
|
1170 | - imagefill($this->newImage, $x, $y, $this->colors[$colorName]); |
|
1171 | - return $this; |
|
1172 | - } |
|
1168 | + public function fill($colorName, $x=0, $y=0) |
|
1169 | + { |
|
1170 | + imagefill($this->newImage, $x, $y, $this->colors[$colorName]); |
|
1171 | + return $this; |
|
1172 | + } |
|
1173 | 1173 | |
1174 | 1174 | protected $colors = array(); |
1175 | 1175 | |
@@ -1190,9 +1190,9 @@ discard block |
||
1190 | 1190 | return $this; |
1191 | 1191 | } |
1192 | 1192 | |
1193 | - /** |
|
1194 | - * @return resource |
|
1195 | - */ |
|
1193 | + /** |
|
1194 | + * @return resource |
|
1195 | + */ |
|
1196 | 1196 | public function getImage() |
1197 | 1197 | { |
1198 | 1198 | return $this->newImage; |
@@ -1210,27 +1210,27 @@ discard block |
||
1210 | 1210 | return $this; |
1211 | 1211 | } |
1212 | 1212 | |
1213 | - /** |
|
1214 | - * Retrieves the size of the image. |
|
1215 | - * |
|
1216 | - * @param bool $exception Whether to trigger an exception when the image does not exist |
|
1217 | - * @return ImageHelper_Size |
|
1218 | - * @throws ImageHelper_Exception |
|
1219 | - * @see ImageHelper::ERROR_CANNOT_GET_IMAGE_SIZE |
|
1220 | - */ |
|
1221 | - public function getSize() : ImageHelper_Size |
|
1213 | + /** |
|
1214 | + * Retrieves the size of the image. |
|
1215 | + * |
|
1216 | + * @param bool $exception Whether to trigger an exception when the image does not exist |
|
1217 | + * @return ImageHelper_Size |
|
1218 | + * @throws ImageHelper_Exception |
|
1219 | + * @see ImageHelper::ERROR_CANNOT_GET_IMAGE_SIZE |
|
1220 | + */ |
|
1221 | + public function getSize() : ImageHelper_Size |
|
1222 | 1222 | { |
1223 | - return self::getImageSize($this->newImage); |
|
1223 | + return self::getImageSize($this->newImage); |
|
1224 | 1224 | } |
1225 | 1225 | |
1226 | 1226 | protected $TTFFile; |
1227 | 1227 | |
1228 | - /** |
|
1229 | - * Sets the TTF font file to use for text operations. |
|
1230 | - * |
|
1231 | - * @param string $filePath |
|
1232 | - * @return ImageHelper |
|
1233 | - */ |
|
1228 | + /** |
|
1229 | + * Sets the TTF font file to use for text operations. |
|
1230 | + * |
|
1231 | + * @param string $filePath |
|
1232 | + * @return ImageHelper |
|
1233 | + */ |
|
1234 | 1234 | public function setFontTTF($filePath) |
1235 | 1235 | { |
1236 | 1236 | $this->TTFFile = $filePath; |
@@ -1302,63 +1302,63 @@ discard block |
||
1302 | 1302 | return; |
1303 | 1303 | } |
1304 | 1304 | |
1305 | - throw new ImageHelper_Exception( |
|
1305 | + throw new ImageHelper_Exception( |
|
1306 | 1306 | 'No true type font specified', |
1307 | 1307 | 'This functionality requires a TTF font file to be specified with the [setFontTTF] method.', |
1308 | 1308 | self::ERROR_NO_TRUE_TYPE_FONT_SET |
1309 | 1309 | ); |
1310 | 1310 | } |
1311 | 1311 | |
1312 | - /** |
|
1313 | - * Retrieves the size of an image file on disk, or |
|
1314 | - * an existing image resource. |
|
1315 | - * |
|
1316 | - * <pre> |
|
1317 | - * array( |
|
1318 | - * 0: (width), |
|
1319 | - * 1: (height), |
|
1320 | - * "channels": the amount of channels |
|
1321 | - * "bits": bits per channel |
|
1312 | + /** |
|
1313 | + * Retrieves the size of an image file on disk, or |
|
1314 | + * an existing image resource. |
|
1315 | + * |
|
1316 | + * <pre> |
|
1317 | + * array( |
|
1318 | + * 0: (width), |
|
1319 | + * 1: (height), |
|
1320 | + * "channels": the amount of channels |
|
1321 | + * "bits": bits per channel |
|
1322 | 1322 | * ) |
1323 | - * </pre> |
|
1324 | - * |
|
1325 | - * @param string|resource $pathOrResource |
|
1326 | - * @return ImageHelper_Size Size object, can also be accessed like the traditional array from getimagesize |
|
1327 | - * @see ImageHelper_Size |
|
1328 | - * @throws ImageHelper_Exception |
|
1329 | - * @see ImageHelper::ERROR_CANNOT_GET_IMAGE_SIZE |
|
1330 | - * @see ImageHelper::ERROR_CANNOT_READ_SVG_IMAGE |
|
1331 | - * @see ImageHelper::ERROR_SVG_SOURCE_VIEWBOX_MISSING |
|
1332 | - * @see ImageHelper::ERROR_SVG_VIEWBOX_INVALID |
|
1333 | - */ |
|
1334 | - public static function getImageSize($pathOrResource) : ImageHelper_Size |
|
1335 | - { |
|
1336 | - if(is_resource($pathOrResource)) |
|
1337 | - { |
|
1338 | - return new ImageHelper_Size(array( |
|
1339 | - 'width' => imagesx($pathOrResource), |
|
1340 | - 'height' => imagesy($pathOrResource), |
|
1341 | - 'channels' => 1, |
|
1342 | - 'bits' => 8 |
|
1343 | - )); |
|
1344 | - } |
|
1323 | + * </pre> |
|
1324 | + * |
|
1325 | + * @param string|resource $pathOrResource |
|
1326 | + * @return ImageHelper_Size Size object, can also be accessed like the traditional array from getimagesize |
|
1327 | + * @see ImageHelper_Size |
|
1328 | + * @throws ImageHelper_Exception |
|
1329 | + * @see ImageHelper::ERROR_CANNOT_GET_IMAGE_SIZE |
|
1330 | + * @see ImageHelper::ERROR_CANNOT_READ_SVG_IMAGE |
|
1331 | + * @see ImageHelper::ERROR_SVG_SOURCE_VIEWBOX_MISSING |
|
1332 | + * @see ImageHelper::ERROR_SVG_VIEWBOX_INVALID |
|
1333 | + */ |
|
1334 | + public static function getImageSize($pathOrResource) : ImageHelper_Size |
|
1335 | + { |
|
1336 | + if(is_resource($pathOrResource)) |
|
1337 | + { |
|
1338 | + return new ImageHelper_Size(array( |
|
1339 | + 'width' => imagesx($pathOrResource), |
|
1340 | + 'height' => imagesy($pathOrResource), |
|
1341 | + 'channels' => 1, |
|
1342 | + 'bits' => 8 |
|
1343 | + )); |
|
1344 | + } |
|
1345 | 1345 | |
1346 | - $type = self::getFileImageType($pathOrResource); |
|
1346 | + $type = self::getFileImageType($pathOrResource); |
|
1347 | 1347 | |
1348 | - $info = false; |
|
1349 | - $method = 'getImageSize_'.$type; |
|
1350 | - if(method_exists(__CLASS__, $method)) |
|
1351 | - { |
|
1352 | - $info = call_user_func(array(__CLASS__, $method), $pathOrResource); |
|
1353 | - } |
|
1354 | - else |
|
1355 | - { |
|
1356 | - $info = getimagesize($pathOrResource); |
|
1357 | - } |
|
1348 | + $info = false; |
|
1349 | + $method = 'getImageSize_'.$type; |
|
1350 | + if(method_exists(__CLASS__, $method)) |
|
1351 | + { |
|
1352 | + $info = call_user_func(array(__CLASS__, $method), $pathOrResource); |
|
1353 | + } |
|
1354 | + else |
|
1355 | + { |
|
1356 | + $info = getimagesize($pathOrResource); |
|
1357 | + } |
|
1358 | 1358 | |
1359 | - if($info !== false) { |
|
1360 | - return new ImageHelper_Size($info); |
|
1361 | - } |
|
1359 | + if($info !== false) { |
|
1360 | + return new ImageHelper_Size($info); |
|
1361 | + } |
|
1362 | 1362 | |
1363 | 1363 | throw new ImageHelper_Exception( |
1364 | 1364 | 'Error opening image file', |
@@ -1368,98 +1368,98 @@ discard block |
||
1368 | 1368 | ), |
1369 | 1369 | self::ERROR_CANNOT_GET_IMAGE_SIZE |
1370 | 1370 | ); |
1371 | - } |
|
1371 | + } |
|
1372 | 1372 | |
1373 | - /** |
|
1374 | - * @param string $imagePath |
|
1375 | - * @throws ImageHelper_Exception |
|
1376 | - * @return array |
|
1377 | - * |
|
1378 | - * @todo This should return a ImageHelper_Size instance. |
|
1379 | - */ |
|
1380 | - protected static function getImageSize_svg(string $imagePath) : array |
|
1381 | - { |
|
1382 | - $xml = XMLHelper::createSimplexml(); |
|
1383 | - $xml->loadFile($imagePath); |
|
1373 | + /** |
|
1374 | + * @param string $imagePath |
|
1375 | + * @throws ImageHelper_Exception |
|
1376 | + * @return array |
|
1377 | + * |
|
1378 | + * @todo This should return a ImageHelper_Size instance. |
|
1379 | + */ |
|
1380 | + protected static function getImageSize_svg(string $imagePath) : array |
|
1381 | + { |
|
1382 | + $xml = XMLHelper::createSimplexml(); |
|
1383 | + $xml->loadFile($imagePath); |
|
1384 | 1384 | |
1385 | - if($xml->hasErrors()) { |
|
1386 | - throw new ImageHelper_Exception( |
|
1387 | - 'Error opening SVG image', |
|
1388 | - sprintf( |
|
1389 | - 'The XML content of the image [%s] could not be parsed.', |
|
1390 | - $imagePath |
|
1385 | + if($xml->hasErrors()) { |
|
1386 | + throw new ImageHelper_Exception( |
|
1387 | + 'Error opening SVG image', |
|
1388 | + sprintf( |
|
1389 | + 'The XML content of the image [%s] could not be parsed.', |
|
1390 | + $imagePath |
|
1391 | 1391 | ), |
1392 | - self::ERROR_CANNOT_READ_SVG_IMAGE |
|
1392 | + self::ERROR_CANNOT_READ_SVG_IMAGE |
|
1393 | 1393 | ); |
1394 | - } |
|
1394 | + } |
|
1395 | 1395 | |
1396 | - $data = $xml->toArray(); |
|
1397 | - $xml->dispose(); |
|
1398 | - unset($xml); |
|
1396 | + $data = $xml->toArray(); |
|
1397 | + $xml->dispose(); |
|
1398 | + unset($xml); |
|
1399 | 1399 | |
1400 | - if(!isset($data['@attributes']) || !isset($data['@attributes']['viewBox'])) { |
|
1401 | - throw new ImageHelper_Exception( |
|
1402 | - 'SVG Image is corrupted', |
|
1403 | - sprintf( |
|
1404 | - 'The [viewBox] attribute is missing in the XML of the image at path [%s].', |
|
1405 | - $imagePath |
|
1400 | + if(!isset($data['@attributes']) || !isset($data['@attributes']['viewBox'])) { |
|
1401 | + throw new ImageHelper_Exception( |
|
1402 | + 'SVG Image is corrupted', |
|
1403 | + sprintf( |
|
1404 | + 'The [viewBox] attribute is missing in the XML of the image at path [%s].', |
|
1405 | + $imagePath |
|
1406 | 1406 | ), |
1407 | - self::ERROR_SVG_SOURCE_VIEWBOX_MISSING |
|
1407 | + self::ERROR_SVG_SOURCE_VIEWBOX_MISSING |
|
1408 | 1408 | ); |
1409 | - } |
|
1409 | + } |
|
1410 | 1410 | |
1411 | - $svgWidth = parseNumber($data['@attributes']['width'])->getNumber(); |
|
1412 | - $svgHeight = parseNumber($data['@attributes']['height'])->getNumber(); |
|
1411 | + $svgWidth = parseNumber($data['@attributes']['width'])->getNumber(); |
|
1412 | + $svgHeight = parseNumber($data['@attributes']['height'])->getNumber(); |
|
1413 | 1413 | |
1414 | - $viewBox = str_replace(' ', ',', $data['@attributes']['viewBox']); |
|
1415 | - $size = explode(',', $viewBox); |
|
1414 | + $viewBox = str_replace(' ', ',', $data['@attributes']['viewBox']); |
|
1415 | + $size = explode(',', $viewBox); |
|
1416 | 1416 | |
1417 | - if(count($size) != 4) |
|
1418 | - { |
|
1419 | - throw new ImageHelper_Exception( |
|
1420 | - 'SVG image has an invalid viewBox attribute', |
|
1421 | - sprintf( |
|
1422 | - 'The [viewBox] attribute does not have an expected value: [%s] in path [%s].', |
|
1423 | - $viewBox, |
|
1424 | - $imagePath |
|
1417 | + if(count($size) != 4) |
|
1418 | + { |
|
1419 | + throw new ImageHelper_Exception( |
|
1420 | + 'SVG image has an invalid viewBox attribute', |
|
1421 | + sprintf( |
|
1422 | + 'The [viewBox] attribute does not have an expected value: [%s] in path [%s].', |
|
1423 | + $viewBox, |
|
1424 | + $imagePath |
|
1425 | 1425 | ), |
1426 | - self::ERROR_SVG_VIEWBOX_INVALID |
|
1426 | + self::ERROR_SVG_VIEWBOX_INVALID |
|
1427 | 1427 | ); |
1428 | - } |
|
1428 | + } |
|
1429 | 1429 | |
1430 | - $boxWidth = $size[2]; |
|
1431 | - $boxHeight = $size[3]; |
|
1430 | + $boxWidth = $size[2]; |
|
1431 | + $boxHeight = $size[3]; |
|
1432 | 1432 | |
1433 | - // calculate the x and y units of the document: |
|
1434 | - // @see http://tutorials.jenkov.com/svg/svg-viewport-view-box.html#viewbox |
|
1435 | - // |
|
1436 | - // The viewbox combined with the width and heigt of the svg |
|
1437 | - // allow calculating how many pixels are in one unit of the |
|
1438 | - // width and height of the document. |
|
1433 | + // calculate the x and y units of the document: |
|
1434 | + // @see http://tutorials.jenkov.com/svg/svg-viewport-view-box.html#viewbox |
|
1435 | + // |
|
1436 | + // The viewbox combined with the width and heigt of the svg |
|
1437 | + // allow calculating how many pixels are in one unit of the |
|
1438 | + // width and height of the document. |
|
1439 | 1439 | // |
1440 | - $xUnits = $svgWidth / $boxWidth; |
|
1441 | - $yUnits = $svgHeight / $boxHeight; |
|
1440 | + $xUnits = $svgWidth / $boxWidth; |
|
1441 | + $yUnits = $svgHeight / $boxHeight; |
|
1442 | 1442 | |
1443 | - $pxWidth = $xUnits * $svgWidth; |
|
1444 | - $pxHeight = $yUnits * $svgHeight; |
|
1443 | + $pxWidth = $xUnits * $svgWidth; |
|
1444 | + $pxHeight = $yUnits * $svgHeight; |
|
1445 | 1445 | |
1446 | - return array( |
|
1447 | - $pxWidth, |
|
1448 | - $pxHeight, |
|
1449 | - 'bits' => 8 |
|
1450 | - ); |
|
1451 | - } |
|
1446 | + return array( |
|
1447 | + $pxWidth, |
|
1448 | + $pxHeight, |
|
1449 | + 'bits' => 8 |
|
1450 | + ); |
|
1451 | + } |
|
1452 | 1452 | |
1453 | - /** |
|
1454 | - * Crops the image to the specified width and height, optionally |
|
1455 | - * specifying the origin position to crop from. |
|
1456 | - * |
|
1457 | - * @param integer $width |
|
1458 | - * @param integer $height |
|
1459 | - * @param integer $x |
|
1460 | - * @param integer $y |
|
1461 | - * @return ImageHelper |
|
1462 | - */ |
|
1453 | + /** |
|
1454 | + * Crops the image to the specified width and height, optionally |
|
1455 | + * specifying the origin position to crop from. |
|
1456 | + * |
|
1457 | + * @param integer $width |
|
1458 | + * @param integer $height |
|
1459 | + * @param integer $x |
|
1460 | + * @param integer $y |
|
1461 | + * @return ImageHelper |
|
1462 | + */ |
|
1463 | 1463 | public function crop(int $width, int $height, int $x=0, int $y=0) : ImageHelper |
1464 | 1464 | { |
1465 | 1465 | $new = $this->createNewImage($width, $height); |
@@ -1481,22 +1481,22 @@ discard block |
||
1481 | 1481 | return $this->newHeight; |
1482 | 1482 | } |
1483 | 1483 | |
1484 | - /** |
|
1485 | - * Calculates the average color value used in |
|
1486 | - * the image. Returns an associative array |
|
1487 | - * with the red, green, blue and alpha components, |
|
1488 | - * or a HEX color string depending on the selected |
|
1489 | - * format. |
|
1490 | - * |
|
1491 | - * NOTE: Use the calcAverageColorXXX methods for |
|
1492 | - * strict return types. |
|
1493 | - * |
|
1494 | - * @param int $format The format in which to return the color value. |
|
1495 | - * @return array|string |
|
1496 | - * |
|
1497 | - * @see ImageHelper::calcAverageColorRGB() |
|
1498 | - * @see ImageHelper::calcAverageColorHEX() |
|
1499 | - */ |
|
1484 | + /** |
|
1485 | + * Calculates the average color value used in |
|
1486 | + * the image. Returns an associative array |
|
1487 | + * with the red, green, blue and alpha components, |
|
1488 | + * or a HEX color string depending on the selected |
|
1489 | + * format. |
|
1490 | + * |
|
1491 | + * NOTE: Use the calcAverageColorXXX methods for |
|
1492 | + * strict return types. |
|
1493 | + * |
|
1494 | + * @param int $format The format in which to return the color value. |
|
1495 | + * @return array|string |
|
1496 | + * |
|
1497 | + * @see ImageHelper::calcAverageColorRGB() |
|
1498 | + * @see ImageHelper::calcAverageColorHEX() |
|
1499 | + */ |
|
1500 | 1500 | public function calcAverageColor(int $format=self::COLORFORMAT_RGB) |
1501 | 1501 | { |
1502 | 1502 | $image = $this->duplicate(); |
@@ -1505,35 +1505,35 @@ discard block |
||
1505 | 1505 | return $image->getColorAt(0, 0, $format); |
1506 | 1506 | } |
1507 | 1507 | |
1508 | - /** |
|
1509 | - * Calculates the image's average color value, and |
|
1510 | - * returns an associative array with red, green, |
|
1511 | - * blue and alpha keys. |
|
1512 | - * |
|
1513 | - * @throws ImageHelper_Exception |
|
1514 | - * @return array |
|
1515 | - */ |
|
1508 | + /** |
|
1509 | + * Calculates the image's average color value, and |
|
1510 | + * returns an associative array with red, green, |
|
1511 | + * blue and alpha keys. |
|
1512 | + * |
|
1513 | + * @throws ImageHelper_Exception |
|
1514 | + * @return array |
|
1515 | + */ |
|
1516 | 1516 | public function calcAverageColorRGB() : array |
1517 | 1517 | { |
1518 | - $result = $this->calcAverageColor(self::COLORFORMAT_RGB); |
|
1519 | - if(is_array($result)) { |
|
1520 | - return $result; |
|
1521 | - } |
|
1518 | + $result = $this->calcAverageColor(self::COLORFORMAT_RGB); |
|
1519 | + if(is_array($result)) { |
|
1520 | + return $result; |
|
1521 | + } |
|
1522 | 1522 | |
1523 | - throw new ImageHelper_Exception( |
|
1524 | - 'Unexpected color value', |
|
1525 | - sprintf('Expected an array, got [%s].', gettype($result)), |
|
1526 | - self::ERROR_UNEXPECTED_COLOR_VALUE |
|
1527 | - ); |
|
1528 | - } |
|
1529 | - |
|
1530 | - /** |
|
1531 | - * Calculates the image's average color value, and |
|
1532 | - * returns a hex color string (without the #). |
|
1533 | - * |
|
1534 | - * @throws ImageHelper_Exception |
|
1535 | - * @return string |
|
1536 | - */ |
|
1523 | + throw new ImageHelper_Exception( |
|
1524 | + 'Unexpected color value', |
|
1525 | + sprintf('Expected an array, got [%s].', gettype($result)), |
|
1526 | + self::ERROR_UNEXPECTED_COLOR_VALUE |
|
1527 | + ); |
|
1528 | + } |
|
1529 | + |
|
1530 | + /** |
|
1531 | + * Calculates the image's average color value, and |
|
1532 | + * returns a hex color string (without the #). |
|
1533 | + * |
|
1534 | + * @throws ImageHelper_Exception |
|
1535 | + * @return string |
|
1536 | + */ |
|
1537 | 1537 | public function calcAverageColorHex() : string |
1538 | 1538 | { |
1539 | 1539 | $result = $this->calcAverageColor(self::COLORFORMAT_HEX); |
@@ -1562,18 +1562,18 @@ discard block |
||
1562 | 1562 | |
1563 | 1563 | const COLORFORMAT_HEX = 2; |
1564 | 1564 | |
1565 | - /** |
|
1566 | - * Retrieves the color value at the specified pixel |
|
1567 | - * coordinates in the image. |
|
1568 | - * |
|
1569 | - * @param int $x |
|
1570 | - * @param int $y |
|
1571 | - * @param int $format The format in which to return the color value. |
|
1572 | - * @return array|string |
|
1573 | - * |
|
1574 | - * @see ImageHelper::COLORFORMAT_RGB |
|
1575 | - * @see ImageHelper::COLORFORMAT_HEX |
|
1576 | - */ |
|
1565 | + /** |
|
1566 | + * Retrieves the color value at the specified pixel |
|
1567 | + * coordinates in the image. |
|
1568 | + * |
|
1569 | + * @param int $x |
|
1570 | + * @param int $y |
|
1571 | + * @param int $format The format in which to return the color value. |
|
1572 | + * @return array|string |
|
1573 | + * |
|
1574 | + * @see ImageHelper::COLORFORMAT_RGB |
|
1575 | + * @see ImageHelper::COLORFORMAT_HEX |
|
1576 | + */ |
|
1577 | 1577 | public function getColorAt(int $x, int $y, int $format=self::COLORFORMAT_RGB) |
1578 | 1578 | { |
1579 | 1579 | if($x > $this->getWidth() || $y > $this->getHeight()) |
@@ -1601,21 +1601,21 @@ discard block |
||
1601 | 1601 | return $rgb; |
1602 | 1602 | } |
1603 | 1603 | |
1604 | - /** |
|
1605 | - * Converts an RGB value to its luminance equivalent. |
|
1606 | - * |
|
1607 | - * @param array $rgb |
|
1608 | - * @return integer Integer, from 0 to 255 (0=black, 255=white) |
|
1609 | - */ |
|
1604 | + /** |
|
1605 | + * Converts an RGB value to its luminance equivalent. |
|
1606 | + * |
|
1607 | + * @param array $rgb |
|
1608 | + * @return integer Integer, from 0 to 255 (0=black, 255=white) |
|
1609 | + */ |
|
1610 | 1610 | public static function rgb2luma(array $rgb) : int |
1611 | 1611 | { |
1612 | 1612 | return (int)floor((($rgb['red']*2)+$rgb['blue']+($rgb['green']*3))/6); |
1613 | 1613 | } |
1614 | 1614 | |
1615 | - /** |
|
1616 | - * Retrieves the brightness of the image, in percent. |
|
1617 | - * @return number |
|
1618 | - */ |
|
1615 | + /** |
|
1616 | + * Retrieves the brightness of the image, in percent. |
|
1617 | + * @return number |
|
1618 | + */ |
|
1619 | 1619 | public function getBrightness() |
1620 | 1620 | { |
1621 | 1621 | $luma = self::rgb2luma($this->calcAverageColorRGB()); |
@@ -1623,15 +1623,15 @@ discard block |
||
1623 | 1623 | return $percent; |
1624 | 1624 | } |
1625 | 1625 | |
1626 | - /** |
|
1627 | - * Retrieves an md5 hash of the source image file. |
|
1628 | - * |
|
1629 | - * NOTE: Only works when the helper has been created |
|
1630 | - * from a file. Otherwise an exception is thrown. |
|
1631 | - * |
|
1632 | - * @return string |
|
1633 | - * @throws ImageHelper_Exception |
|
1634 | - */ |
|
1626 | + /** |
|
1627 | + * Retrieves an md5 hash of the source image file. |
|
1628 | + * |
|
1629 | + * NOTE: Only works when the helper has been created |
|
1630 | + * from a file. Otherwise an exception is thrown. |
|
1631 | + * |
|
1632 | + * @return string |
|
1633 | + * @throws ImageHelper_Exception |
|
1634 | + */ |
|
1635 | 1635 | public function getHash() |
1636 | 1636 | { |
1637 | 1637 | ob_start(); |
@@ -136,10 +136,10 @@ discard block |
||
136 | 136 | 'gif' |
137 | 137 | ); |
138 | 138 | |
139 | - public function __construct($sourceFile=null, $resource=null, $type=null) |
|
139 | + public function __construct($sourceFile = null, $resource = null, $type = null) |
|
140 | 140 | { |
141 | 141 | // ensure that the GD library is installed |
142 | - if(!function_exists('imagecreate')) |
|
142 | + if (!function_exists('imagecreate')) |
|
143 | 143 | { |
144 | 144 | throw new ImageHelper_Exception( |
145 | 145 | 'The PHP GD extension is not installed or not enabled.', |
@@ -148,7 +148,7 @@ discard block |
||
148 | 148 | ); |
149 | 149 | } |
150 | 150 | |
151 | - if(is_resource($resource)) |
|
151 | + if (is_resource($resource)) |
|
152 | 152 | { |
153 | 153 | $this->sourceImage = $resource; |
154 | 154 | $this->type = $type; |
@@ -172,21 +172,21 @@ discard block |
||
172 | 172 | if (is_null($this->type)) { |
173 | 173 | throw new ImageHelper_Exception( |
174 | 174 | 'Error opening image', |
175 | - 'Not a valid supported image type for image ' . $this->file, |
|
175 | + 'Not a valid supported image type for image '.$this->file, |
|
176 | 176 | self::ERROR_UNSUPPORTED_IMAGE_TYPE |
177 | 177 | ); |
178 | 178 | } |
179 | 179 | |
180 | 180 | $this->info = self::getImageSize($this->file); |
181 | 181 | |
182 | - if(!$this->isVector()) |
|
182 | + if (!$this->isVector()) |
|
183 | 183 | { |
184 | - $method = 'imagecreatefrom' . $this->type; |
|
184 | + $method = 'imagecreatefrom'.$this->type; |
|
185 | 185 | $this->sourceImage = $method($this->file); |
186 | 186 | if (!$this->sourceImage) { |
187 | 187 | throw new ImageHelper_Exception( |
188 | 188 | 'Error creating new image', |
189 | - $method . ' failed', |
|
189 | + $method.' failed', |
|
190 | 190 | self::ERROR_FAILED_TO_CREATE_NEW_IMAGE |
191 | 191 | ); |
192 | 192 | } |
@@ -198,7 +198,7 @@ discard block |
||
198 | 198 | $this->width = $this->info->getWidth(); |
199 | 199 | $this->height = $this->info->getHeight(); |
200 | 200 | |
201 | - if(!$this->isVector()) { |
|
201 | + if (!$this->isVector()) { |
|
202 | 202 | $this->setNewImage($this->duplicateImage($this->sourceImage)); |
203 | 203 | } |
204 | 204 | } |
@@ -214,10 +214,10 @@ discard block |
||
214 | 214 | * |
215 | 215 | * @see ImageHelper::ERROR_CANNOT_CREATE_IMAGE_OBJECT |
216 | 216 | */ |
217 | - public static function createNew($width, $height, $type='png') |
|
217 | + public static function createNew($width, $height, $type = 'png') |
|
218 | 218 | { |
219 | 219 | $img = imagecreatetruecolor($width, $height); |
220 | - if($img !== false) { |
|
220 | + if ($img !== false) { |
|
221 | 221 | return self::createFromResource($img, 'png'); |
222 | 222 | } |
223 | 223 | |
@@ -240,7 +240,7 @@ discard block |
||
240 | 240 | * @param string $type The target image type, e.g. "jpeg", "png", etc. |
241 | 241 | * @return ImageHelper |
242 | 242 | */ |
243 | - public static function createFromResource($resource, ?string $type=null) |
|
243 | + public static function createFromResource($resource, ?string $type = null) |
|
244 | 244 | { |
245 | 245 | self::requireResource($resource); |
246 | 246 | |
@@ -272,7 +272,7 @@ discard block |
||
272 | 272 | */ |
273 | 273 | public static function setConfig($name, $value) |
274 | 274 | { |
275 | - if(isset(self::$config[$name])) { |
|
275 | + if (isset(self::$config[$name])) { |
|
276 | 276 | self::$config[$name] = $value; |
277 | 277 | } |
278 | 278 | } |
@@ -283,7 +283,7 @@ discard block |
||
283 | 283 | * |
284 | 284 | * @param bool $enabled |
285 | 285 | */ |
286 | - public static function setAutoMemoryAdjustment($enabled=true) |
|
286 | + public static function setAutoMemoryAdjustment($enabled = true) |
|
287 | 287 | { |
288 | 288 | self::setConfig('auto-memory-adjustment', $enabled); |
289 | 289 | } |
@@ -317,7 +317,7 @@ discard block |
||
317 | 317 | |
318 | 318 | public function enableAlpha() |
319 | 319 | { |
320 | - if(!$this->alpha) |
|
320 | + if (!$this->alpha) |
|
321 | 321 | { |
322 | 322 | self::addAlphaSupport($this->newImage, false); |
323 | 323 | $this->alpha = true; |
@@ -348,9 +348,9 @@ discard block |
||
348 | 348 | * @param number $percent |
349 | 349 | * @return ImageHelper |
350 | 350 | */ |
351 | - public function sharpen($percent=0) |
|
351 | + public function sharpen($percent = 0) |
|
352 | 352 | { |
353 | - if($percent <= 0) { |
|
353 | + if ($percent <= 0) { |
|
354 | 354 | return $this; |
355 | 355 | } |
356 | 356 | |
@@ -359,9 +359,9 @@ discard block |
||
359 | 359 | return $this->convolute($factor); |
360 | 360 | } |
361 | 361 | |
362 | - public function blur($percent=0) |
|
362 | + public function blur($percent = 0) |
|
363 | 363 | { |
364 | - if($percent <= 0) { |
|
364 | + if ($percent <= 0) { |
|
365 | 365 | return $this; |
366 | 366 | } |
367 | 367 | |
@@ -374,12 +374,12 @@ discard block |
||
374 | 374 | { |
375 | 375 | // get a value thats equal to 64 - abs( factor ) |
376 | 376 | // ( using min/max to limited the factor to 0 - 64 to not get out of range values ) |
377 | - $val1Adjustment = 64 - min( 64, max( 0, abs( $factor ) ) ); |
|
377 | + $val1Adjustment = 64 - min(64, max(0, abs($factor))); |
|
378 | 378 | |
379 | 379 | // the base factor for the "current" pixel depends on if we are blurring or sharpening. |
380 | 380 | // If we are blurring use 1, if sharpening use 9. |
381 | 381 | $val1Base = 9; |
382 | - if( abs( $factor ) != $factor ) { |
|
382 | + if (abs($factor) != $factor) { |
|
383 | 383 | $val1Base = 1; |
384 | 384 | } |
385 | 385 | |
@@ -392,24 +392,24 @@ discard block |
||
392 | 392 | |
393 | 393 | // the value for the surrounding pixels is either positive or negative depending on if we are blurring or sharpening. |
394 | 394 | $val2 = -1; |
395 | - if( abs( $factor ) != $factor ) { |
|
395 | + if (abs($factor) != $factor) { |
|
396 | 396 | $val2 = 1; |
397 | 397 | } |
398 | 398 | |
399 | 399 | // setup matrix .. |
400 | 400 | $matrix = array( |
401 | - array( $val2, $val2, $val2 ), |
|
402 | - array( $val2, $val1, $val2 ), |
|
403 | - array( $val2, $val2, $val2 ) |
|
401 | + array($val2, $val2, $val2), |
|
402 | + array($val2, $val1, $val2), |
|
403 | + array($val2, $val2, $val2) |
|
404 | 404 | ); |
405 | 405 | |
406 | 406 | // calculate the correct divisor |
407 | 407 | // actual divisor is equal to "$divisor = $val1 + $val2 * 8;" |
408 | 408 | // but the following line is more generic |
409 | - $divisor = array_sum( array_map( 'array_sum', $matrix ) ); |
|
409 | + $divisor = array_sum(array_map('array_sum', $matrix)); |
|
410 | 410 | |
411 | 411 | // apply the matrix |
412 | - imageconvolution( $this->newImage, $matrix, $divisor, 0 ); |
|
412 | + imageconvolution($this->newImage, $matrix, $divisor, 0); |
|
413 | 413 | |
414 | 414 | return $this; |
415 | 415 | } |
@@ -535,7 +535,7 @@ discard block |
||
535 | 535 | */ |
536 | 536 | public function resample(?int $width = null, ?int $height = null) : ImageHelper |
537 | 537 | { |
538 | - if($this->isVector()) { |
|
538 | + if ($this->isVector()) { |
|
539 | 539 | return $this; |
540 | 540 | } |
541 | 541 | |
@@ -556,7 +556,7 @@ discard block |
||
556 | 556 | |
557 | 557 | public function resampleAndCrop($width, $height) : ImageHelper |
558 | 558 | { |
559 | - if($this->isVector()) { |
|
559 | + if ($this->isVector()) { |
|
560 | 560 | return $this; |
561 | 561 | } |
562 | 562 | |
@@ -603,14 +603,14 @@ discard block |
||
603 | 603 | * @param resource $canvas |
604 | 604 | * @param bool $fill Whether to fill the whole canvas with the transparency |
605 | 605 | */ |
606 | - public static function addAlphaSupport($canvas, $fill=true) |
|
606 | + public static function addAlphaSupport($canvas, $fill = true) |
|
607 | 607 | { |
608 | 608 | self::requireResource($canvas); |
609 | 609 | |
610 | - imagealphablending($canvas,true); |
|
610 | + imagealphablending($canvas, true); |
|
611 | 611 | imagesavealpha($canvas, true); |
612 | 612 | |
613 | - if($fill) { |
|
613 | + if ($fill) { |
|
614 | 614 | self::fillImageTransparent($canvas); |
615 | 615 | } |
616 | 616 | } |
@@ -620,13 +620,13 @@ discard block |
||
620 | 620 | return $this->alpha; |
621 | 621 | } |
622 | 622 | |
623 | - public function save(string $targetFile, $dispose=true) |
|
623 | + public function save(string $targetFile, $dispose = true) |
|
624 | 624 | { |
625 | - if($this->isVector()) { |
|
625 | + if ($this->isVector()) { |
|
626 | 626 | return true; |
627 | 627 | } |
628 | 628 | |
629 | - if(!is_resource($this->newImage)) { |
|
629 | + if (!is_resource($this->newImage)) { |
|
630 | 630 | throw new ImageHelper_Exception( |
631 | 631 | 'Error creating new image', |
632 | 632 | 'Cannot save an image, no valid image resource was created. You have to call one of the resample methods to create a new image.', |
@@ -638,7 +638,7 @@ discard block |
||
638 | 638 | unlink($targetFile); |
639 | 639 | } |
640 | 640 | |
641 | - $method = 'image' . $this->type; |
|
641 | + $method = 'image'.$this->type; |
|
642 | 642 | if (!$method($this->newImage, $targetFile, $this->resolveQuality())) { |
643 | 643 | throw new ImageHelper_Exception( |
644 | 644 | 'Error creating new image', |
@@ -659,7 +659,7 @@ discard block |
||
659 | 659 | ); |
660 | 660 | } |
661 | 661 | |
662 | - if($dispose) { |
|
662 | + if ($dispose) { |
|
663 | 663 | $this->dispose(); |
664 | 664 | } |
665 | 665 | |
@@ -668,11 +668,11 @@ discard block |
||
668 | 668 | |
669 | 669 | public function dispose() |
670 | 670 | { |
671 | - if(is_resource($this->sourceImage)) { |
|
671 | + if (is_resource($this->sourceImage)) { |
|
672 | 672 | imagedestroy($this->sourceImage); |
673 | 673 | } |
674 | 674 | |
675 | - if(is_resource($this->newImage)) { |
|
675 | + if (is_resource($this->newImage)) { |
|
676 | 676 | imagedestroy($this->newImage); |
677 | 677 | } |
678 | 678 | } |
@@ -725,7 +725,7 @@ discard block |
||
725 | 725 | */ |
726 | 726 | protected function adjustMemory() : bool |
727 | 727 | { |
728 | - if(!self::$config['auto-memory-adjustment']) { |
|
728 | + if (!self::$config['auto-memory-adjustment']) { |
|
729 | 729 | return true; |
730 | 730 | } |
731 | 731 | |
@@ -754,7 +754,7 @@ discard block |
||
754 | 754 | if (function_exists('memory_get_usage') && memory_get_usage() + $memoryNeeded > $memoryLimit) { |
755 | 755 | $newLimit = ($memoryLimit + (memory_get_usage() + $memoryNeeded)) / $MB; |
756 | 756 | $newLimit = ceil($newLimit); |
757 | - ini_set('memory_limit', $newLimit . 'M'); |
|
757 | + ini_set('memory_limit', $newLimit.'M'); |
|
758 | 758 | |
759 | 759 | return true; |
760 | 760 | } |
@@ -785,16 +785,16 @@ discard block |
||
785 | 785 | */ |
786 | 786 | protected function resampleImage(int $newWidth, int $newHeight) : ImageHelper |
787 | 787 | { |
788 | - if($this->isVector()) { |
|
788 | + if ($this->isVector()) { |
|
789 | 789 | return $this; |
790 | 790 | } |
791 | 791 | |
792 | - if($this->newWidth==$newWidth && $this->newHeight==$newHeight) { |
|
792 | + if ($this->newWidth == $newWidth && $this->newHeight == $newHeight) { |
|
793 | 793 | return $this; |
794 | 794 | } |
795 | 795 | |
796 | - if($newWidth < 1) { $newWidth = 1; } |
|
797 | - if($newHeight < 1) { $newHeight = 1; } |
|
796 | + if ($newWidth < 1) { $newWidth = 1; } |
|
797 | + if ($newHeight < 1) { $newHeight = 1; } |
|
798 | 798 | |
799 | 799 | $this->adjustMemory(); |
800 | 800 | |
@@ -858,11 +858,11 @@ discard block |
||
858 | 858 | * @param string $imageType The image format to send, i.e. "jpeg", "png" |
859 | 859 | * @param int $quality The quality to use for the image. This is 0-9 (0=no compression, 9=max) for PNG, and 0-100 (0=lowest, 100=highest quality) for JPG |
860 | 860 | */ |
861 | - public static function displayImageStream($resource, $imageType, $quality=-1) |
|
861 | + public static function displayImageStream($resource, $imageType, $quality = -1) |
|
862 | 862 | { |
863 | 863 | $imageType = strtolower($imageType); |
864 | 864 | |
865 | - if(!in_array($imageType, self::$streamTypes)) { |
|
865 | + if (!in_array($imageType, self::$streamTypes)) { |
|
866 | 866 | throw new ImageHelper_Exception( |
867 | 867 | 'Invalid image stream type', |
868 | 868 | sprintf( |
@@ -873,9 +873,9 @@ discard block |
||
873 | 873 | ); |
874 | 874 | } |
875 | 875 | |
876 | - header('Content-type:image/' . $imageType); |
|
876 | + header('Content-type:image/'.$imageType); |
|
877 | 877 | |
878 | - $function = 'image' . $imageType; |
|
878 | + $function = 'image'.$imageType; |
|
879 | 879 | |
880 | 880 | $function($resource, null, $quality); |
881 | 881 | } |
@@ -891,7 +891,7 @@ discard block |
||
891 | 891 | if (headers_sent($file, $line)) { |
892 | 892 | throw new ImageHelper_Exception( |
893 | 893 | 'Error displaying image', |
894 | - 'Headers have already been sent: in file ' . $file . ':' . $line, |
|
894 | + 'Headers have already been sent: in file '.$file.':'.$line, |
|
895 | 895 | self::ERROR_HEADERS_ALREADY_SENT |
896 | 896 | ); |
897 | 897 | } |
@@ -908,16 +908,16 @@ discard block |
||
908 | 908 | } |
909 | 909 | |
910 | 910 | $format = self::getFileImageType($imageFile); |
911 | - if($format == 'svg') { |
|
911 | + if ($format == 'svg') { |
|
912 | 912 | $format = 'svg+xml'; |
913 | 913 | } |
914 | 914 | |
915 | - $contentType = 'image/' . $format; |
|
915 | + $contentType = 'image/'.$format; |
|
916 | 916 | |
917 | 917 | header('Content-Type: '.$contentType); |
918 | - header("Last-Modified: " . gmdate("D, d M Y H:i:s", filemtime($imageFile)) . " GMT"); |
|
918 | + header("Last-Modified: ".gmdate("D, d M Y H:i:s", filemtime($imageFile))." GMT"); |
|
919 | 919 | header('Cache-Control: public'); |
920 | - header('Content-Length: ' . filesize($imageFile)); |
|
920 | + header('Content-Length: '.filesize($imageFile)); |
|
921 | 921 | |
922 | 922 | readfile($imageFile); |
923 | 923 | } |
@@ -935,7 +935,7 @@ discard block |
||
935 | 935 | * |
936 | 936 | * @param array $color A color definition, as an associative array with red, green, and blue keys. If not specified, the color at pixel position 0,0 will be used. |
937 | 937 | */ |
938 | - public function trim($color=null) |
|
938 | + public function trim($color = null) |
|
939 | 939 | { |
940 | 940 | return $this->trimImage($this->newImage, $color); |
941 | 941 | } |
@@ -952,7 +952,7 @@ discard block |
||
952 | 952 | $color = imagecolorsforindex($img, $colorIndex); |
953 | 953 | |
954 | 954 | // it seems imagecolorsforindex may return false (undocumented, unproven) |
955 | - if(is_array($color)) { |
|
955 | + if (is_array($color)) { |
|
956 | 956 | return $color; |
957 | 957 | } |
958 | 958 | |
@@ -972,15 +972,15 @@ discard block |
||
972 | 972 | * @param array $color A color definition, as an associative array with red, green, blue and alpha keys. If not specified, the color at pixel position 0,0 will be used. |
973 | 973 | * @return ImageHelper |
974 | 974 | */ |
975 | - protected function trimImage($img, ?array $color=null) : ImageHelper |
|
975 | + protected function trimImage($img, ?array $color = null) : ImageHelper |
|
976 | 976 | { |
977 | - if($this->isVector()) { |
|
977 | + if ($this->isVector()) { |
|
978 | 978 | return $this; |
979 | 979 | } |
980 | 980 | |
981 | 981 | self::requireResource($img); |
982 | 982 | |
983 | - if(empty($color)) |
|
983 | + if (empty($color)) |
|
984 | 984 | { |
985 | 985 | $color = imagecolorat($img, 0, 0); |
986 | 986 | $color = $this->getIndexedColors($img, $color); |
@@ -997,16 +997,16 @@ discard block |
||
997 | 997 | $ymax = null; |
998 | 998 | |
999 | 999 | // Start scanning for the edges. |
1000 | - for ($iy=0; $iy<$imh; $iy++) |
|
1000 | + for ($iy = 0; $iy < $imh; $iy++) |
|
1001 | 1001 | { |
1002 | 1002 | $first = true; |
1003 | 1003 | |
1004 | - for ($ix=0; $ix<$imw; $ix++) |
|
1004 | + for ($ix = 0; $ix < $imw; $ix++) |
|
1005 | 1005 | { |
1006 | 1006 | $ndx = imagecolorat($img, $ix, $iy); |
1007 | 1007 | $colors = $this->getIndexedColors($img, $ndx); |
1008 | 1008 | |
1009 | - if(!$this->colorsMatch($colors, $color)) |
|
1009 | + if (!$this->colorsMatch($colors, $color)) |
|
1010 | 1010 | { |
1011 | 1011 | if ($xmin > $ix) { $xmin = $ix; } |
1012 | 1012 | if ($xmax < $ix) { $xmax = $ix; } |
@@ -1014,7 +1014,7 @@ discard block |
||
1014 | 1014 | |
1015 | 1015 | $ymax = $iy; |
1016 | 1016 | |
1017 | - if($first) |
|
1017 | + if ($first) |
|
1018 | 1018 | { |
1019 | 1019 | $ix = $xmax; |
1020 | 1020 | $first = false; |
@@ -1024,18 +1024,18 @@ discard block |
||
1024 | 1024 | } |
1025 | 1025 | |
1026 | 1026 | // no trimming border found |
1027 | - if($ymax === null && $ymax === null) { |
|
1027 | + if ($ymax === null && $ymax === null) { |
|
1028 | 1028 | return $this; |
1029 | 1029 | } |
1030 | 1030 | |
1031 | 1031 | // The new width and height of the image. |
1032 | - $imw = 1+$xmax-$xmin; // Image width in pixels |
|
1033 | - $imh = 1+$ymax-$ymin; // Image height in pixels |
|
1032 | + $imw = 1 + $xmax - $xmin; // Image width in pixels |
|
1033 | + $imh = 1 + $ymax - $ymin; // Image height in pixels |
|
1034 | 1034 | |
1035 | 1035 | // Make another image to place the trimmed version in. |
1036 | 1036 | $im2 = $this->createNewImage($imw, $imh); |
1037 | 1037 | |
1038 | - if($color['alpha'] > 0) |
|
1038 | + if ($color['alpha'] > 0) |
|
1039 | 1039 | { |
1040 | 1040 | $bg2 = imagecolorallocatealpha($im2, $color['red'], $color['green'], $color['blue'], $color['alpha']); |
1041 | 1041 | imagecolortransparent($im2, $bg2); |
@@ -1071,7 +1071,7 @@ discard block |
||
1071 | 1071 | |
1072 | 1072 | $this->newImage = $image; |
1073 | 1073 | $this->newWidth = imagesx($image); |
1074 | - $this->newHeight= imagesy($image); |
|
1074 | + $this->newHeight = imagesy($image); |
|
1075 | 1075 | } |
1076 | 1076 | |
1077 | 1077 | /** |
@@ -1082,7 +1082,7 @@ discard block |
||
1082 | 1082 | */ |
1083 | 1083 | protected static function requireResource($subject) |
1084 | 1084 | { |
1085 | - if(is_resource($subject)) { |
|
1085 | + if (is_resource($subject)) { |
|
1086 | 1086 | return; |
1087 | 1087 | } |
1088 | 1088 | |
@@ -1108,7 +1108,7 @@ discard block |
||
1108 | 1108 | { |
1109 | 1109 | $img = imagecreatetruecolor($width, $height); |
1110 | 1110 | |
1111 | - if($img === false) |
|
1111 | + if ($img === false) |
|
1112 | 1112 | { |
1113 | 1113 | throw new ImageHelper_Exception( |
1114 | 1114 | 'Error creating new image', |
@@ -1132,8 +1132,8 @@ discard block |
||
1132 | 1132 | protected function colorsMatch($a, $b) : bool |
1133 | 1133 | { |
1134 | 1134 | $parts = array('red', 'green', 'blue'); |
1135 | - foreach($parts as $part) { |
|
1136 | - if($a[$part] != $b[$part]) { |
|
1135 | + foreach ($parts as $part) { |
|
1136 | + if ($a[$part] != $b[$part]) { |
|
1137 | 1137 | return false; |
1138 | 1138 | } |
1139 | 1139 | } |
@@ -1141,7 +1141,7 @@ discard block |
||
1141 | 1141 | return true; |
1142 | 1142 | } |
1143 | 1143 | |
1144 | - public function fillWhite($x=0, $y=0) |
|
1144 | + public function fillWhite($x = 0, $y = 0) |
|
1145 | 1145 | { |
1146 | 1146 | $this->addRGBColor('white', 255, 255, 255); |
1147 | 1147 | return $this->fill('white', $x, $y); |
@@ -1161,11 +1161,11 @@ discard block |
||
1161 | 1161 | self::requireResource($resource); |
1162 | 1162 | |
1163 | 1163 | $transparent = imagecolorallocatealpha($resource, 89, 14, 207, 127); |
1164 | - imagecolortransparent ($resource, $transparent); |
|
1164 | + imagecolortransparent($resource, $transparent); |
|
1165 | 1165 | imagefill($resource, 0, 0, $transparent); |
1166 | 1166 | } |
1167 | 1167 | |
1168 | - public function fill($colorName, $x=0, $y=0) |
|
1168 | + public function fill($colorName, $x = 0, $y = 0) |
|
1169 | 1169 | { |
1170 | 1170 | imagefill($this->newImage, $x, $y, $this->colors[$colorName]); |
1171 | 1171 | return $this; |
@@ -1179,7 +1179,7 @@ discard block |
||
1179 | 1179 | return $this; |
1180 | 1180 | } |
1181 | 1181 | |
1182 | - public function textTTF($text, $size, $colorName, $x=0, $y=0, $angle=0) |
|
1182 | + public function textTTF($text, $size, $colorName, $x = 0, $y = 0, $angle = 0) |
|
1183 | 1183 | { |
1184 | 1184 | imagealphablending($this->newImage, true); |
1185 | 1185 | |
@@ -1198,11 +1198,11 @@ discard block |
||
1198 | 1198 | return $this->newImage; |
1199 | 1199 | } |
1200 | 1200 | |
1201 | - public function paste(ImageHelper $target, $xpos=0, $ypos=0, $sourceX=0, $sourceY=0) |
|
1201 | + public function paste(ImageHelper $target, $xpos = 0, $ypos = 0, $sourceX = 0, $sourceY = 0) |
|
1202 | 1202 | { |
1203 | 1203 | $img = $target->getImage(); |
1204 | 1204 | |
1205 | - if($target->isAlpha()) { |
|
1205 | + if ($target->isAlpha()) { |
|
1206 | 1206 | $this->enableAlpha(); |
1207 | 1207 | } |
1208 | 1208 | |
@@ -1248,10 +1248,10 @@ discard block |
||
1248 | 1248 | public function fitText($text, $matchWidth) |
1249 | 1249 | { |
1250 | 1250 | $sizes = array(); |
1251 | - for($i=1; $i<=1000; $i=$i+0.1) { |
|
1251 | + for ($i = 1; $i <= 1000; $i = $i + 0.1) { |
|
1252 | 1252 | $size = $this->calcTextSize($text, $i); |
1253 | 1253 | $sizes[] = $size; |
1254 | - if($size['width'] >= $matchWidth) { |
|
1254 | + if ($size['width'] >= $matchWidth) { |
|
1255 | 1255 | break; |
1256 | 1256 | } |
1257 | 1257 | } |
@@ -1263,7 +1263,7 @@ discard block |
||
1263 | 1263 | $diffLast = $last['width'] - $matchWidth; |
1264 | 1264 | $diffPrev = $matchWidth - $prev['width']; |
1265 | 1265 | |
1266 | - if($diffLast <= $diffPrev) { |
|
1266 | + if ($diffLast <= $diffPrev) { |
|
1267 | 1267 | return $last; |
1268 | 1268 | } |
1269 | 1269 | |
@@ -1291,14 +1291,14 @@ discard block |
||
1291 | 1291 | 'bottom_left_y' => $box[1], |
1292 | 1292 | 'bottom_right_x' => $box[2], |
1293 | 1293 | 'bottom_right_y' => $box[3], |
1294 | - 'width' => $right-$left, |
|
1295 | - 'height' => $bottom-$top |
|
1294 | + 'width' => $right - $left, |
|
1295 | + 'height' => $bottom - $top |
|
1296 | 1296 | ); |
1297 | 1297 | } |
1298 | 1298 | |
1299 | 1299 | protected function requireTTFFont() |
1300 | 1300 | { |
1301 | - if(isset($this->TTFFile)) { |
|
1301 | + if (isset($this->TTFFile)) { |
|
1302 | 1302 | return; |
1303 | 1303 | } |
1304 | 1304 | |
@@ -1333,7 +1333,7 @@ discard block |
||
1333 | 1333 | */ |
1334 | 1334 | public static function getImageSize($pathOrResource) : ImageHelper_Size |
1335 | 1335 | { |
1336 | - if(is_resource($pathOrResource)) |
|
1336 | + if (is_resource($pathOrResource)) |
|
1337 | 1337 | { |
1338 | 1338 | return new ImageHelper_Size(array( |
1339 | 1339 | 'width' => imagesx($pathOrResource), |
@@ -1347,7 +1347,7 @@ discard block |
||
1347 | 1347 | |
1348 | 1348 | $info = false; |
1349 | 1349 | $method = 'getImageSize_'.$type; |
1350 | - if(method_exists(__CLASS__, $method)) |
|
1350 | + if (method_exists(__CLASS__, $method)) |
|
1351 | 1351 | { |
1352 | 1352 | $info = call_user_func(array(__CLASS__, $method), $pathOrResource); |
1353 | 1353 | } |
@@ -1356,7 +1356,7 @@ discard block |
||
1356 | 1356 | $info = getimagesize($pathOrResource); |
1357 | 1357 | } |
1358 | 1358 | |
1359 | - if($info !== false) { |
|
1359 | + if ($info !== false) { |
|
1360 | 1360 | return new ImageHelper_Size($info); |
1361 | 1361 | } |
1362 | 1362 | |
@@ -1382,7 +1382,7 @@ discard block |
||
1382 | 1382 | $xml = XMLHelper::createSimplexml(); |
1383 | 1383 | $xml->loadFile($imagePath); |
1384 | 1384 | |
1385 | - if($xml->hasErrors()) { |
|
1385 | + if ($xml->hasErrors()) { |
|
1386 | 1386 | throw new ImageHelper_Exception( |
1387 | 1387 | 'Error opening SVG image', |
1388 | 1388 | sprintf( |
@@ -1397,7 +1397,7 @@ discard block |
||
1397 | 1397 | $xml->dispose(); |
1398 | 1398 | unset($xml); |
1399 | 1399 | |
1400 | - if(!isset($data['@attributes']) || !isset($data['@attributes']['viewBox'])) { |
|
1400 | + if (!isset($data['@attributes']) || !isset($data['@attributes']['viewBox'])) { |
|
1401 | 1401 | throw new ImageHelper_Exception( |
1402 | 1402 | 'SVG Image is corrupted', |
1403 | 1403 | sprintf( |
@@ -1414,7 +1414,7 @@ discard block |
||
1414 | 1414 | $viewBox = str_replace(' ', ',', $data['@attributes']['viewBox']); |
1415 | 1415 | $size = explode(',', $viewBox); |
1416 | 1416 | |
1417 | - if(count($size) != 4) |
|
1417 | + if (count($size) != 4) |
|
1418 | 1418 | { |
1419 | 1419 | throw new ImageHelper_Exception( |
1420 | 1420 | 'SVG image has an invalid viewBox attribute', |
@@ -1460,7 +1460,7 @@ discard block |
||
1460 | 1460 | * @param integer $y |
1461 | 1461 | * @return ImageHelper |
1462 | 1462 | */ |
1463 | - public function crop(int $width, int $height, int $x=0, int $y=0) : ImageHelper |
|
1463 | + public function crop(int $width, int $height, int $x = 0, int $y = 0) : ImageHelper |
|
1464 | 1464 | { |
1465 | 1465 | $new = $this->createNewImage($width, $height); |
1466 | 1466 | |
@@ -1497,7 +1497,7 @@ discard block |
||
1497 | 1497 | * @see ImageHelper::calcAverageColorRGB() |
1498 | 1498 | * @see ImageHelper::calcAverageColorHEX() |
1499 | 1499 | */ |
1500 | - public function calcAverageColor(int $format=self::COLORFORMAT_RGB) |
|
1500 | + public function calcAverageColor(int $format = self::COLORFORMAT_RGB) |
|
1501 | 1501 | { |
1502 | 1502 | $image = $this->duplicate(); |
1503 | 1503 | $image->resample(1, 1); |
@@ -1516,7 +1516,7 @@ discard block |
||
1516 | 1516 | public function calcAverageColorRGB() : array |
1517 | 1517 | { |
1518 | 1518 | $result = $this->calcAverageColor(self::COLORFORMAT_RGB); |
1519 | - if(is_array($result)) { |
|
1519 | + if (is_array($result)) { |
|
1520 | 1520 | return $result; |
1521 | 1521 | } |
1522 | 1522 | |
@@ -1537,7 +1537,7 @@ discard block |
||
1537 | 1537 | public function calcAverageColorHex() : string |
1538 | 1538 | { |
1539 | 1539 | $result = $this->calcAverageColor(self::COLORFORMAT_HEX); |
1540 | - if(is_string($result)) { |
|
1540 | + if (is_string($result)) { |
|
1541 | 1541 | return $result; |
1542 | 1542 | } |
1543 | 1543 | |
@@ -1574,9 +1574,9 @@ discard block |
||
1574 | 1574 | * @see ImageHelper::COLORFORMAT_RGB |
1575 | 1575 | * @see ImageHelper::COLORFORMAT_HEX |
1576 | 1576 | */ |
1577 | - public function getColorAt(int $x, int $y, int $format=self::COLORFORMAT_RGB) |
|
1577 | + public function getColorAt(int $x, int $y, int $format = self::COLORFORMAT_RGB) |
|
1578 | 1578 | { |
1579 | - if($x > $this->getWidth() || $y > $this->getHeight()) |
|
1579 | + if ($x > $this->getWidth() || $y > $this->getHeight()) |
|
1580 | 1580 | { |
1581 | 1581 | throw new ImageHelper_Exception( |
1582 | 1582 | 'Position out of bounds', |
@@ -1594,7 +1594,7 @@ discard block |
||
1594 | 1594 | $idx = imagecolorat($this->newImage, $x, $y); |
1595 | 1595 | $rgb = $this->getIndexedColors($this->newImage, $idx); |
1596 | 1596 | |
1597 | - if($format == self::COLORFORMAT_HEX) { |
|
1597 | + if ($format == self::COLORFORMAT_HEX) { |
|
1598 | 1598 | return self::rgb2hex($rgb); |
1599 | 1599 | } |
1600 | 1600 | |
@@ -1609,7 +1609,7 @@ discard block |
||
1609 | 1609 | */ |
1610 | 1610 | public static function rgb2luma(array $rgb) : int |
1611 | 1611 | { |
1612 | - return (int)floor((($rgb['red']*2)+$rgb['blue']+($rgb['green']*3))/6); |
|
1612 | + return (int)floor((($rgb['red'] * 2) + $rgb['blue'] + ($rgb['green'] * 3)) / 6); |
|
1613 | 1613 | } |
1614 | 1614 | |
1615 | 1615 | /** |
@@ -181,8 +181,7 @@ discard block |
||
181 | 181 | if($datefrom instanceof \DateTime) |
182 | 182 | { |
183 | 183 | $converter->setDateFrom($datefrom); |
184 | - } |
|
185 | - else |
|
184 | + } else |
|
186 | 185 | { |
187 | 186 | $converter->setDateFrom(self::timestamp2date($datefrom)); |
188 | 187 | } |
@@ -190,8 +189,7 @@ discard block |
||
190 | 189 | if($dateto instanceof \DateTime) |
191 | 190 | { |
192 | 191 | $converter->setDateTo($dateto); |
193 | - } |
|
194 | - else if($dateto > 0) |
|
192 | + } else if($dateto > 0) |
|
195 | 193 | { |
196 | 194 | $converter->setDateTo(self::timestamp2date($dateto)); |
197 | 195 | } |
@@ -160,41 +160,41 @@ discard block |
||
160 | 160 | return implode(', ', $tokens) . ' ' . t('and') . ' ' . $last; |
161 | 161 | } |
162 | 162 | |
163 | - /** |
|
164 | - * Converts a timestamp into an easily understandable |
|
165 | - * format, e.g. "2 hours", "1 day", "3 months" |
|
166 | - * |
|
167 | - * If you set the date to parameter, the difference |
|
168 | - * will be calculated between the two dates and not |
|
169 | - * the current time. |
|
170 | - * |
|
171 | - * @param integer|\DateTime $datefrom |
|
172 | - * @param integer|\DateTime $dateto |
|
173 | - * @return string |
|
174 | - */ |
|
163 | + /** |
|
164 | + * Converts a timestamp into an easily understandable |
|
165 | + * format, e.g. "2 hours", "1 day", "3 months" |
|
166 | + * |
|
167 | + * If you set the date to parameter, the difference |
|
168 | + * will be calculated between the two dates and not |
|
169 | + * the current time. |
|
170 | + * |
|
171 | + * @param integer|\DateTime $datefrom |
|
172 | + * @param integer|\DateTime $dateto |
|
173 | + * @return string |
|
174 | + */ |
|
175 | 175 | public static function duration2string($datefrom, $dateto = -1) : string |
176 | 176 | { |
177 | - $converter = new ConvertHelper_DurationConverter(); |
|
177 | + $converter = new ConvertHelper_DurationConverter(); |
|
178 | 178 | |
179 | - if($datefrom instanceof \DateTime) |
|
180 | - { |
|
181 | - $converter->setDateFrom($datefrom); |
|
182 | - } |
|
183 | - else |
|
184 | - { |
|
185 | - $converter->setDateFrom(self::timestamp2date($datefrom)); |
|
186 | - } |
|
179 | + if($datefrom instanceof \DateTime) |
|
180 | + { |
|
181 | + $converter->setDateFrom($datefrom); |
|
182 | + } |
|
183 | + else |
|
184 | + { |
|
185 | + $converter->setDateFrom(self::timestamp2date($datefrom)); |
|
186 | + } |
|
187 | 187 | |
188 | - if($dateto instanceof \DateTime) |
|
189 | - { |
|
190 | - $converter->setDateTo($dateto); |
|
191 | - } |
|
192 | - else if($dateto > 0) |
|
193 | - { |
|
194 | - $converter->setDateTo(self::timestamp2date($dateto)); |
|
195 | - } |
|
188 | + if($dateto instanceof \DateTime) |
|
189 | + { |
|
190 | + $converter->setDateTo($dateto); |
|
191 | + } |
|
192 | + else if($dateto > 0) |
|
193 | + { |
|
194 | + $converter->setDateTo(self::timestamp2date($dateto)); |
|
195 | + } |
|
196 | 196 | |
197 | - return $converter->convert(); |
|
197 | + return $converter->convert(); |
|
198 | 198 | } |
199 | 199 | |
200 | 200 | /** |
@@ -267,16 +267,16 @@ discard block |
||
267 | 267 | return $bytes . ' ' . t('B'); |
268 | 268 | } |
269 | 269 | |
270 | - /** |
|
271 | - * Cuts a text to the specified length if it is longer than the |
|
272 | - * target length. Appends a text to signify it has been cut at |
|
273 | - * the end of the string. |
|
274 | - * |
|
275 | - * @param string $text |
|
276 | - * @param int $targetLength |
|
277 | - * @param string $append |
|
278 | - * @return string |
|
279 | - */ |
|
270 | + /** |
|
271 | + * Cuts a text to the specified length if it is longer than the |
|
272 | + * target length. Appends a text to signify it has been cut at |
|
273 | + * the end of the string. |
|
274 | + * |
|
275 | + * @param string $text |
|
276 | + * @param int $targetLength |
|
277 | + * @param string $append |
|
278 | + * @return string |
|
279 | + */ |
|
280 | 280 | public static function text_cut(string $text, int $targetLength, string $append = '...') : string |
281 | 281 | { |
282 | 282 | $length = mb_strlen($text); |
@@ -346,27 +346,27 @@ discard block |
||
346 | 346 | return self::$booleanStrings[$string]; |
347 | 347 | } |
348 | 348 | |
349 | - /** |
|
350 | - * Whether the specified string is a boolean string or boolean value. |
|
351 | - * Alias for {@link ConvertHelper::isBoolean()}. |
|
352 | - * |
|
353 | - * @param mixed $string |
|
354 | - * @return bool |
|
355 | - * @deprecated |
|
356 | - * @see ConvertHelper::isBoolean() |
|
357 | - */ |
|
349 | + /** |
|
350 | + * Whether the specified string is a boolean string or boolean value. |
|
351 | + * Alias for {@link ConvertHelper::isBoolean()}. |
|
352 | + * |
|
353 | + * @param mixed $string |
|
354 | + * @return bool |
|
355 | + * @deprecated |
|
356 | + * @see ConvertHelper::isBoolean() |
|
357 | + */ |
|
358 | 358 | public static function isBooleanString($string) : bool |
359 | 359 | { |
360 | 360 | return self::isBoolean($string); |
361 | 361 | } |
362 | 362 | |
363 | - /** |
|
364 | - * Alias for the {@\AppUtils\XMLHelper::string2xml()} method. |
|
365 | - * |
|
366 | - * @param string $text |
|
367 | - * @return string |
|
368 | - * @deprecated |
|
369 | - */ |
|
363 | + /** |
|
364 | + * Alias for the {@\AppUtils\XMLHelper::string2xml()} method. |
|
365 | + * |
|
366 | + * @param string $text |
|
367 | + * @return string |
|
368 | + * @deprecated |
|
369 | + */ |
|
370 | 370 | public static function text_makeXMLCompliant($text) |
371 | 371 | { |
372 | 372 | return XMLHelper::string2xml($text); |
@@ -468,13 +468,13 @@ discard block |
||
468 | 468 | return $translit->convert($string); |
469 | 469 | } |
470 | 470 | |
471 | - /** |
|
472 | - * Retrieves the HEX character codes for all control |
|
473 | - * characters that the {@link stripControlCharacters()} |
|
474 | - * method will remove. |
|
475 | - * |
|
476 | - * @return string[] |
|
477 | - */ |
|
471 | + /** |
|
472 | + * Retrieves the HEX character codes for all control |
|
473 | + * characters that the {@link stripControlCharacters()} |
|
474 | + * method will remove. |
|
475 | + * |
|
476 | + * @return string[] |
|
477 | + */ |
|
478 | 478 | public static function getControlCharactersAsHex() |
479 | 479 | { |
480 | 480 | $hexAlphabet = array('0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'); |
@@ -510,13 +510,13 @@ discard block |
||
510 | 510 | return $stack; |
511 | 511 | } |
512 | 512 | |
513 | - /** |
|
514 | - * Retrieves an array of all control characters that |
|
515 | - * the {@link stripControlCharacters()} method will |
|
516 | - * remove, as the actual UTF-8 characters. |
|
517 | - * |
|
518 | - * @return string[] |
|
519 | - */ |
|
513 | + /** |
|
514 | + * Retrieves an array of all control characters that |
|
515 | + * the {@link stripControlCharacters()} method will |
|
516 | + * remove, as the actual UTF-8 characters. |
|
517 | + * |
|
518 | + * @return string[] |
|
519 | + */ |
|
520 | 520 | public static function getControlCharactersAsUTF8() |
521 | 521 | { |
522 | 522 | $chars = self::getControlCharactersAsHex(); |
@@ -529,12 +529,12 @@ discard block |
||
529 | 529 | return $result; |
530 | 530 | } |
531 | 531 | |
532 | - /** |
|
533 | - * Retrieves all control characters as JSON encoded |
|
534 | - * characters, e.g. "\u200b". |
|
535 | - * |
|
536 | - * @return string[] |
|
537 | - */ |
|
532 | + /** |
|
533 | + * Retrieves all control characters as JSON encoded |
|
534 | + * characters, e.g. "\u200b". |
|
535 | + * |
|
536 | + * @return string[] |
|
537 | + */ |
|
538 | 538 | public static function getControlCharactersAsJSON() |
539 | 539 | { |
540 | 540 | $chars = self::getControlCharactersAsHex(); |
@@ -591,20 +591,20 @@ discard block |
||
591 | 591 | return preg_replace(self::$controlCharsRegex, '', $string); |
592 | 592 | } |
593 | 593 | |
594 | - /** |
|
595 | - * Converts a unicode character to the PHPO notation. |
|
596 | - * |
|
597 | - * Example: |
|
598 | - * |
|
599 | - * <pre>unicodeChar2php('"\u0000"')</pre> |
|
600 | - * |
|
601 | - * Returns |
|
602 | - * |
|
603 | - * <pre>\x0</pre> |
|
604 | - * |
|
605 | - * @param string $unicodeChar |
|
606 | - * @return string |
|
607 | - */ |
|
594 | + /** |
|
595 | + * Converts a unicode character to the PHPO notation. |
|
596 | + * |
|
597 | + * Example: |
|
598 | + * |
|
599 | + * <pre>unicodeChar2php('"\u0000"')</pre> |
|
600 | + * |
|
601 | + * Returns |
|
602 | + * |
|
603 | + * <pre>\x0</pre> |
|
604 | + * |
|
605 | + * @param string $unicodeChar |
|
606 | + * @return string |
|
607 | + */ |
|
608 | 608 | public static function unicodeChar2php($unicodeChar) |
609 | 609 | { |
610 | 610 | $unicodeChar = json_decode($unicodeChar); |
@@ -727,25 +727,25 @@ discard block |
||
727 | 727 | return 'false'; |
728 | 728 | } |
729 | 729 | |
730 | - /** |
|
731 | - * Converts an associative array with attribute name > value pairs |
|
732 | - * to an attribute string that can be used in an HTML tag. Empty |
|
733 | - * attribute values are ignored. |
|
734 | - * |
|
735 | - * Example: |
|
736 | - * |
|
737 | - * array2attributeString(array( |
|
738 | - * 'id' => 45, |
|
739 | - * 'href' => 'http://www.mistralys.com' |
|
740 | - * )); |
|
741 | - * |
|
742 | - * Result: |
|
743 | - * |
|
744 | - * id="45" href="http://www.mistralys.com" |
|
745 | - * |
|
746 | - * @param array $array |
|
747 | - * @return string |
|
748 | - */ |
|
730 | + /** |
|
731 | + * Converts an associative array with attribute name > value pairs |
|
732 | + * to an attribute string that can be used in an HTML tag. Empty |
|
733 | + * attribute values are ignored. |
|
734 | + * |
|
735 | + * Example: |
|
736 | + * |
|
737 | + * array2attributeString(array( |
|
738 | + * 'id' => 45, |
|
739 | + * 'href' => 'http://www.mistralys.com' |
|
740 | + * )); |
|
741 | + * |
|
742 | + * Result: |
|
743 | + * |
|
744 | + * id="45" href="http://www.mistralys.com" |
|
745 | + * |
|
746 | + * @param array $array |
|
747 | + * @return string |
|
748 | + */ |
|
749 | 749 | public static function array2attributeString($array) |
750 | 750 | { |
751 | 751 | $tokens = array(); |
@@ -764,14 +764,14 @@ discard block |
||
764 | 764 | return ' '.implode(' ', $tokens); |
765 | 765 | } |
766 | 766 | |
767 | - /** |
|
768 | - * Converts a string so it can safely be used in a javascript |
|
769 | - * statement in an HTML tag: uses single quotes around the string |
|
770 | - * and encodes all special characters as needed. |
|
771 | - * |
|
772 | - * @param string $string |
|
773 | - * @return string |
|
774 | - */ |
|
767 | + /** |
|
768 | + * Converts a string so it can safely be used in a javascript |
|
769 | + * statement in an HTML tag: uses single quotes around the string |
|
770 | + * and encodes all special characters as needed. |
|
771 | + * |
|
772 | + * @param string $string |
|
773 | + * @return string |
|
774 | + */ |
|
775 | 775 | public static function string2attributeJS($string, $quoted=true) |
776 | 776 | { |
777 | 777 | $converted = addslashes(htmlspecialchars(strip_tags($string), ENT_QUOTES, 'UTF-8')); |
@@ -782,15 +782,15 @@ discard block |
||
782 | 782 | return $converted; |
783 | 783 | } |
784 | 784 | |
785 | - /** |
|
786 | - * Checks if the specified string is a boolean value, which |
|
787 | - * includes string representations of boolean values, like |
|
788 | - * <code>yes</code> or <code>no</code>, and <code>true</code> |
|
789 | - * or <code>false</code>. |
|
790 | - * |
|
791 | - * @param mixed $value |
|
792 | - * @return boolean |
|
793 | - */ |
|
785 | + /** |
|
786 | + * Checks if the specified string is a boolean value, which |
|
787 | + * includes string representations of boolean values, like |
|
788 | + * <code>yes</code> or <code>no</code>, and <code>true</code> |
|
789 | + * or <code>false</code>. |
|
790 | + * |
|
791 | + * @param mixed $value |
|
792 | + * @return boolean |
|
793 | + */ |
|
794 | 794 | public static function isBoolean($value) : bool |
795 | 795 | { |
796 | 796 | if(is_bool($value)) { |
@@ -804,12 +804,12 @@ discard block |
||
804 | 804 | return array_key_exists($value, self::$booleanStrings); |
805 | 805 | } |
806 | 806 | |
807 | - /** |
|
808 | - * Converts an associative array to an HTML style attribute value string. |
|
809 | - * |
|
810 | - * @param array $subject |
|
811 | - * @return string |
|
812 | - */ |
|
807 | + /** |
|
808 | + * Converts an associative array to an HTML style attribute value string. |
|
809 | + * |
|
810 | + * @param array $subject |
|
811 | + * @return string |
|
812 | + */ |
|
813 | 813 | public static function array2styleString(array $subject) : string |
814 | 814 | { |
815 | 815 | $tokens = array(); |
@@ -820,23 +820,23 @@ discard block |
||
820 | 820 | return implode(';', $tokens); |
821 | 821 | } |
822 | 822 | |
823 | - /** |
|
824 | - * Converts a DateTime object to a timestamp, which |
|
825 | - * is PHP 5.2 compatible. |
|
826 | - * |
|
827 | - * @param \DateTime $date |
|
828 | - * @return integer |
|
829 | - */ |
|
823 | + /** |
|
824 | + * Converts a DateTime object to a timestamp, which |
|
825 | + * is PHP 5.2 compatible. |
|
826 | + * |
|
827 | + * @param \DateTime $date |
|
828 | + * @return integer |
|
829 | + */ |
|
830 | 830 | public static function date2timestamp(\DateTime $date) : int |
831 | 831 | { |
832 | 832 | return (int)$date->format('U'); |
833 | 833 | } |
834 | 834 | |
835 | - /** |
|
836 | - * Converts a timestamp into a DateTime instance. |
|
837 | - * @param int $timestamp |
|
838 | - * @return \DateTime |
|
839 | - */ |
|
835 | + /** |
|
836 | + * Converts a timestamp into a DateTime instance. |
|
837 | + * @param int $timestamp |
|
838 | + * @return \DateTime |
|
839 | + */ |
|
840 | 840 | public static function timestamp2date(int $timestamp) : \DateTime |
841 | 841 | { |
842 | 842 | $date = new \DateTime(); |
@@ -844,50 +844,50 @@ discard block |
||
844 | 844 | return $date; |
845 | 845 | } |
846 | 846 | |
847 | - /** |
|
848 | - * Strips an absolute path to a file within the application |
|
849 | - * to make the path relative to the application root path. |
|
850 | - * |
|
851 | - * @param string $path |
|
852 | - * @return string |
|
853 | - * |
|
854 | - * @see FileHelper::relativizePath() |
|
855 | - * @see FileHelper::relativizePathByDepth() |
|
856 | - */ |
|
847 | + /** |
|
848 | + * Strips an absolute path to a file within the application |
|
849 | + * to make the path relative to the application root path. |
|
850 | + * |
|
851 | + * @param string $path |
|
852 | + * @return string |
|
853 | + * |
|
854 | + * @see FileHelper::relativizePath() |
|
855 | + * @see FileHelper::relativizePathByDepth() |
|
856 | + */ |
|
857 | 857 | public static function fileRelativize(string $path) : string |
858 | 858 | { |
859 | 859 | return FileHelper::relativizePathByDepth($path); |
860 | 860 | } |
861 | 861 | |
862 | 862 | /** |
863 | - * Converts a PHP regex to a javascript RegExp object statement. |
|
864 | - * |
|
865 | - * NOTE: This is an alias for the JSHelper's `convertRegex` method. |
|
866 | - * More details are available on its usage there. |
|
867 | - * |
|
868 | - * @param string $regex A PHP preg regex |
|
869 | - * @param string $statementType The type of statement to return: Defaults to a statement to create a RegExp object. |
|
870 | - * @return array|string Depending on the specified return type. |
|
871 | - * |
|
872 | - * @see JSHelper::buildRegexStatement() |
|
873 | - */ |
|
863 | + * Converts a PHP regex to a javascript RegExp object statement. |
|
864 | + * |
|
865 | + * NOTE: This is an alias for the JSHelper's `convertRegex` method. |
|
866 | + * More details are available on its usage there. |
|
867 | + * |
|
868 | + * @param string $regex A PHP preg regex |
|
869 | + * @param string $statementType The type of statement to return: Defaults to a statement to create a RegExp object. |
|
870 | + * @return array|string Depending on the specified return type. |
|
871 | + * |
|
872 | + * @see JSHelper::buildRegexStatement() |
|
873 | + */ |
|
874 | 874 | public static function regex2js(string $regex, string $statementType=JSHelper::JS_REGEX_OBJECT) |
875 | 875 | { |
876 | 876 | return JSHelper::buildRegexStatement($regex, $statementType); |
877 | 877 | } |
878 | 878 | |
879 | - /** |
|
880 | - * Converts the specified variable to JSON. Works just |
|
881 | - * like the native `json_encode` method, except that it |
|
882 | - * will trigger an exception on failure, which has the |
|
883 | - * json error details included in its developer details. |
|
884 | - * |
|
885 | - * @param mixed $variable |
|
886 | - * @param int|NULL $options JSON encode options. |
|
887 | - * @param int|NULL $depth |
|
888 | - * @throws ConvertHelper_Exception |
|
889 | - * @return string |
|
890 | - */ |
|
879 | + /** |
|
880 | + * Converts the specified variable to JSON. Works just |
|
881 | + * like the native `json_encode` method, except that it |
|
882 | + * will trigger an exception on failure, which has the |
|
883 | + * json error details included in its developer details. |
|
884 | + * |
|
885 | + * @param mixed $variable |
|
886 | + * @param int|NULL $options JSON encode options. |
|
887 | + * @param int|NULL $depth |
|
888 | + * @throws ConvertHelper_Exception |
|
889 | + * @return string |
|
890 | + */ |
|
891 | 891 | public static function var2json($variable, int $options=0, int $depth=512) : string |
892 | 892 | { |
893 | 893 | $result = json_encode($variable, $options, $depth); |
@@ -908,12 +908,12 @@ discard block |
||
908 | 908 | ); |
909 | 909 | } |
910 | 910 | |
911 | - /** |
|
912 | - * Strips all known UTF byte order marks from the specified string. |
|
913 | - * |
|
914 | - * @param string $string |
|
915 | - * @return string |
|
916 | - */ |
|
911 | + /** |
|
912 | + * Strips all known UTF byte order marks from the specified string. |
|
913 | + * |
|
914 | + * @param string $string |
|
915 | + * @return string |
|
916 | + */ |
|
917 | 917 | public static function stripUTFBom($string) |
918 | 918 | { |
919 | 919 | $boms = FileHelper::getUTFBOMs(); |
@@ -928,13 +928,13 @@ discard block |
||
928 | 928 | return $string; |
929 | 929 | } |
930 | 930 | |
931 | - /** |
|
932 | - * Converts a string to valid utf8, regardless |
|
933 | - * of the string's encoding(s). |
|
934 | - * |
|
935 | - * @param string $string |
|
936 | - * @return string |
|
937 | - */ |
|
931 | + /** |
|
932 | + * Converts a string to valid utf8, regardless |
|
933 | + * of the string's encoding(s). |
|
934 | + * |
|
935 | + * @param string $string |
|
936 | + * @return string |
|
937 | + */ |
|
938 | 938 | public static function string2utf8($string) |
939 | 939 | { |
940 | 940 | if(!self::isStringASCII($string)) { |
@@ -944,15 +944,15 @@ discard block |
||
944 | 944 | return $string; |
945 | 945 | } |
946 | 946 | |
947 | - /** |
|
948 | - * Checks whether the specified string is an ASCII |
|
949 | - * string, without any special or UTF8 characters. |
|
950 | - * Note: empty strings and NULL are considered ASCII. |
|
951 | - * Any variable types other than strings are not. |
|
952 | - * |
|
953 | - * @param mixed $string |
|
954 | - * @return boolean |
|
955 | - */ |
|
947 | + /** |
|
948 | + * Checks whether the specified string is an ASCII |
|
949 | + * string, without any special or UTF8 characters. |
|
950 | + * Note: empty strings and NULL are considered ASCII. |
|
951 | + * Any variable types other than strings are not. |
|
952 | + * |
|
953 | + * @param mixed $string |
|
954 | + * @return boolean |
|
955 | + */ |
|
956 | 956 | public static function isStringASCII($string) : bool |
957 | 957 | { |
958 | 958 | if($string === '' || $string === NULL) { |
@@ -977,22 +977,22 @@ discard block |
||
977 | 977 | return $url; |
978 | 978 | } |
979 | 979 | |
980 | - /** |
|
981 | - * Calculates a percentage match of the source string with the target string. |
|
982 | - * |
|
983 | - * Options are: |
|
984 | - * |
|
985 | - * - maxLevenshtein, default: 10 |
|
986 | - * Any levenshtein results above this value are ignored. |
|
987 | - * |
|
988 | - * - precision, default: 1 |
|
989 | - * The precision of the percentage float value |
|
990 | - * |
|
991 | - * @param string $source |
|
992 | - * @param string $target |
|
993 | - * @param array $options |
|
994 | - * @return float |
|
995 | - */ |
|
980 | + /** |
|
981 | + * Calculates a percentage match of the source string with the target string. |
|
982 | + * |
|
983 | + * Options are: |
|
984 | + * |
|
985 | + * - maxLevenshtein, default: 10 |
|
986 | + * Any levenshtein results above this value are ignored. |
|
987 | + * |
|
988 | + * - precision, default: 1 |
|
989 | + * The precision of the percentage float value |
|
990 | + * |
|
991 | + * @param string $source |
|
992 | + * @param string $target |
|
993 | + * @param array $options |
|
994 | + * @return float |
|
995 | + */ |
|
996 | 996 | public static function matchString($source, $target, $options=array()) |
997 | 997 | { |
998 | 998 | $defaults = array( |
@@ -1016,14 +1016,14 @@ discard block |
||
1016 | 1016 | return round(100 - $percent, $options['precision']); |
1017 | 1017 | } |
1018 | 1018 | |
1019 | - /** |
|
1020 | - * Converts a date interval to a human readable string with |
|
1021 | - * all necessary time components, e.g. "1 year, 2 months and 4 days". |
|
1022 | - * |
|
1023 | - * @param \DateInterval $interval |
|
1024 | - * @return string |
|
1025 | - * @see ConvertHelper_IntervalConverter |
|
1026 | - */ |
|
1019 | + /** |
|
1020 | + * Converts a date interval to a human readable string with |
|
1021 | + * all necessary time components, e.g. "1 year, 2 months and 4 days". |
|
1022 | + * |
|
1023 | + * @param \DateInterval $interval |
|
1024 | + * @return string |
|
1025 | + * @see ConvertHelper_IntervalConverter |
|
1026 | + */ |
|
1027 | 1027 | public static function interval2string(\DateInterval $interval) : string |
1028 | 1028 | { |
1029 | 1029 | $converter = new ConvertHelper_IntervalConverter(); |
@@ -1038,60 +1038,60 @@ discard block |
||
1038 | 1038 | |
1039 | 1039 | const INTERVAL_SECONDS = 'seconds'; |
1040 | 1040 | |
1041 | - /** |
|
1042 | - * Converts an interval to its total amount of days. |
|
1043 | - * @param \DateInterval $interval |
|
1044 | - * @return int |
|
1045 | - */ |
|
1041 | + /** |
|
1042 | + * Converts an interval to its total amount of days. |
|
1043 | + * @param \DateInterval $interval |
|
1044 | + * @return int |
|
1045 | + */ |
|
1046 | 1046 | public static function interval2days(\DateInterval $interval) : int |
1047 | 1047 | { |
1048 | 1048 | return self::interval2total($interval, self::INTERVAL_DAYS); |
1049 | 1049 | } |
1050 | 1050 | |
1051 | - /** |
|
1052 | - * Converts an interval to its total amount of hours. |
|
1053 | - * @param \DateInterval $interval |
|
1054 | - * @return int |
|
1055 | - */ |
|
1051 | + /** |
|
1052 | + * Converts an interval to its total amount of hours. |
|
1053 | + * @param \DateInterval $interval |
|
1054 | + * @return int |
|
1055 | + */ |
|
1056 | 1056 | public static function interval2hours(\DateInterval $interval) : int |
1057 | 1057 | { |
1058 | 1058 | return self::interval2total($interval, self::INTERVAL_HOURS); |
1059 | 1059 | } |
1060 | 1060 | |
1061 | - /** |
|
1062 | - * Converts an interval to its total amount of minutes. |
|
1063 | - * @param \DateInterval $interval |
|
1064 | - * @return int |
|
1065 | - */ |
|
1061 | + /** |
|
1062 | + * Converts an interval to its total amount of minutes. |
|
1063 | + * @param \DateInterval $interval |
|
1064 | + * @return int |
|
1065 | + */ |
|
1066 | 1066 | public static function interval2minutes(\DateInterval $interval) : int |
1067 | 1067 | { |
1068 | 1068 | return self::interval2total($interval, self::INTERVAL_MINUTES); |
1069 | 1069 | } |
1070 | 1070 | |
1071 | - /** |
|
1072 | - * Converts an interval to its total amount of seconds. |
|
1073 | - * @param \DateInterval $interval |
|
1074 | - * @return int |
|
1075 | - */ |
|
1071 | + /** |
|
1072 | + * Converts an interval to its total amount of seconds. |
|
1073 | + * @param \DateInterval $interval |
|
1074 | + * @return int |
|
1075 | + */ |
|
1076 | 1076 | public static function interval2seconds(\DateInterval $interval) : int |
1077 | 1077 | { |
1078 | 1078 | return self::interval2total($interval, self::INTERVAL_SECONDS); |
1079 | 1079 | } |
1080 | 1080 | |
1081 | - /** |
|
1082 | - * Calculates the total amount of days / hours / minutes or seconds |
|
1083 | - * of a date interval object (depending in the specified units), and |
|
1084 | - * returns the total amount. |
|
1085 | - * |
|
1086 | - * @param \DateInterval $interval |
|
1087 | - * @param string $unit What total value to calculate. |
|
1088 | - * @return integer |
|
1089 | - * |
|
1090 | - * @see ConvertHelper::INTERVAL_SECONDS |
|
1091 | - * @see ConvertHelper::INTERVAL_MINUTES |
|
1092 | - * @see ConvertHelper::INTERVAL_HOURS |
|
1093 | - * @see ConvertHelper::INTERVAL_DAYS |
|
1094 | - */ |
|
1081 | + /** |
|
1082 | + * Calculates the total amount of days / hours / minutes or seconds |
|
1083 | + * of a date interval object (depending in the specified units), and |
|
1084 | + * returns the total amount. |
|
1085 | + * |
|
1086 | + * @param \DateInterval $interval |
|
1087 | + * @param string $unit What total value to calculate. |
|
1088 | + * @return integer |
|
1089 | + * |
|
1090 | + * @see ConvertHelper::INTERVAL_SECONDS |
|
1091 | + * @see ConvertHelper::INTERVAL_MINUTES |
|
1092 | + * @see ConvertHelper::INTERVAL_HOURS |
|
1093 | + * @see ConvertHelper::INTERVAL_DAYS |
|
1094 | + */ |
|
1095 | 1095 | public static function interval2total(\DateInterval $interval, $unit=self::INTERVAL_SECONDS) : int |
1096 | 1096 | { |
1097 | 1097 | $total = (int)$interval->format('%a'); |
@@ -1131,13 +1131,13 @@ discard block |
||
1131 | 1131 | 'Sunday' |
1132 | 1132 | ); |
1133 | 1133 | |
1134 | - /** |
|
1135 | - * Converts a date to the corresponding day name. |
|
1136 | - * |
|
1137 | - * @param \DateTime $date |
|
1138 | - * @param bool $short |
|
1139 | - * @return string|NULL |
|
1140 | - */ |
|
1134 | + /** |
|
1135 | + * Converts a date to the corresponding day name. |
|
1136 | + * |
|
1137 | + * @param \DateTime $date |
|
1138 | + * @param bool $short |
|
1139 | + * @return string|NULL |
|
1140 | + */ |
|
1141 | 1141 | public static function date2dayName(\DateTime $date, bool $short=false) |
1142 | 1142 | { |
1143 | 1143 | $day = $date->format('l'); |
@@ -1152,21 +1152,21 @@ discard block |
||
1152 | 1152 | return null; |
1153 | 1153 | } |
1154 | 1154 | |
1155 | - /** |
|
1156 | - * Retrieves a list of english day names. |
|
1157 | - * @return string[] |
|
1158 | - */ |
|
1155 | + /** |
|
1156 | + * Retrieves a list of english day names. |
|
1157 | + * @return string[] |
|
1158 | + */ |
|
1159 | 1159 | public static function getDayNamesInvariant() |
1160 | 1160 | { |
1161 | 1161 | return self::$daysInvariant; |
1162 | 1162 | } |
1163 | 1163 | |
1164 | - /** |
|
1165 | - * Retrieves the day names list for the current locale. |
|
1166 | - * |
|
1167 | - * @param bool $short |
|
1168 | - * @return array |
|
1169 | - */ |
|
1164 | + /** |
|
1165 | + * Retrieves the day names list for the current locale. |
|
1166 | + * |
|
1167 | + * @param bool $short |
|
1168 | + * @return array |
|
1169 | + */ |
|
1170 | 1170 | public static function getDayNames(bool $short=false) : array |
1171 | 1171 | { |
1172 | 1172 | if($short) { |
@@ -1226,16 +1226,16 @@ discard block |
||
1226 | 1226 | return $last; |
1227 | 1227 | } |
1228 | 1228 | |
1229 | - /** |
|
1230 | - * Splits a string into an array of all characters it is composed of. |
|
1231 | - * Unicode character safe. |
|
1232 | - * |
|
1233 | - * NOTE: Spaces and newlines (both \r and \n) are also considered single |
|
1234 | - * characters. |
|
1235 | - * |
|
1236 | - * @param string $string |
|
1237 | - * @return array |
|
1238 | - */ |
|
1229 | + /** |
|
1230 | + * Splits a string into an array of all characters it is composed of. |
|
1231 | + * Unicode character safe. |
|
1232 | + * |
|
1233 | + * NOTE: Spaces and newlines (both \r and \n) are also considered single |
|
1234 | + * characters. |
|
1235 | + * |
|
1236 | + * @param string $string |
|
1237 | + * @return array |
|
1238 | + */ |
|
1239 | 1239 | public static function string2array(string $string) : array |
1240 | 1240 | { |
1241 | 1241 | $result = preg_split('//u', $string, null, PREG_SPLIT_NO_EMPTY); |
@@ -1246,12 +1246,12 @@ discard block |
||
1246 | 1246 | return array(); |
1247 | 1247 | } |
1248 | 1248 | |
1249 | - /** |
|
1250 | - * Checks whether the specified string contains HTML code. |
|
1251 | - * |
|
1252 | - * @param string $string |
|
1253 | - * @return boolean |
|
1254 | - */ |
|
1249 | + /** |
|
1250 | + * Checks whether the specified string contains HTML code. |
|
1251 | + * |
|
1252 | + * @param string $string |
|
1253 | + * @return boolean |
|
1254 | + */ |
|
1255 | 1255 | public static function isStringHTML(string $string) : bool |
1256 | 1256 | { |
1257 | 1257 | if(preg_match('%<[a-z/][\s\S]*>%siU', $string)) { |
@@ -1266,17 +1266,17 @@ discard block |
||
1266 | 1266 | return false; |
1267 | 1267 | } |
1268 | 1268 | |
1269 | - /** |
|
1270 | - * UTF8-safe wordwrap method: works like the regular wordwrap |
|
1271 | - * PHP function but compatible with UTF8. Otherwise the lengths |
|
1272 | - * are not calculated correctly. |
|
1273 | - * |
|
1274 | - * @param string $str |
|
1275 | - * @param int $width |
|
1276 | - * @param string $break |
|
1277 | - * @param bool $cut |
|
1278 | - * @return string |
|
1279 | - */ |
|
1269 | + /** |
|
1270 | + * UTF8-safe wordwrap method: works like the regular wordwrap |
|
1271 | + * PHP function but compatible with UTF8. Otherwise the lengths |
|
1272 | + * are not calculated correctly. |
|
1273 | + * |
|
1274 | + * @param string $str |
|
1275 | + * @param int $width |
|
1276 | + * @param string $break |
|
1277 | + * @param bool $cut |
|
1278 | + * @return string |
|
1279 | + */ |
|
1280 | 1280 | public static function wordwrap(string $str, int $width = 75, string $break = "\n", bool $cut = false) : string |
1281 | 1281 | { |
1282 | 1282 | $wrapper = new ConvertHelper_WordWrapper(); |
@@ -1288,27 +1288,27 @@ discard block |
||
1288 | 1288 | ->wrapText($str); |
1289 | 1289 | } |
1290 | 1290 | |
1291 | - /** |
|
1292 | - * Calculates the byte length of a string, taking into |
|
1293 | - * account any unicode characters. |
|
1294 | - * |
|
1295 | - * @param string $string |
|
1296 | - * @return int |
|
1297 | - * @see https://stackoverflow.com/a/9718273/2298192 |
|
1298 | - */ |
|
1291 | + /** |
|
1292 | + * Calculates the byte length of a string, taking into |
|
1293 | + * account any unicode characters. |
|
1294 | + * |
|
1295 | + * @param string $string |
|
1296 | + * @return int |
|
1297 | + * @see https://stackoverflow.com/a/9718273/2298192 |
|
1298 | + */ |
|
1299 | 1299 | public static function string2bytes($string) |
1300 | 1300 | { |
1301 | 1301 | return mb_strlen($string, '8bit'); |
1302 | 1302 | } |
1303 | 1303 | |
1304 | - /** |
|
1305 | - * Creates a short, 8-character long hash for the specified string. |
|
1306 | - * |
|
1307 | - * WARNING: Not cryptographically safe. |
|
1308 | - * |
|
1309 | - * @param string $string |
|
1310 | - * @return string |
|
1311 | - */ |
|
1304 | + /** |
|
1305 | + * Creates a short, 8-character long hash for the specified string. |
|
1306 | + * |
|
1307 | + * WARNING: Not cryptographically safe. |
|
1308 | + * |
|
1309 | + * @param string $string |
|
1310 | + * @return string |
|
1311 | + */ |
|
1312 | 1312 | public static function string2shortHash($string) |
1313 | 1313 | { |
1314 | 1314 | return hash('crc32', $string, false); |
@@ -1334,40 +1334,40 @@ discard block |
||
1334 | 1334 | return ConvertHelper_ThrowableInfo::fromThrowable($e); |
1335 | 1335 | } |
1336 | 1336 | |
1337 | - /** |
|
1338 | - * Parses the specified query string like the native |
|
1339 | - * function <code>parse_str</code>, without the key |
|
1340 | - * naming limitations. |
|
1341 | - * |
|
1342 | - * Using parse_str, dots or spaces in key names are |
|
1343 | - * replaced by underscores. This method keeps all names |
|
1344 | - * intact. |
|
1345 | - * |
|
1346 | - * It still uses the parse_str implementation as it |
|
1347 | - * is tested and tried, but fixes the parameter names |
|
1348 | - * after parsing, as needed. |
|
1349 | - * |
|
1350 | - * @param string $queryString |
|
1351 | - * @return array |
|
1352 | - * @see ConvertHelper_QueryParser |
|
1353 | - */ |
|
1337 | + /** |
|
1338 | + * Parses the specified query string like the native |
|
1339 | + * function <code>parse_str</code>, without the key |
|
1340 | + * naming limitations. |
|
1341 | + * |
|
1342 | + * Using parse_str, dots or spaces in key names are |
|
1343 | + * replaced by underscores. This method keeps all names |
|
1344 | + * intact. |
|
1345 | + * |
|
1346 | + * It still uses the parse_str implementation as it |
|
1347 | + * is tested and tried, but fixes the parameter names |
|
1348 | + * after parsing, as needed. |
|
1349 | + * |
|
1350 | + * @param string $queryString |
|
1351 | + * @return array |
|
1352 | + * @see ConvertHelper_QueryParser |
|
1353 | + */ |
|
1354 | 1354 | public static function parseQueryString(string $queryString) : array |
1355 | 1355 | { |
1356 | 1356 | $parser = new ConvertHelper_QueryParser(); |
1357 | 1357 | return $parser->parse($queryString); |
1358 | 1358 | } |
1359 | 1359 | |
1360 | - /** |
|
1361 | - * Searches for needle in the specified string, and returns a list |
|
1362 | - * of all occurrences, including the matched string. The matched |
|
1363 | - * string is useful when doing a case insensitive search, as it |
|
1364 | - * shows the exact matched case of needle. |
|
1365 | - * |
|
1366 | - * @param string $needle |
|
1367 | - * @param string $haystack |
|
1368 | - * @param bool $caseInsensitive |
|
1369 | - * @return ConvertHelper_StringMatch[] |
|
1370 | - */ |
|
1360 | + /** |
|
1361 | + * Searches for needle in the specified string, and returns a list |
|
1362 | + * of all occurrences, including the matched string. The matched |
|
1363 | + * string is useful when doing a case insensitive search, as it |
|
1364 | + * shows the exact matched case of needle. |
|
1365 | + * |
|
1366 | + * @param string $needle |
|
1367 | + * @param string $haystack |
|
1368 | + * @param bool $caseInsensitive |
|
1369 | + * @return ConvertHelper_StringMatch[] |
|
1370 | + */ |
|
1371 | 1371 | public static function findString(string $needle, string $haystack, bool $caseInsensitive=false) |
1372 | 1372 | { |
1373 | 1373 | if($needle === '') { |
@@ -1393,14 +1393,14 @@ discard block |
||
1393 | 1393 | return $positions; |
1394 | 1394 | } |
1395 | 1395 | |
1396 | - /** |
|
1397 | - * Like explode, but trims all entries, and removes |
|
1398 | - * empty entries from the resulting array. |
|
1399 | - * |
|
1400 | - * @param string $delimiter |
|
1401 | - * @param string $string |
|
1402 | - * @return string[] |
|
1403 | - */ |
|
1396 | + /** |
|
1397 | + * Like explode, but trims all entries, and removes |
|
1398 | + * empty entries from the resulting array. |
|
1399 | + * |
|
1400 | + * @param string $delimiter |
|
1401 | + * @param string $string |
|
1402 | + * @return string[] |
|
1403 | + */ |
|
1404 | 1404 | public static function explodeTrim(string $delimiter, string $string) : array |
1405 | 1405 | { |
1406 | 1406 | if(empty($string) || empty($delimiter)) { |
@@ -1422,12 +1422,12 @@ discard block |
||
1422 | 1422 | |
1423 | 1423 | protected static $eolChars; |
1424 | 1424 | |
1425 | - /** |
|
1426 | - * Detects the most used end-of-line character in the subject string. |
|
1427 | - * |
|
1428 | - * @param string $str The string to check. |
|
1429 | - * @return NULL|ConvertHelper_EOL The detected EOL instance, or NULL if none has been detected. |
|
1430 | - */ |
|
1425 | + /** |
|
1426 | + * Detects the most used end-of-line character in the subject string. |
|
1427 | + * |
|
1428 | + * @param string $str The string to check. |
|
1429 | + * @return NULL|ConvertHelper_EOL The detected EOL instance, or NULL if none has been detected. |
|
1430 | + */ |
|
1431 | 1431 | public static function detectEOLCharacter(string $subjectString) : ?ConvertHelper_EOL |
1432 | 1432 | { |
1433 | 1433 | if(empty($subjectString)) { |
@@ -1439,27 +1439,27 @@ discard block |
||
1439 | 1439 | $cr = chr((int)hexdec('0d')); |
1440 | 1440 | $lf = chr((int)hexdec('0a')); |
1441 | 1441 | |
1442 | - self::$eolChars = array( |
|
1443 | - array( |
|
1444 | - 'char' => $cr.$lf, |
|
1445 | - 'type' => ConvertHelper_EOL::TYPE_CRLF, |
|
1446 | - 'description' => t('Carriage return followed by a line feed'), |
|
1447 | - ), |
|
1448 | - array( |
|
1449 | - 'char' => $lf.$cr, |
|
1450 | - 'type' => ConvertHelper_EOL::TYPE_LFCR, |
|
1451 | - 'description' => t('Line feed followed by a carriage return'), |
|
1452 | - ), |
|
1453 | - array( |
|
1454 | - 'char' => $lf, |
|
1455 | - 'type' => ConvertHelper_EOL::TYPE_LF, |
|
1456 | - 'description' => t('Line feed'), |
|
1457 | - ), |
|
1458 | - array( |
|
1459 | - 'char' => $cr, |
|
1460 | - 'type' => ConvertHelper_EOL::TYPE_CR, |
|
1461 | - 'description' => t('Carriage Return'), |
|
1462 | - ), |
|
1442 | + self::$eolChars = array( |
|
1443 | + array( |
|
1444 | + 'char' => $cr.$lf, |
|
1445 | + 'type' => ConvertHelper_EOL::TYPE_CRLF, |
|
1446 | + 'description' => t('Carriage return followed by a line feed'), |
|
1447 | + ), |
|
1448 | + array( |
|
1449 | + 'char' => $lf.$cr, |
|
1450 | + 'type' => ConvertHelper_EOL::TYPE_LFCR, |
|
1451 | + 'description' => t('Line feed followed by a carriage return'), |
|
1452 | + ), |
|
1453 | + array( |
|
1454 | + 'char' => $lf, |
|
1455 | + 'type' => ConvertHelper_EOL::TYPE_LF, |
|
1456 | + 'description' => t('Line feed'), |
|
1457 | + ), |
|
1458 | + array( |
|
1459 | + 'char' => $cr, |
|
1460 | + 'type' => ConvertHelper_EOL::TYPE_CR, |
|
1461 | + 'description' => t('Carriage Return'), |
|
1462 | + ), |
|
1463 | 1463 | ); |
1464 | 1464 | } |
1465 | 1465 | |
@@ -1487,13 +1487,13 @@ discard block |
||
1487 | 1487 | ); |
1488 | 1488 | } |
1489 | 1489 | |
1490 | - /** |
|
1491 | - * Removes the specified keys from the target array, |
|
1492 | - * if they exist. |
|
1493 | - * |
|
1494 | - * @param array $array |
|
1495 | - * @param array $keys |
|
1496 | - */ |
|
1490 | + /** |
|
1491 | + * Removes the specified keys from the target array, |
|
1492 | + * if they exist. |
|
1493 | + * |
|
1494 | + * @param array $array |
|
1495 | + * @param array $keys |
|
1496 | + */ |
|
1497 | 1497 | public static function arrayRemoveKeys(array &$array, array $keys) : void |
1498 | 1498 | { |
1499 | 1499 | foreach($keys as $key) |
@@ -1504,13 +1504,13 @@ discard block |
||
1504 | 1504 | } |
1505 | 1505 | } |
1506 | 1506 | |
1507 | - /** |
|
1508 | - * Checks if the specified variable is an integer or a string containing an integer. |
|
1509 | - * Accepts both positive and negative integers. |
|
1510 | - * |
|
1511 | - * @param mixed $value |
|
1512 | - * @return bool |
|
1513 | - */ |
|
1507 | + /** |
|
1508 | + * Checks if the specified variable is an integer or a string containing an integer. |
|
1509 | + * Accepts both positive and negative integers. |
|
1510 | + * |
|
1511 | + * @param mixed $value |
|
1512 | + * @return bool |
|
1513 | + */ |
|
1514 | 1514 | public static function isInteger($value) : bool |
1515 | 1515 | { |
1516 | 1516 | if(is_int($value)) { |
@@ -1530,15 +1530,15 @@ discard block |
||
1530 | 1530 | return false; |
1531 | 1531 | } |
1532 | 1532 | |
1533 | - /** |
|
1534 | - * Converts an amount of seconds to a DateInterval object. |
|
1535 | - * |
|
1536 | - * @param int $seconds |
|
1537 | - * @return \DateInterval |
|
1538 | - * @throws ConvertHelper_Exception If the date interval cannot be created. |
|
1539 | - * |
|
1540 | - * @see ConvertHelper::ERROR_CANNOT_GET_DATE_DIFF |
|
1541 | - */ |
|
1533 | + /** |
|
1534 | + * Converts an amount of seconds to a DateInterval object. |
|
1535 | + * |
|
1536 | + * @param int $seconds |
|
1537 | + * @return \DateInterval |
|
1538 | + * @throws ConvertHelper_Exception If the date interval cannot be created. |
|
1539 | + * |
|
1540 | + * @see ConvertHelper::ERROR_CANNOT_GET_DATE_DIFF |
|
1541 | + */ |
|
1542 | 1542 | public static function seconds2interval(int $seconds) : \DateInterval |
1543 | 1543 | { |
1544 | 1544 | return ConvertHelper_DateInterval::fromSeconds($seconds)->getInterval(); |
@@ -57,7 +57,7 @@ discard block |
||
57 | 57 | $amount = substr_count($line, "\t") - $min; |
58 | 58 | $line = trim($line); |
59 | 59 | if ($amount >= 1) { |
60 | - $line = str_repeat("\t", $amount) . $line; |
|
60 | + $line = str_repeat("\t", $amount).$line; |
|
61 | 61 | } |
62 | 62 | |
63 | 63 | $converted[] = $line; |
@@ -129,10 +129,10 @@ discard block |
||
129 | 129 | |
130 | 130 | // specifically handle zero |
131 | 131 | if ($seconds <= 0) { |
132 | - return '0 ' . t('seconds'); |
|
132 | + return '0 '.t('seconds'); |
|
133 | 133 | } |
134 | 134 | |
135 | - if($seconds < 1) { |
|
135 | + if ($seconds < 1) { |
|
136 | 136 | return t('less than a second'); |
137 | 137 | } |
138 | 138 | |
@@ -140,7 +140,7 @@ discard block |
||
140 | 140 | foreach ($units as $def) { |
141 | 141 | $quot = intval($seconds / $def['value']); |
142 | 142 | if ($quot) { |
143 | - $item = $quot . ' '; |
|
143 | + $item = $quot.' '; |
|
144 | 144 | if (abs($quot) > 1) { |
145 | 145 | $item .= $def['plural']; |
146 | 146 | } else { |
@@ -157,7 +157,7 @@ discard block |
||
157 | 157 | return $last; |
158 | 158 | } |
159 | 159 | |
160 | - return implode(', ', $tokens) . ' ' . t('and') . ' ' . $last; |
|
160 | + return implode(', ', $tokens).' '.t('and').' '.$last; |
|
161 | 161 | } |
162 | 162 | |
163 | 163 | /** |
@@ -176,7 +176,7 @@ discard block |
||
176 | 176 | { |
177 | 177 | $converter = new ConvertHelper_DurationConverter(); |
178 | 178 | |
179 | - if($datefrom instanceof \DateTime) |
|
179 | + if ($datefrom instanceof \DateTime) |
|
180 | 180 | { |
181 | 181 | $converter->setDateFrom($datefrom); |
182 | 182 | } |
@@ -185,11 +185,11 @@ discard block |
||
185 | 185 | $converter->setDateFrom(self::timestamp2date($datefrom)); |
186 | 186 | } |
187 | 187 | |
188 | - if($dateto instanceof \DateTime) |
|
188 | + if ($dateto instanceof \DateTime) |
|
189 | 189 | { |
190 | 190 | $converter->setDateTo($dateto); |
191 | 191 | } |
192 | - else if($dateto > 0) |
|
192 | + else if ($dateto > 0) |
|
193 | 193 | { |
194 | 194 | $converter->setDateTo(self::timestamp2date($dateto)); |
195 | 195 | } |
@@ -209,9 +209,9 @@ discard block |
||
209 | 209 | return $geshi->parse_code(); |
210 | 210 | } |
211 | 211 | |
212 | - public static function highlight_xml($xml, $formatSource=false) |
|
212 | + public static function highlight_xml($xml, $formatSource = false) |
|
213 | 213 | { |
214 | - if($formatSource) |
|
214 | + if ($formatSource) |
|
215 | 215 | { |
216 | 216 | $dom = new \DOMDocument(); |
217 | 217 | $dom->loadXML($xml); |
@@ -249,22 +249,22 @@ discard block |
||
249 | 249 | $terabyte = $gigabyte * 1024; |
250 | 250 | |
251 | 251 | if (($bytes >= 0) && ($bytes < $kilobyte)) { |
252 | - return $bytes . ' ' . t('B'); |
|
252 | + return $bytes.' '.t('B'); |
|
253 | 253 | |
254 | 254 | } elseif (($bytes >= $kilobyte) && ($bytes < $megabyte)) { |
255 | - return round($bytes / $kilobyte, $precision) . ' ' . t('Kb'); |
|
255 | + return round($bytes / $kilobyte, $precision).' '.t('Kb'); |
|
256 | 256 | |
257 | 257 | } elseif (($bytes >= $megabyte) && ($bytes < $gigabyte)) { |
258 | - return round($bytes / $megabyte, $precision) . ' ' . t('Mb'); |
|
258 | + return round($bytes / $megabyte, $precision).' '.t('Mb'); |
|
259 | 259 | |
260 | 260 | } elseif (($bytes >= $gigabyte) && ($bytes < $terabyte)) { |
261 | - return round($bytes / $gigabyte, $precision) . ' ' . t('Gb'); |
|
261 | + return round($bytes / $gigabyte, $precision).' '.t('Gb'); |
|
262 | 262 | |
263 | 263 | } elseif ($bytes >= $terabyte) { |
264 | - return round($bytes / $gigabyte, $precision) . ' ' . t('Tb'); |
|
264 | + return round($bytes / $gigabyte, $precision).' '.t('Tb'); |
|
265 | 265 | } |
266 | 266 | |
267 | - return $bytes . ' ' . t('B'); |
|
267 | + return $bytes.' '.t('B'); |
|
268 | 268 | } |
269 | 269 | |
270 | 270 | /** |
@@ -284,34 +284,34 @@ discard block |
||
284 | 284 | return $text; |
285 | 285 | } |
286 | 286 | |
287 | - $text = trim(mb_substr($text, 0, $targetLength)) . $append; |
|
287 | + $text = trim(mb_substr($text, 0, $targetLength)).$append; |
|
288 | 288 | |
289 | 289 | return $text; |
290 | 290 | } |
291 | 291 | |
292 | - public static function var_dump($var, $html=true) |
|
292 | + public static function var_dump($var, $html = true) |
|
293 | 293 | { |
294 | 294 | $info = parseVariable($var); |
295 | 295 | |
296 | - if($html) { |
|
296 | + if ($html) { |
|
297 | 297 | return $info->toHTML(); |
298 | 298 | } |
299 | 299 | |
300 | 300 | return $info->toString(); |
301 | 301 | } |
302 | 302 | |
303 | - public static function print_r($var, $return=false, $html=true) |
|
303 | + public static function print_r($var, $return = false, $html = true) |
|
304 | 304 | { |
305 | 305 | $result = self::var_dump($var, $html); |
306 | 306 | |
307 | - if($html) { |
|
307 | + if ($html) { |
|
308 | 308 | $result = |
309 | 309 | '<pre style="background:#fff;color:#333;padding:16px;border:solid 1px #bbb;border-radius:4px">'. |
310 | 310 | $result. |
311 | 311 | '</pre>'; |
312 | 312 | } |
313 | 313 | |
314 | - if($return) { |
|
314 | + if ($return) { |
|
315 | 315 | return $result; |
316 | 316 | } |
317 | 317 | |
@@ -331,7 +331,7 @@ discard block |
||
331 | 331 | |
332 | 332 | public static function string2bool($string) |
333 | 333 | { |
334 | - if($string === '' || $string === null) { |
|
334 | + if ($string === '' || $string === null) { |
|
335 | 335 | return false; |
336 | 336 | } |
337 | 337 | |
@@ -386,10 +386,10 @@ discard block |
||
386 | 386 | public static function date2listLabel(\DateTime $date, $includeTime = false, $shortMonth = false) |
387 | 387 | { |
388 | 388 | $today = new \DateTime(); |
389 | - if($date->format('d.m.Y') == $today->format('d.m.Y')) { |
|
389 | + if ($date->format('d.m.Y') == $today->format('d.m.Y')) { |
|
390 | 390 | $label = t('Today'); |
391 | 391 | } else { |
392 | - $label = $date->format('d') . '. ' . self::month2string((int)$date->format('m'), $shortMonth) . ' '; |
|
392 | + $label = $date->format('d').'. '.self::month2string((int)$date->format('m'), $shortMonth).' '; |
|
393 | 393 | if ($date->format('Y') != date('Y')) { |
394 | 394 | $label .= $date->format('Y'); |
395 | 395 | } |
@@ -480,28 +480,28 @@ discard block |
||
480 | 480 | $hexAlphabet = array('0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'); |
481 | 481 | |
482 | 482 | $stack = array(); |
483 | - foreach(self::$controlChars as $char) |
|
483 | + foreach (self::$controlChars as $char) |
|
484 | 484 | { |
485 | 485 | $tokens = explode('-', $char); |
486 | 486 | $start = $tokens[0]; |
487 | 487 | $end = $tokens[1]; |
488 | 488 | $prefix = substr($start, 0, 3); |
489 | 489 | $range = array(); |
490 | - foreach($hexAlphabet as $number) { |
|
490 | + foreach ($hexAlphabet as $number) { |
|
491 | 491 | $range[] = $prefix.$number; |
492 | 492 | } |
493 | 493 | |
494 | 494 | $use = false; |
495 | - foreach($range as $number) { |
|
496 | - if($number == $start) { |
|
495 | + foreach ($range as $number) { |
|
496 | + if ($number == $start) { |
|
497 | 497 | $use = true; |
498 | 498 | } |
499 | 499 | |
500 | - if($use) { |
|
500 | + if ($use) { |
|
501 | 501 | $stack[] = $number; |
502 | 502 | } |
503 | 503 | |
504 | - if($number == $end) { |
|
504 | + if ($number == $end) { |
|
505 | 505 | break; |
506 | 506 | } |
507 | 507 | } |
@@ -522,7 +522,7 @@ discard block |
||
522 | 522 | $chars = self::getControlCharactersAsHex(); |
523 | 523 | |
524 | 524 | $result = array(); |
525 | - foreach($chars as $char) { |
|
525 | + foreach ($chars as $char) { |
|
526 | 526 | $result[] = hex2bin($char); |
527 | 527 | } |
528 | 528 | |
@@ -540,14 +540,14 @@ discard block |
||
540 | 540 | $chars = self::getControlCharactersAsHex(); |
541 | 541 | |
542 | 542 | $result = array(); |
543 | - foreach($chars as $char) { |
|
543 | + foreach ($chars as $char) { |
|
544 | 544 | $result[] = '\u'.strtolower($char); |
545 | 545 | } |
546 | 546 | |
547 | 547 | return $result; |
548 | 548 | } |
549 | 549 | |
550 | - protected static $controlChars = array( |
|
550 | + protected static $controlChars = array( |
|
551 | 551 | '0000-0008', // control chars |
552 | 552 | '000E-000F', // control chars |
553 | 553 | '0010-001F', // control chars |
@@ -569,19 +569,19 @@ discard block |
||
569 | 569 | */ |
570 | 570 | public static function stripControlCharacters(string $string) : string |
571 | 571 | { |
572 | - if(empty($string)) { |
|
572 | + if (empty($string)) { |
|
573 | 573 | return $string; |
574 | 574 | } |
575 | 575 | |
576 | 576 | // create the regex from the unicode characters list |
577 | - if(!isset(self::$controlCharsRegex)) |
|
577 | + if (!isset(self::$controlCharsRegex)) |
|
578 | 578 | { |
579 | 579 | $chars = self::getControlCharactersAsHex(); |
580 | 580 | |
581 | 581 | // we use the notation \x{0000} to specify the unicode character key |
582 | 582 | // in the regular expression. |
583 | 583 | $stack = array(); |
584 | - foreach($chars as $char) { |
|
584 | + foreach ($chars as $char) { |
|
585 | 585 | $stack[] = '\x{'.$char.'}'; |
586 | 586 | } |
587 | 587 | |
@@ -615,7 +615,7 @@ discard block |
||
615 | 615 | $ordInt = ord($octet); |
616 | 616 | // Convert from int (base 10) to hex (base 16), for PHP \x syntax |
617 | 617 | $ordHex = base_convert($ordInt, 10, 16); |
618 | - $output .= '\x' . $ordHex; |
|
618 | + $output .= '\x'.$ordHex; |
|
619 | 619 | } |
620 | 620 | return $output; |
621 | 621 | } |
@@ -647,19 +647,19 @@ discard block |
||
647 | 647 | |
648 | 648 | protected static function convertScalarForComparison($scalar) |
649 | 649 | { |
650 | - if($scalar === '' || is_null($scalar)) { |
|
650 | + if ($scalar === '' || is_null($scalar)) { |
|
651 | 651 | return null; |
652 | 652 | } |
653 | 653 | |
654 | - if(is_bool($scalar)) { |
|
654 | + if (is_bool($scalar)) { |
|
655 | 655 | return self::bool2string($scalar); |
656 | 656 | } |
657 | 657 | |
658 | - if(is_array($scalar)) { |
|
658 | + if (is_array($scalar)) { |
|
659 | 659 | $scalar = md5(serialize($scalar)); |
660 | 660 | } |
661 | 661 | |
662 | - if($scalar !== null && !is_scalar($scalar)) { |
|
662 | + if ($scalar !== null && !is_scalar($scalar)) { |
|
663 | 663 | throw new ConvertHelper_Exception( |
664 | 664 | 'Not a scalar value in comparison', |
665 | 665 | null, |
@@ -708,7 +708,7 @@ discard block |
||
708 | 708 | public static function bool2string($boolean, bool $yesno = false) : string |
709 | 709 | { |
710 | 710 | // allow 'yes', 'true', 'no', 'false' string notations as well |
711 | - if(!is_bool($boolean)) { |
|
711 | + if (!is_bool($boolean)) { |
|
712 | 712 | $boolean = self::string2bool($boolean); |
713 | 713 | } |
714 | 714 | |
@@ -749,15 +749,15 @@ discard block |
||
749 | 749 | public static function array2attributeString($array) |
750 | 750 | { |
751 | 751 | $tokens = array(); |
752 | - foreach($array as $attr => $value) { |
|
753 | - if($value == '' || $value == null) { |
|
752 | + foreach ($array as $attr => $value) { |
|
753 | + if ($value == '' || $value == null) { |
|
754 | 754 | continue; |
755 | 755 | } |
756 | 756 | |
757 | 757 | $tokens[] = $attr.'="'.$value.'"'; |
758 | 758 | } |
759 | 759 | |
760 | - if(empty($tokens)) { |
|
760 | + if (empty($tokens)) { |
|
761 | 761 | return ''; |
762 | 762 | } |
763 | 763 | |
@@ -772,10 +772,10 @@ discard block |
||
772 | 772 | * @param string $string |
773 | 773 | * @return string |
774 | 774 | */ |
775 | - public static function string2attributeJS($string, $quoted=true) |
|
775 | + public static function string2attributeJS($string, $quoted = true) |
|
776 | 776 | { |
777 | 777 | $converted = addslashes(htmlspecialchars(strip_tags($string), ENT_QUOTES, 'UTF-8')); |
778 | - if($quoted) { |
|
778 | + if ($quoted) { |
|
779 | 779 | $converted = "'".$converted."'"; |
780 | 780 | } |
781 | 781 | |
@@ -793,11 +793,11 @@ discard block |
||
793 | 793 | */ |
794 | 794 | public static function isBoolean($value) : bool |
795 | 795 | { |
796 | - if(is_bool($value)) { |
|
796 | + if (is_bool($value)) { |
|
797 | 797 | return true; |
798 | 798 | } |
799 | 799 | |
800 | - if(!is_scalar($value)) { |
|
800 | + if (!is_scalar($value)) { |
|
801 | 801 | return false; |
802 | 802 | } |
803 | 803 | |
@@ -813,7 +813,7 @@ discard block |
||
813 | 813 | public static function array2styleString(array $subject) : string |
814 | 814 | { |
815 | 815 | $tokens = array(); |
816 | - foreach($subject as $name => $value) { |
|
816 | + foreach ($subject as $name => $value) { |
|
817 | 817 | $tokens[] = $name.':'.$value; |
818 | 818 | } |
819 | 819 | |
@@ -871,7 +871,7 @@ discard block |
||
871 | 871 | * |
872 | 872 | * @see JSHelper::buildRegexStatement() |
873 | 873 | */ |
874 | - public static function regex2js(string $regex, string $statementType=JSHelper::JS_REGEX_OBJECT) |
|
874 | + public static function regex2js(string $regex, string $statementType = JSHelper::JS_REGEX_OBJECT) |
|
875 | 875 | { |
876 | 876 | return JSHelper::buildRegexStatement($regex, $statementType); |
877 | 877 | } |
@@ -888,11 +888,11 @@ discard block |
||
888 | 888 | * @throws ConvertHelper_Exception |
889 | 889 | * @return string |
890 | 890 | */ |
891 | - public static function var2json($variable, int $options=0, int $depth=512) : string |
|
891 | + public static function var2json($variable, int $options = 0, int $depth = 512) : string |
|
892 | 892 | { |
893 | 893 | $result = json_encode($variable, $options, $depth); |
894 | 894 | |
895 | - if($result !== false) { |
|
895 | + if ($result !== false) { |
|
896 | 896 | return $result; |
897 | 897 | } |
898 | 898 | |
@@ -917,10 +917,10 @@ discard block |
||
917 | 917 | public static function stripUTFBom($string) |
918 | 918 | { |
919 | 919 | $boms = FileHelper::getUTFBOMs(); |
920 | - foreach($boms as $bomChars) { |
|
920 | + foreach ($boms as $bomChars) { |
|
921 | 921 | $length = mb_strlen($bomChars); |
922 | 922 | $text = mb_substr($string, 0, $length); |
923 | - if($text==$bomChars) { |
|
923 | + if ($text == $bomChars) { |
|
924 | 924 | return mb_substr($string, $length); |
925 | 925 | } |
926 | 926 | } |
@@ -937,7 +937,7 @@ discard block |
||
937 | 937 | */ |
938 | 938 | public static function string2utf8($string) |
939 | 939 | { |
940 | - if(!self::isStringASCII($string)) { |
|
940 | + if (!self::isStringASCII($string)) { |
|
941 | 941 | return \ForceUTF8\Encoding::toUTF8($string); |
942 | 942 | } |
943 | 943 | |
@@ -955,11 +955,11 @@ discard block |
||
955 | 955 | */ |
956 | 956 | public static function isStringASCII($string) : bool |
957 | 957 | { |
958 | - if($string === '' || $string === NULL) { |
|
958 | + if ($string === '' || $string === NULL) { |
|
959 | 959 | return true; |
960 | 960 | } |
961 | 961 | |
962 | - if(!is_string($string)) { |
|
962 | + if (!is_string($string)) { |
|
963 | 963 | return false; |
964 | 964 | } |
965 | 965 | |
@@ -993,7 +993,7 @@ discard block |
||
993 | 993 | * @param array $options |
994 | 994 | * @return float |
995 | 995 | */ |
996 | - public static function matchString($source, $target, $options=array()) |
|
996 | + public static function matchString($source, $target, $options = array()) |
|
997 | 997 | { |
998 | 998 | $defaults = array( |
999 | 999 | 'maxLevenshtein' => 10, |
@@ -1003,12 +1003,12 @@ discard block |
||
1003 | 1003 | $options = array_merge($defaults, $options); |
1004 | 1004 | |
1005 | 1005 | // avoid doing this via levenshtein |
1006 | - if($source == $target) { |
|
1006 | + if ($source == $target) { |
|
1007 | 1007 | return 100; |
1008 | 1008 | } |
1009 | 1009 | |
1010 | 1010 | $diff = levenshtein($source, $target); |
1011 | - if($diff > $options['maxLevenshtein']) { |
|
1011 | + if ($diff > $options['maxLevenshtein']) { |
|
1012 | 1012 | return 0; |
1013 | 1013 | } |
1014 | 1014 | |
@@ -1092,24 +1092,24 @@ discard block |
||
1092 | 1092 | * @see ConvertHelper::INTERVAL_HOURS |
1093 | 1093 | * @see ConvertHelper::INTERVAL_DAYS |
1094 | 1094 | */ |
1095 | - public static function interval2total(\DateInterval $interval, $unit=self::INTERVAL_SECONDS) : int |
|
1095 | + public static function interval2total(\DateInterval $interval, $unit = self::INTERVAL_SECONDS) : int |
|
1096 | 1096 | { |
1097 | 1097 | $total = (int)$interval->format('%a'); |
1098 | 1098 | if ($unit == self::INTERVAL_DAYS) { |
1099 | 1099 | return $total; |
1100 | 1100 | } |
1101 | 1101 | |
1102 | - $total = ($total * 24) + ((int)$interval->h ); |
|
1102 | + $total = ($total * 24) + ((int)$interval->h); |
|
1103 | 1103 | if ($unit == self::INTERVAL_HOURS) { |
1104 | 1104 | return $total; |
1105 | 1105 | } |
1106 | 1106 | |
1107 | - $total = ($total * 60) + ((int)$interval->i ); |
|
1107 | + $total = ($total * 60) + ((int)$interval->i); |
|
1108 | 1108 | if ($unit == self::INTERVAL_MINUTES) { |
1109 | 1109 | return $total; |
1110 | 1110 | } |
1111 | 1111 | |
1112 | - $total = ($total * 60) + ((int)$interval->s ); |
|
1112 | + $total = ($total * 60) + ((int)$interval->s); |
|
1113 | 1113 | if ($unit == self::INTERVAL_SECONDS) { |
1114 | 1114 | return $total; |
1115 | 1115 | } |
@@ -1138,13 +1138,13 @@ discard block |
||
1138 | 1138 | * @param bool $short |
1139 | 1139 | * @return string|NULL |
1140 | 1140 | */ |
1141 | - public static function date2dayName(\DateTime $date, bool $short=false) |
|
1141 | + public static function date2dayName(\DateTime $date, bool $short = false) |
|
1142 | 1142 | { |
1143 | 1143 | $day = $date->format('l'); |
1144 | 1144 | $invariant = self::getDayNamesInvariant(); |
1145 | 1145 | |
1146 | 1146 | $idx = array_search($day, $invariant); |
1147 | - if($idx !== false) { |
|
1147 | + if ($idx !== false) { |
|
1148 | 1148 | $localized = self::getDayNames($short); |
1149 | 1149 | return $localized[$idx]; |
1150 | 1150 | } |
@@ -1167,10 +1167,10 @@ discard block |
||
1167 | 1167 | * @param bool $short |
1168 | 1168 | * @return array |
1169 | 1169 | */ |
1170 | - public static function getDayNames(bool $short=false) : array |
|
1170 | + public static function getDayNames(bool $short = false) : array |
|
1171 | 1171 | { |
1172 | - if($short) { |
|
1173 | - if(!isset(self::$daysShort)) { |
|
1172 | + if ($short) { |
|
1173 | + if (!isset(self::$daysShort)) { |
|
1174 | 1174 | self::$daysShort = array( |
1175 | 1175 | t('Mon'), |
1176 | 1176 | t('Tue'), |
@@ -1185,7 +1185,7 @@ discard block |
||
1185 | 1185 | return self::$daysShort; |
1186 | 1186 | } |
1187 | 1187 | |
1188 | - if(!isset(self::$days)) { |
|
1188 | + if (!isset(self::$days)) { |
|
1189 | 1189 | self::$days = array( |
1190 | 1190 | t('Monday'), |
1191 | 1191 | t('Tuesday'), |
@@ -1210,17 +1210,17 @@ discard block |
||
1210 | 1210 | */ |
1211 | 1211 | public static function implodeWithAnd(array $list, $sep = ', ', $conjunction = null) |
1212 | 1212 | { |
1213 | - if(empty($list)) { |
|
1213 | + if (empty($list)) { |
|
1214 | 1214 | return ''; |
1215 | 1215 | } |
1216 | 1216 | |
1217 | - if(empty($conjunction)) { |
|
1217 | + if (empty($conjunction)) { |
|
1218 | 1218 | $conjunction = t('and'); |
1219 | 1219 | } |
1220 | 1220 | |
1221 | 1221 | $last = array_pop($list); |
1222 | - if($list) { |
|
1223 | - return implode($sep, $list) . $conjunction . ' ' . $last; |
|
1222 | + if ($list) { |
|
1223 | + return implode($sep, $list).$conjunction.' '.$last; |
|
1224 | 1224 | } |
1225 | 1225 | |
1226 | 1226 | return $last; |
@@ -1239,7 +1239,7 @@ discard block |
||
1239 | 1239 | public static function string2array(string $string) : array |
1240 | 1240 | { |
1241 | 1241 | $result = preg_split('//u', $string, null, PREG_SPLIT_NO_EMPTY); |
1242 | - if($result !== false) { |
|
1242 | + if ($result !== false) { |
|
1243 | 1243 | return $result; |
1244 | 1244 | } |
1245 | 1245 | |
@@ -1254,12 +1254,12 @@ discard block |
||
1254 | 1254 | */ |
1255 | 1255 | public static function isStringHTML(string $string) : bool |
1256 | 1256 | { |
1257 | - if(preg_match('%<[a-z/][\s\S]*>%siU', $string)) { |
|
1257 | + if (preg_match('%<[a-z/][\s\S]*>%siU', $string)) { |
|
1258 | 1258 | return true; |
1259 | 1259 | } |
1260 | 1260 | |
1261 | 1261 | $decoded = html_entity_decode($string); |
1262 | - if($decoded !== $string) { |
|
1262 | + if ($decoded !== $string) { |
|
1263 | 1263 | return true; |
1264 | 1264 | } |
1265 | 1265 | |
@@ -1368,14 +1368,14 @@ discard block |
||
1368 | 1368 | * @param bool $caseInsensitive |
1369 | 1369 | * @return ConvertHelper_StringMatch[] |
1370 | 1370 | */ |
1371 | - public static function findString(string $needle, string $haystack, bool $caseInsensitive=false) |
|
1371 | + public static function findString(string $needle, string $haystack, bool $caseInsensitive = false) |
|
1372 | 1372 | { |
1373 | - if($needle === '') { |
|
1373 | + if ($needle === '') { |
|
1374 | 1374 | return array(); |
1375 | 1375 | } |
1376 | 1376 | |
1377 | 1377 | $function = 'mb_strpos'; |
1378 | - if($caseInsensitive) { |
|
1378 | + if ($caseInsensitive) { |
|
1379 | 1379 | $function = 'mb_stripos'; |
1380 | 1380 | } |
1381 | 1381 | |
@@ -1383,7 +1383,7 @@ discard block |
||
1383 | 1383 | $positions = array(); |
1384 | 1384 | $length = mb_strlen($needle); |
1385 | 1385 | |
1386 | - while( ($pos = $function($haystack, $needle, $pos)) !== false) |
|
1386 | + while (($pos = $function($haystack, $needle, $pos)) !== false) |
|
1387 | 1387 | { |
1388 | 1388 | $match = mb_substr($haystack, $pos, $length); |
1389 | 1389 | $positions[] = new ConvertHelper_StringMatch($pos, $match); |
@@ -1403,7 +1403,7 @@ discard block |
||
1403 | 1403 | */ |
1404 | 1404 | public static function explodeTrim(string $delimiter, string $string) : array |
1405 | 1405 | { |
1406 | - if(empty($string) || empty($delimiter)) { |
|
1406 | + if (empty($string) || empty($delimiter)) { |
|
1407 | 1407 | return array(); |
1408 | 1408 | } |
1409 | 1409 | |
@@ -1411,8 +1411,8 @@ discard block |
||
1411 | 1411 | $tokens = array_map('trim', $tokens); |
1412 | 1412 | |
1413 | 1413 | $keep = array(); |
1414 | - foreach($tokens as $token) { |
|
1415 | - if($token !== '') { |
|
1414 | + foreach ($tokens as $token) { |
|
1415 | + if ($token !== '') { |
|
1416 | 1416 | $keep[] = $token; |
1417 | 1417 | } |
1418 | 1418 | } |
@@ -1430,11 +1430,11 @@ discard block |
||
1430 | 1430 | */ |
1431 | 1431 | public static function detectEOLCharacter(string $subjectString) : ?ConvertHelper_EOL |
1432 | 1432 | { |
1433 | - if(empty($subjectString)) { |
|
1433 | + if (empty($subjectString)) { |
|
1434 | 1434 | return null; |
1435 | 1435 | } |
1436 | 1436 | |
1437 | - if(!isset(self::$eolChars)) |
|
1437 | + if (!isset(self::$eolChars)) |
|
1438 | 1438 | { |
1439 | 1439 | $cr = chr((int)hexdec('0d')); |
1440 | 1440 | $lf = chr((int)hexdec('0a')); |
@@ -1465,18 +1465,18 @@ discard block |
||
1465 | 1465 | |
1466 | 1466 | $max = 0; |
1467 | 1467 | $results = array(); |
1468 | - foreach(self::$eolChars as $def) |
|
1468 | + foreach (self::$eolChars as $def) |
|
1469 | 1469 | { |
1470 | 1470 | $amount = substr_count($subjectString, $def['char']); |
1471 | 1471 | |
1472 | - if($amount > $max) |
|
1472 | + if ($amount > $max) |
|
1473 | 1473 | { |
1474 | 1474 | $max = $amount; |
1475 | 1475 | $results[] = $def; |
1476 | 1476 | } |
1477 | 1477 | } |
1478 | 1478 | |
1479 | - if(empty($results)) { |
|
1479 | + if (empty($results)) { |
|
1480 | 1480 | return null; |
1481 | 1481 | } |
1482 | 1482 | |
@@ -1496,9 +1496,9 @@ discard block |
||
1496 | 1496 | */ |
1497 | 1497 | public static function arrayRemoveKeys(array &$array, array $keys) : void |
1498 | 1498 | { |
1499 | - foreach($keys as $key) |
|
1499 | + foreach ($keys as $key) |
|
1500 | 1500 | { |
1501 | - if(array_key_exists($key, $array)) { |
|
1501 | + if (array_key_exists($key, $array)) { |
|
1502 | 1502 | unset($array[$key]); |
1503 | 1503 | } |
1504 | 1504 | } |
@@ -1513,17 +1513,17 @@ discard block |
||
1513 | 1513 | */ |
1514 | 1514 | public static function isInteger($value) : bool |
1515 | 1515 | { |
1516 | - if(is_int($value)) { |
|
1516 | + if (is_int($value)) { |
|
1517 | 1517 | return true; |
1518 | 1518 | } |
1519 | 1519 | |
1520 | 1520 | // booleans get converted to numbers, so they would |
1521 | 1521 | // actually match the regex. |
1522 | - if(is_bool($value)) { |
|
1522 | + if (is_bool($value)) { |
|
1523 | 1523 | return false; |
1524 | 1524 | } |
1525 | 1525 | |
1526 | - if(is_string($value) && $value !== '') { |
|
1526 | + if (is_string($value) && $value !== '') { |
|
1527 | 1527 | return preg_match('/\A-?\d+\z/', $value) === 1; |
1528 | 1528 | } |
1529 | 1529 |