@@ -23,19 +23,19 @@ discard block |
||
| 23 | 23 | */ |
| 24 | 24 | class ConvertHelper_TimeConverter |
| 25 | 25 | { |
| 26 | - /** |
|
| 27 | - * @var float |
|
| 28 | - */ |
|
| 26 | + /** |
|
| 27 | + * @var float |
|
| 28 | + */ |
|
| 29 | 29 | private $seconds; |
| 30 | 30 | |
| 31 | - /** |
|
| 32 | - * @var array<int,array<string,string|int>> |
|
| 33 | - */ |
|
| 31 | + /** |
|
| 32 | + * @var array<int,array<string,string|int>> |
|
| 33 | + */ |
|
| 34 | 34 | private static $units; |
| 35 | 35 | |
| 36 | - /** |
|
| 37 | - * @param float $seconds |
|
| 38 | - */ |
|
| 36 | + /** |
|
| 37 | + * @param float $seconds |
|
| 38 | + */ |
|
| 39 | 39 | public function __construct($seconds) |
| 40 | 40 | { |
| 41 | 41 | $this->seconds = $seconds; |
@@ -43,9 +43,9 @@ discard block |
||
| 43 | 43 | $this->initUnits(); |
| 44 | 44 | } |
| 45 | 45 | |
| 46 | - /** |
|
| 47 | - * Creates the list of units once per request as needed. |
|
| 48 | - */ |
|
| 46 | + /** |
|
| 47 | + * Creates the list of units once per request as needed. |
|
| 48 | + */ |
|
| 49 | 49 | private function initUnits() : void |
| 50 | 50 | { |
| 51 | 51 | if(isset(self::$units)) |
@@ -112,11 +112,11 @@ discard block |
||
| 112 | 112 | return implode(', ', $tokens) . ' ' . t('and') . ' ' . $last; |
| 113 | 113 | } |
| 114 | 114 | |
| 115 | - /** |
|
| 116 | - * Resolves the list of converted units. |
|
| 117 | - * |
|
| 118 | - * @return string[] |
|
| 119 | - */ |
|
| 115 | + /** |
|
| 116 | + * Resolves the list of converted units. |
|
| 117 | + * |
|
| 118 | + * @return string[] |
|
| 119 | + */ |
|
| 120 | 120 | private function resolveTokens() : array |
| 121 | 121 | { |
| 122 | 122 | $seconds = $this->seconds; |
@@ -48,7 +48,7 @@ discard block |
||
| 48 | 48 | */ |
| 49 | 49 | private function initUnits() : void |
| 50 | 50 | { |
| 51 | - if(isset(self::$units)) |
|
| 51 | + if (isset(self::$units)) |
|
| 52 | 52 | { |
| 53 | 53 | return; |
| 54 | 54 | } |
@@ -90,12 +90,12 @@ discard block |
||
| 90 | 90 | public function toString() : string |
| 91 | 91 | { |
| 92 | 92 | // specifically handle zero |
| 93 | - if($this->seconds <= 0) |
|
| 93 | + if ($this->seconds <= 0) |
|
| 94 | 94 | { |
| 95 | - return '0 ' . t('seconds'); |
|
| 95 | + return '0 '.t('seconds'); |
|
| 96 | 96 | } |
| 97 | 97 | |
| 98 | - if($this->seconds < 1) |
|
| 98 | + if ($this->seconds < 1) |
|
| 99 | 99 | { |
| 100 | 100 | return t('less than a second'); |
| 101 | 101 | } |
@@ -104,12 +104,12 @@ discard block |
||
| 104 | 104 | |
| 105 | 105 | $last = array_pop($tokens); |
| 106 | 106 | |
| 107 | - if(empty($tokens)) |
|
| 107 | + if (empty($tokens)) |
|
| 108 | 108 | { |
| 109 | 109 | return $last; |
| 110 | 110 | } |
| 111 | 111 | |
| 112 | - return implode(', ', $tokens) . ' ' . t('and') . ' ' . $last; |
|
| 112 | + return implode(', ', $tokens).' '.t('and').' '.$last; |
|
| 113 | 113 | } |
| 114 | 114 | |
| 115 | 115 | /** |
@@ -122,18 +122,18 @@ discard block |
||
| 122 | 122 | $seconds = $this->seconds; |
| 123 | 123 | $tokens = array(); |
| 124 | 124 | |
| 125 | - foreach(self::$units as $def) |
|
| 125 | + foreach (self::$units as $def) |
|
| 126 | 126 | { |
| 127 | 127 | $unitValue = intval($seconds / $def['value']); |
| 128 | 128 | |
| 129 | - if($unitValue <= 0) |
|
| 129 | + if ($unitValue <= 0) |
|
| 130 | 130 | { |
| 131 | 131 | continue; |
| 132 | 132 | } |
| 133 | 133 | |
| 134 | - $item = strval($unitValue) . ' '; |
|
| 134 | + $item = strval($unitValue).' '; |
|
| 135 | 135 | |
| 136 | - if(abs($unitValue) > 1) |
|
| 136 | + if (abs($unitValue) > 1) |
|
| 137 | 137 | { |
| 138 | 138 | $item .= $def['plural']; |
| 139 | 139 | } |
@@ -136,8 +136,7 @@ |
||
| 136 | 136 | if(abs($unitValue) > 1) |
| 137 | 137 | { |
| 138 | 138 | $item .= $def['plural']; |
| 139 | - } |
|
| 140 | - else |
|
| 139 | + } else |
|
| 141 | 140 | { |
| 142 | 141 | $item .= $def['singular']; |
| 143 | 142 | } |
@@ -191,8 +191,7 @@ discard block |
||
| 191 | 191 | if ($item->isDir()) |
| 192 | 192 | { |
| 193 | 193 | FileHelper::copyTree($itemPath, $target . '/' . $baseName); |
| 194 | - } |
|
| 195 | - else if($item->isFile()) |
|
| 194 | + } else if($item->isFile()) |
|
| 196 | 195 | { |
| 197 | 196 | self::copyFile($itemPath, $target . '/' . $baseName); |
| 198 | 197 | } |
@@ -225,8 +224,7 @@ discard block |
||
| 225 | 224 | if(!file_exists($targetFolder)) |
| 226 | 225 | { |
| 227 | 226 | self::createFolder($targetFolder); |
| 228 | - } |
|
| 229 | - else if(!is_writable($targetFolder)) |
|
| 227 | + } else if(!is_writable($targetFolder)) |
|
| 230 | 228 | { |
| 231 | 229 | throw new FileHelper_Exception( |
| 232 | 230 | sprintf('Target folder [%s] is not writable.', basename($targetFolder)), |
@@ -715,8 +713,7 @@ discard block |
||
| 715 | 713 | if(isset($options['relative-path']) && $options['relative-path'] === true) |
| 716 | 714 | { |
| 717 | 715 | $finder->setPathmodeRelative(); |
| 718 | - } |
|
| 719 | - else if(isset($options['absolute-path']) && $options['absolute-path'] === true) |
|
| 716 | + } else if(isset($options['absolute-path']) && $options['absolute-path'] === true) |
|
| 720 | 717 | { |
| 721 | 718 | $finder->setPathmodeAbsolute(); |
| 722 | 719 | } |
@@ -60,31 +60,31 @@ discard block |
||
| 60 | 60 | protected static $utfBoms; |
| 61 | 61 | |
| 62 | 62 | /** |
| 63 | - * Opens a serialized file and returns the unserialized data. |
|
| 64 | - * |
|
| 65 | - * @param string $file |
|
| 66 | - * @throws FileHelper_Exception |
|
| 67 | - * @return array<int|string,mixed> |
|
| 68 | - * @deprecated Use parseSerializedFile() instead. |
|
| 69 | - * @see FileHelper::parseSerializedFile() |
|
| 70 | - */ |
|
| 63 | + * Opens a serialized file and returns the unserialized data. |
|
| 64 | + * |
|
| 65 | + * @param string $file |
|
| 66 | + * @throws FileHelper_Exception |
|
| 67 | + * @return array<int|string,mixed> |
|
| 68 | + * @deprecated Use parseSerializedFile() instead. |
|
| 69 | + * @see FileHelper::parseSerializedFile() |
|
| 70 | + */ |
|
| 71 | 71 | public static function openUnserialized(string $file) : array |
| 72 | 72 | { |
| 73 | 73 | return self::parseSerializedFile($file); |
| 74 | 74 | } |
| 75 | 75 | |
| 76 | - /** |
|
| 77 | - * Opens a serialized file and returns the unserialized data. |
|
| 78 | - * |
|
| 79 | - * @param string $file |
|
| 80 | - * @throws FileHelper_Exception |
|
| 81 | - * @return array<int|string,mixed> |
|
| 82 | - * @see FileHelper::parseSerializedFile() |
|
| 83 | - * |
|
| 84 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
| 85 | - * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ |
|
| 86 | - * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED |
|
| 87 | - */ |
|
| 76 | + /** |
|
| 77 | + * Opens a serialized file and returns the unserialized data. |
|
| 78 | + * |
|
| 79 | + * @param string $file |
|
| 80 | + * @throws FileHelper_Exception |
|
| 81 | + * @return array<int|string,mixed> |
|
| 82 | + * @see FileHelper::parseSerializedFile() |
|
| 83 | + * |
|
| 84 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
| 85 | + * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ |
|
| 86 | + * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED |
|
| 87 | + */ |
|
| 88 | 88 | public static function parseSerializedFile(string $file) : array |
| 89 | 89 | { |
| 90 | 90 | self::requireFileExists($file); |
@@ -160,13 +160,13 @@ discard block |
||
| 160 | 160 | return rmdir($rootFolder); |
| 161 | 161 | } |
| 162 | 162 | |
| 163 | - /** |
|
| 164 | - * Create a folder, if it does not exist yet. |
|
| 165 | - * |
|
| 166 | - * @param string $path |
|
| 167 | - * @throws FileHelper_Exception |
|
| 168 | - * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER |
|
| 169 | - */ |
|
| 163 | + /** |
|
| 164 | + * Create a folder, if it does not exist yet. |
|
| 165 | + * |
|
| 166 | + * @param string $path |
|
| 167 | + * @throws FileHelper_Exception |
|
| 168 | + * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER |
|
| 169 | + */ |
|
| 170 | 170 | public static function createFolder(string $path) : void |
| 171 | 171 | { |
| 172 | 172 | if(is_dir($path) || mkdir($path, 0777, true)) { |
@@ -213,22 +213,22 @@ discard block |
||
| 213 | 213 | } |
| 214 | 214 | } |
| 215 | 215 | |
| 216 | - /** |
|
| 217 | - * Copies a file to the target location. Includes checks |
|
| 218 | - * for most error sources, like the source file not being |
|
| 219 | - * readable. Automatically creates the target folder if it |
|
| 220 | - * does not exist yet. |
|
| 221 | - * |
|
| 222 | - * @param string $sourcePath |
|
| 223 | - * @param string $targetPath |
|
| 224 | - * @throws FileHelper_Exception |
|
| 225 | - * |
|
| 226 | - * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER |
|
| 227 | - * @see FileHelper::ERROR_SOURCE_FILE_NOT_FOUND |
|
| 228 | - * @see FileHelper::ERROR_SOURCE_FILE_NOT_READABLE |
|
| 229 | - * @see FileHelper::ERROR_TARGET_COPY_FOLDER_NOT_WRITABLE |
|
| 230 | - * @see FileHelper::ERROR_CANNOT_COPY_FILE |
|
| 231 | - */ |
|
| 216 | + /** |
|
| 217 | + * Copies a file to the target location. Includes checks |
|
| 218 | + * for most error sources, like the source file not being |
|
| 219 | + * readable. Automatically creates the target folder if it |
|
| 220 | + * does not exist yet. |
|
| 221 | + * |
|
| 222 | + * @param string $sourcePath |
|
| 223 | + * @param string $targetPath |
|
| 224 | + * @throws FileHelper_Exception |
|
| 225 | + * |
|
| 226 | + * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER |
|
| 227 | + * @see FileHelper::ERROR_SOURCE_FILE_NOT_FOUND |
|
| 228 | + * @see FileHelper::ERROR_SOURCE_FILE_NOT_READABLE |
|
| 229 | + * @see FileHelper::ERROR_TARGET_COPY_FOLDER_NOT_WRITABLE |
|
| 230 | + * @see FileHelper::ERROR_CANNOT_COPY_FILE |
|
| 231 | + */ |
|
| 232 | 232 | public static function copyFile(string $sourcePath, string $targetPath) : void |
| 233 | 233 | { |
| 234 | 234 | self::requireFileExists($sourcePath, self::ERROR_SOURCE_FILE_NOT_FOUND); |
@@ -268,15 +268,15 @@ discard block |
||
| 268 | 268 | ); |
| 269 | 269 | } |
| 270 | 270 | |
| 271 | - /** |
|
| 272 | - * Deletes the target file. Ignored if it cannot be found, |
|
| 273 | - * and throws an exception if it fails. |
|
| 274 | - * |
|
| 275 | - * @param string $filePath |
|
| 276 | - * @throws FileHelper_Exception |
|
| 277 | - * |
|
| 278 | - * @see FileHelper::ERROR_CANNOT_DELETE_FILE |
|
| 279 | - */ |
|
| 271 | + /** |
|
| 272 | + * Deletes the target file. Ignored if it cannot be found, |
|
| 273 | + * and throws an exception if it fails. |
|
| 274 | + * |
|
| 275 | + * @param string $filePath |
|
| 276 | + * @throws FileHelper_Exception |
|
| 277 | + * |
|
| 278 | + * @see FileHelper::ERROR_CANNOT_DELETE_FILE |
|
| 279 | + */ |
|
| 280 | 280 | public static function deleteFile(string $filePath) : void |
| 281 | 281 | { |
| 282 | 282 | if(!file_exists($filePath)) { |
@@ -298,15 +298,15 @@ discard block |
||
| 298 | 298 | } |
| 299 | 299 | |
| 300 | 300 | /** |
| 301 | - * Creates a new CSV parser instance and returns it. |
|
| 302 | - * |
|
| 303 | - * @param string $delimiter |
|
| 304 | - * @param string $enclosure |
|
| 305 | - * @param string $escape |
|
| 306 | - * @param bool $heading |
|
| 307 | - * @return Csv |
|
| 301 | + * Creates a new CSV parser instance and returns it. |
|
| 302 | + * |
|
| 303 | + * @param string $delimiter |
|
| 304 | + * @param string $enclosure |
|
| 305 | + * @param string $escape |
|
| 306 | + * @param bool $heading |
|
| 307 | + * @return Csv |
|
| 308 | 308 | * @see CSVHelper::createParser() |
| 309 | - */ |
|
| 309 | + */ |
|
| 310 | 310 | public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : Csv |
| 311 | 311 | { |
| 312 | 312 | if($delimiter==='') { $delimiter = ';'; } |
@@ -319,21 +319,21 @@ discard block |
||
| 319 | 319 | return $parser; |
| 320 | 320 | } |
| 321 | 321 | |
| 322 | - /** |
|
| 323 | - * Parses all lines in the specified string and returns an |
|
| 324 | - * indexed array with all csv values in each line. |
|
| 325 | - * |
|
| 326 | - * @param string $csv |
|
| 327 | - * @param string $delimiter |
|
| 328 | - * @param string $enclosure |
|
| 329 | - * @param string $escape |
|
| 330 | - * @param bool $heading |
|
| 331 | - * @return array<int,array<string,string>> |
|
| 332 | - * @throws FileHelper_Exception |
|
| 333 | - * |
|
| 334 | - * @see parseCSVFile() |
|
| 335 | - * @see FileHelper::ERROR_PARSING_CSV |
|
| 336 | - */ |
|
| 322 | + /** |
|
| 323 | + * Parses all lines in the specified string and returns an |
|
| 324 | + * indexed array with all csv values in each line. |
|
| 325 | + * |
|
| 326 | + * @param string $csv |
|
| 327 | + * @param string $delimiter |
|
| 328 | + * @param string $enclosure |
|
| 329 | + * @param string $escape |
|
| 330 | + * @param bool $heading |
|
| 331 | + * @return array<int,array<string,string>> |
|
| 332 | + * @throws FileHelper_Exception |
|
| 333 | + * |
|
| 334 | + * @see parseCSVFile() |
|
| 335 | + * @see FileHelper::ERROR_PARSING_CSV |
|
| 336 | + */ |
|
| 337 | 337 | public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array |
| 338 | 338 | { |
| 339 | 339 | $parser = self::createCSVParser($delimiter, $enclosure, '\\', $heading); |
@@ -521,27 +521,27 @@ discard block |
||
| 521 | 521 | ); |
| 522 | 522 | } |
| 523 | 523 | |
| 524 | - /** |
|
| 525 | - * Verifies whether the target file is a PHP file. The path |
|
| 526 | - * to the file can be a path to a file as a string, or a |
|
| 527 | - * DirectoryIterator object instance. |
|
| 528 | - * |
|
| 529 | - * @param string|DirectoryIterator $pathOrDirIterator |
|
| 530 | - * @return boolean |
|
| 531 | - */ |
|
| 524 | + /** |
|
| 525 | + * Verifies whether the target file is a PHP file. The path |
|
| 526 | + * to the file can be a path to a file as a string, or a |
|
| 527 | + * DirectoryIterator object instance. |
|
| 528 | + * |
|
| 529 | + * @param string|DirectoryIterator $pathOrDirIterator |
|
| 530 | + * @return boolean |
|
| 531 | + */ |
|
| 532 | 532 | public static function isPHPFile($pathOrDirIterator) : bool |
| 533 | 533 | { |
| 534 | - return self::getExtension($pathOrDirIterator) === 'php'; |
|
| 534 | + return self::getExtension($pathOrDirIterator) === 'php'; |
|
| 535 | 535 | } |
| 536 | 536 | |
| 537 | - /** |
|
| 538 | - * Retrieves the extension of the specified file. Can be a path |
|
| 539 | - * to a file as a string, or a DirectoryIterator object instance. |
|
| 540 | - * |
|
| 541 | - * @param string|DirectoryIterator $pathOrDirIterator |
|
| 542 | - * @param bool $lowercase |
|
| 543 | - * @return string |
|
| 544 | - */ |
|
| 537 | + /** |
|
| 538 | + * Retrieves the extension of the specified file. Can be a path |
|
| 539 | + * to a file as a string, or a DirectoryIterator object instance. |
|
| 540 | + * |
|
| 541 | + * @param string|DirectoryIterator $pathOrDirIterator |
|
| 542 | + * @param bool $lowercase |
|
| 543 | + * @return string |
|
| 544 | + */ |
|
| 545 | 545 | public static function getExtension($pathOrDirIterator, bool $lowercase = true) : string |
| 546 | 546 | { |
| 547 | 547 | if($pathOrDirIterator instanceof DirectoryIterator) { |
@@ -552,38 +552,38 @@ discard block |
||
| 552 | 552 | |
| 553 | 553 | $ext = pathinfo($filename, PATHINFO_EXTENSION); |
| 554 | 554 | if($lowercase) { |
| 555 | - $ext = mb_strtolower($ext); |
|
| 555 | + $ext = mb_strtolower($ext); |
|
| 556 | 556 | } |
| 557 | 557 | |
| 558 | 558 | return $ext; |
| 559 | 559 | } |
| 560 | 560 | |
| 561 | - /** |
|
| 562 | - * Retrieves the file name from a path, with or without extension. |
|
| 563 | - * The path to the file can be a string, or a DirectoryIterator object |
|
| 564 | - * instance. |
|
| 565 | - * |
|
| 566 | - * In case of folders, behaves like the pathinfo function: returns |
|
| 567 | - * the name of the folder. |
|
| 568 | - * |
|
| 569 | - * @param string|DirectoryIterator $pathOrDirIterator |
|
| 570 | - * @param bool $extension |
|
| 571 | - * @return string |
|
| 572 | - */ |
|
| 561 | + /** |
|
| 562 | + * Retrieves the file name from a path, with or without extension. |
|
| 563 | + * The path to the file can be a string, or a DirectoryIterator object |
|
| 564 | + * instance. |
|
| 565 | + * |
|
| 566 | + * In case of folders, behaves like the pathinfo function: returns |
|
| 567 | + * the name of the folder. |
|
| 568 | + * |
|
| 569 | + * @param string|DirectoryIterator $pathOrDirIterator |
|
| 570 | + * @param bool $extension |
|
| 571 | + * @return string |
|
| 572 | + */ |
|
| 573 | 573 | public static function getFilename($pathOrDirIterator, $extension = true) : string |
| 574 | 574 | { |
| 575 | 575 | $path = strval($pathOrDirIterator); |
| 576 | - if($pathOrDirIterator instanceof DirectoryIterator) { |
|
| 577 | - $path = $pathOrDirIterator->getFilename(); |
|
| 578 | - } |
|
| 576 | + if($pathOrDirIterator instanceof DirectoryIterator) { |
|
| 577 | + $path = $pathOrDirIterator->getFilename(); |
|
| 578 | + } |
|
| 579 | 579 | |
| 580 | - $path = self::normalizePath($path); |
|
| 580 | + $path = self::normalizePath($path); |
|
| 581 | 581 | |
| 582 | - if(!$extension) { |
|
| 583 | - return pathinfo($path, PATHINFO_FILENAME); |
|
| 584 | - } |
|
| 582 | + if(!$extension) { |
|
| 583 | + return pathinfo($path, PATHINFO_FILENAME); |
|
| 584 | + } |
|
| 585 | 585 | |
| 586 | - return pathinfo($path, PATHINFO_BASENAME); |
|
| 586 | + return pathinfo($path, PATHINFO_BASENAME); |
|
| 587 | 587 | } |
| 588 | 588 | |
| 589 | 589 | /** |
@@ -624,16 +624,16 @@ discard block |
||
| 624 | 624 | return $json; |
| 625 | 625 | } |
| 626 | 626 | |
| 627 | - /** |
|
| 628 | - * Corrects common formatting mistakes when users enter |
|
| 629 | - * file names, like too many spaces, dots and the like. |
|
| 630 | - * |
|
| 631 | - * NOTE: if the file name contains a path, the path is |
|
| 632 | - * stripped, leaving only the file name. |
|
| 633 | - * |
|
| 634 | - * @param string $name |
|
| 635 | - * @return string |
|
| 636 | - */ |
|
| 627 | + /** |
|
| 628 | + * Corrects common formatting mistakes when users enter |
|
| 629 | + * file names, like too many spaces, dots and the like. |
|
| 630 | + * |
|
| 631 | + * NOTE: if the file name contains a path, the path is |
|
| 632 | + * stripped, leaving only the file name. |
|
| 633 | + * |
|
| 634 | + * @param string $name |
|
| 635 | + * @return string |
|
| 636 | + */ |
|
| 637 | 637 | public static function fixFileName(string $name) : string |
| 638 | 638 | { |
| 639 | 639 | $name = trim($name); |
@@ -715,20 +715,20 @@ discard block |
||
| 715 | 715 | return self::findFiles($targetFolder, array('php'), $options); |
| 716 | 716 | } |
| 717 | 717 | |
| 718 | - /** |
|
| 719 | - * Finds files according to the specified options. |
|
| 720 | - * |
|
| 721 | - * NOTE: This method only exists for backwards compatibility. |
|
| 722 | - * Use the `createFileFinder()` method instead, which offers |
|
| 723 | - * an object oriented interface that is much easier to use. |
|
| 724 | - * |
|
| 725 | - * @param string $targetFolder |
|
| 726 | - * @param string[] $extensions |
|
| 727 | - * @param array<string,mixed> $options |
|
| 728 | - * @throws FileHelper_Exception |
|
| 729 | - * @return string[] |
|
| 730 | - * @see FileHelper::createFileFinder() |
|
| 731 | - */ |
|
| 718 | + /** |
|
| 719 | + * Finds files according to the specified options. |
|
| 720 | + * |
|
| 721 | + * NOTE: This method only exists for backwards compatibility. |
|
| 722 | + * Use the `createFileFinder()` method instead, which offers |
|
| 723 | + * an object oriented interface that is much easier to use. |
|
| 724 | + * |
|
| 725 | + * @param string $targetFolder |
|
| 726 | + * @param string[] $extensions |
|
| 727 | + * @param array<string,mixed> $options |
|
| 728 | + * @throws FileHelper_Exception |
|
| 729 | + * @return string[] |
|
| 730 | + * @see FileHelper::createFileFinder() |
|
| 731 | + */ |
|
| 732 | 732 | public static function findFiles(string $targetFolder, array $extensions=array(), array $options=array()) : array |
| 733 | 733 | { |
| 734 | 734 | $finder = self::createFileFinder($targetFolder); |
@@ -758,14 +758,14 @@ discard block |
||
| 758 | 758 | return $finder->getAll(); |
| 759 | 759 | } |
| 760 | 760 | |
| 761 | - /** |
|
| 762 | - * Removes the extension from the specified path or file name, |
|
| 763 | - * if any, and returns the name without the extension. |
|
| 764 | - * |
|
| 765 | - * @param string $filename |
|
| 766 | - * @param bool $keepPath Whether to keep the path component, if any. Default PHP pathinfo behavior is not to. |
|
| 767 | - * @return string |
|
| 768 | - */ |
|
| 761 | + /** |
|
| 762 | + * Removes the extension from the specified path or file name, |
|
| 763 | + * if any, and returns the name without the extension. |
|
| 764 | + * |
|
| 765 | + * @param string $filename |
|
| 766 | + * @param bool $keepPath Whether to keep the path component, if any. Default PHP pathinfo behavior is not to. |
|
| 767 | + * @return string |
|
| 768 | + */ |
|
| 769 | 769 | public static function removeExtension(string $filename, bool $keepPath=false) : string |
| 770 | 770 | { |
| 771 | 771 | // normalize paths to allow windows style slashes even on nix servers |
@@ -833,13 +833,13 @@ discard block |
||
| 833 | 833 | return null; |
| 834 | 834 | } |
| 835 | 835 | |
| 836 | - /** |
|
| 837 | - * Retrieves a list of all UTF byte order mark character |
|
| 838 | - * sequences, as an associative array with UTF encoding => bom sequence |
|
| 839 | - * pairs. |
|
| 840 | - * |
|
| 841 | - * @return array<string,string> |
|
| 842 | - */ |
|
| 836 | + /** |
|
| 837 | + * Retrieves a list of all UTF byte order mark character |
|
| 838 | + * sequences, as an associative array with UTF encoding => bom sequence |
|
| 839 | + * pairs. |
|
| 840 | + * |
|
| 841 | + * @return array<string,string> |
|
| 842 | + */ |
|
| 843 | 843 | public static function getUTFBOMs() : array |
| 844 | 844 | { |
| 845 | 845 | if(!isset(self::$utfBoms)) { |
@@ -855,15 +855,15 @@ discard block |
||
| 855 | 855 | return self::$utfBoms; |
| 856 | 856 | } |
| 857 | 857 | |
| 858 | - /** |
|
| 859 | - * Checks whether the specified encoding is a valid |
|
| 860 | - * unicode encoding, for example "UTF16-LE" or "UTF8". |
|
| 861 | - * Also accounts for alternate way to write the, like |
|
| 862 | - * "UTF-8", and omitting little/big endian suffixes. |
|
| 863 | - * |
|
| 864 | - * @param string $encoding |
|
| 865 | - * @return boolean |
|
| 866 | - */ |
|
| 858 | + /** |
|
| 859 | + * Checks whether the specified encoding is a valid |
|
| 860 | + * unicode encoding, for example "UTF16-LE" or "UTF8". |
|
| 861 | + * Also accounts for alternate way to write the, like |
|
| 862 | + * "UTF-8", and omitting little/big endian suffixes. |
|
| 863 | + * |
|
| 864 | + * @param string $encoding |
|
| 865 | + * @return boolean |
|
| 866 | + */ |
|
| 867 | 867 | public static function isValidUnicodeEncoding(string $encoding) : bool |
| 868 | 868 | { |
| 869 | 869 | $encodings = self::getKnownUnicodeEncodings(); |
@@ -882,40 +882,40 @@ discard block |
||
| 882 | 882 | return in_array($encoding, $keep); |
| 883 | 883 | } |
| 884 | 884 | |
| 885 | - /** |
|
| 886 | - * Retrieves a list of all known unicode file encodings. |
|
| 887 | - * @return string[] |
|
| 888 | - */ |
|
| 885 | + /** |
|
| 886 | + * Retrieves a list of all known unicode file encodings. |
|
| 887 | + * @return string[] |
|
| 888 | + */ |
|
| 889 | 889 | public static function getKnownUnicodeEncodings() : array |
| 890 | 890 | { |
| 891 | 891 | return array_keys(self::getUTFBOMs()); |
| 892 | 892 | } |
| 893 | 893 | |
| 894 | - /** |
|
| 895 | - * Normalizes the slash style in a file or folder path, |
|
| 896 | - * by replacing any antislashes with forward slashes. |
|
| 897 | - * |
|
| 898 | - * @param string $path |
|
| 899 | - * @return string |
|
| 900 | - */ |
|
| 894 | + /** |
|
| 895 | + * Normalizes the slash style in a file or folder path, |
|
| 896 | + * by replacing any antislashes with forward slashes. |
|
| 897 | + * |
|
| 898 | + * @param string $path |
|
| 899 | + * @return string |
|
| 900 | + */ |
|
| 901 | 901 | public static function normalizePath(string $path) : string |
| 902 | 902 | { |
| 903 | 903 | return str_replace(array('\\', '//'), array('/', '/'), $path); |
| 904 | 904 | } |
| 905 | 905 | |
| 906 | - /** |
|
| 907 | - * Saves the specified data to a file, JSON encoded. |
|
| 908 | - * |
|
| 909 | - * @param mixed $data |
|
| 910 | - * @param string $file |
|
| 911 | - * @param bool $pretty |
|
| 912 | - * @throws FileHelper_Exception |
|
| 913 | - * |
|
| 914 | - * @see FileHelper::ERROR_JSON_ENCODE_ERROR |
|
| 915 | - * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE |
|
| 916 | - * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
|
| 917 | - * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
|
| 918 | - */ |
|
| 906 | + /** |
|
| 907 | + * Saves the specified data to a file, JSON encoded. |
|
| 908 | + * |
|
| 909 | + * @param mixed $data |
|
| 910 | + * @param string $file |
|
| 911 | + * @param bool $pretty |
|
| 912 | + * @throws FileHelper_Exception |
|
| 913 | + * |
|
| 914 | + * @see FileHelper::ERROR_JSON_ENCODE_ERROR |
|
| 915 | + * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE |
|
| 916 | + * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
|
| 917 | + * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
|
| 918 | + */ |
|
| 919 | 919 | public static function saveAsJSON($data, string $file, bool $pretty=false) : void |
| 920 | 920 | { |
| 921 | 921 | $options = null; |
@@ -939,18 +939,18 @@ discard block |
||
| 939 | 939 | self::saveFile($file, $json); |
| 940 | 940 | } |
| 941 | 941 | |
| 942 | - /** |
|
| 943 | - * Saves the specified content to the target file, creating |
|
| 944 | - * the file and the folder as necessary. |
|
| 945 | - * |
|
| 946 | - * @param string $filePath |
|
| 947 | - * @param string $content |
|
| 948 | - * @throws FileHelper_Exception |
|
| 949 | - * |
|
| 950 | - * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE |
|
| 951 | - * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
|
| 952 | - * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
|
| 953 | - */ |
|
| 942 | + /** |
|
| 943 | + * Saves the specified content to the target file, creating |
|
| 944 | + * the file and the folder as necessary. |
|
| 945 | + * |
|
| 946 | + * @param string $filePath |
|
| 947 | + * @param string $content |
|
| 948 | + * @throws FileHelper_Exception |
|
| 949 | + * |
|
| 950 | + * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE |
|
| 951 | + * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
|
| 952 | + * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
|
| 953 | + */ |
|
| 954 | 954 | public static function saveFile(string $filePath, string $content='') : void |
| 955 | 955 | { |
| 956 | 956 | $filePath = self::normalizePath($filePath); |
@@ -1134,14 +1134,14 @@ discard block |
||
| 1134 | 1134 | return $output; |
| 1135 | 1135 | } |
| 1136 | 1136 | |
| 1137 | - /** |
|
| 1138 | - * Retrieves the last modified date for the specified file or folder. |
|
| 1139 | - * |
|
| 1140 | - * Note: If the target does not exist, returns null. |
|
| 1141 | - * |
|
| 1142 | - * @param string $path |
|
| 1143 | - * @return DateTime|NULL |
|
| 1144 | - */ |
|
| 1137 | + /** |
|
| 1138 | + * Retrieves the last modified date for the specified file or folder. |
|
| 1139 | + * |
|
| 1140 | + * Note: If the target does not exist, returns null. |
|
| 1141 | + * |
|
| 1142 | + * @param string $path |
|
| 1143 | + * @return DateTime|NULL |
|
| 1144 | + */ |
|
| 1145 | 1145 | public static function getModifiedDate(string $path) : ?DateTime |
| 1146 | 1146 | { |
| 1147 | 1147 | $time = filemtime($path); |
@@ -1154,25 +1154,25 @@ discard block |
||
| 1154 | 1154 | return $date; |
| 1155 | 1155 | } |
| 1156 | 1156 | |
| 1157 | - /** |
|
| 1158 | - * Retrieves the names of all sub-folders in the specified path. |
|
| 1159 | - * |
|
| 1160 | - * Available options: |
|
| 1161 | - * |
|
| 1162 | - * - recursive: true/false |
|
| 1163 | - * Whether to search for sub-folders recursively. |
|
| 1164 | - * |
|
| 1165 | - * - absolute-paths: true/false |
|
| 1166 | - * Whether to return a list of absolute paths. |
|
| 1167 | - * |
|
| 1168 | - * @param string|DirectoryIterator $targetFolder |
|
| 1169 | - * @param array<string,mixed> $options |
|
| 1170 | - * @throws FileHelper_Exception |
|
| 1171 | - * @return string[] |
|
| 1172 | - * |
|
| 1173 | - * @see FileHelper::ERROR_FIND_SUBFOLDERS_FOLDER_DOES_NOT_EXIST |
|
| 1174 | - * @todo Move this to a separate class. |
|
| 1175 | - */ |
|
| 1157 | + /** |
|
| 1158 | + * Retrieves the names of all sub-folders in the specified path. |
|
| 1159 | + * |
|
| 1160 | + * Available options: |
|
| 1161 | + * |
|
| 1162 | + * - recursive: true/false |
|
| 1163 | + * Whether to search for sub-folders recursively. |
|
| 1164 | + * |
|
| 1165 | + * - absolute-paths: true/false |
|
| 1166 | + * Whether to return a list of absolute paths. |
|
| 1167 | + * |
|
| 1168 | + * @param string|DirectoryIterator $targetFolder |
|
| 1169 | + * @param array<string,mixed> $options |
|
| 1170 | + * @throws FileHelper_Exception |
|
| 1171 | + * @return string[] |
|
| 1172 | + * |
|
| 1173 | + * @see FileHelper::ERROR_FIND_SUBFOLDERS_FOLDER_DOES_NOT_EXIST |
|
| 1174 | + * @todo Move this to a separate class. |
|
| 1175 | + */ |
|
| 1176 | 1176 | public static function getSubfolders($targetFolder, array $options = array()) |
| 1177 | 1177 | { |
| 1178 | 1178 | if($targetFolder instanceof DirectoryIterator) { |
@@ -1237,16 +1237,16 @@ discard block |
||
| 1237 | 1237 | return $result; |
| 1238 | 1238 | } |
| 1239 | 1239 | |
| 1240 | - /** |
|
| 1241 | - * Retrieves the maximum allowed upload file size, in bytes. |
|
| 1242 | - * Takes into account the PHP ini settings <code>post_max_size</code> |
|
| 1243 | - * and <code>upload_max_filesize</code>. Since these cannot |
|
| 1244 | - * be modified at runtime, they are the hard limits for uploads. |
|
| 1245 | - * |
|
| 1246 | - * NOTE: Based on binary values, where 1KB = 1024 Bytes. |
|
| 1247 | - * |
|
| 1248 | - * @return int Will return <code>-1</code> if no limit. |
|
| 1249 | - */ |
|
| 1240 | + /** |
|
| 1241 | + * Retrieves the maximum allowed upload file size, in bytes. |
|
| 1242 | + * Takes into account the PHP ini settings <code>post_max_size</code> |
|
| 1243 | + * and <code>upload_max_filesize</code>. Since these cannot |
|
| 1244 | + * be modified at runtime, they are the hard limits for uploads. |
|
| 1245 | + * |
|
| 1246 | + * NOTE: Based on binary values, where 1KB = 1024 Bytes. |
|
| 1247 | + * |
|
| 1248 | + * @return int Will return <code>-1</code> if no limit. |
|
| 1249 | + */ |
|
| 1250 | 1250 | public static function getMaxUploadFilesize() : int |
| 1251 | 1251 | { |
| 1252 | 1252 | static $max_size = -1; |
@@ -1284,16 +1284,16 @@ discard block |
||
| 1284 | 1284 | return round($size); |
| 1285 | 1285 | } |
| 1286 | 1286 | |
| 1287 | - /** |
|
| 1288 | - * Makes a path relative using a folder depth: will reduce the |
|
| 1289 | - * length of the path so that only the amount of folders defined |
|
| 1290 | - * in the <code>$depth</code> attribute are shown below the actual |
|
| 1291 | - * folder or file in the path. |
|
| 1292 | - * |
|
| 1293 | - * @param string $path The absolute or relative path |
|
| 1294 | - * @param int $depth The folder depth to reduce the path to |
|
| 1295 | - * @return string |
|
| 1296 | - */ |
|
| 1287 | + /** |
|
| 1288 | + * Makes a path relative using a folder depth: will reduce the |
|
| 1289 | + * length of the path so that only the amount of folders defined |
|
| 1290 | + * in the <code>$depth</code> attribute are shown below the actual |
|
| 1291 | + * folder or file in the path. |
|
| 1292 | + * |
|
| 1293 | + * @param string $path The absolute or relative path |
|
| 1294 | + * @param int $depth The folder depth to reduce the path to |
|
| 1295 | + * @return string |
|
| 1296 | + */ |
|
| 1297 | 1297 | public static function relativizePathByDepth(string $path, int $depth=2) : string |
| 1298 | 1298 | { |
| 1299 | 1299 | $path = self::normalizePath($path); |
@@ -1331,23 +1331,23 @@ discard block |
||
| 1331 | 1331 | return trim(implode('/', $tokens), '/'); |
| 1332 | 1332 | } |
| 1333 | 1333 | |
| 1334 | - /** |
|
| 1335 | - * Makes the specified path relative to another path, |
|
| 1336 | - * by removing one from the other if found. Also |
|
| 1337 | - * normalizes the path to use forward slashes. |
|
| 1338 | - * |
|
| 1339 | - * Example: |
|
| 1340 | - * |
|
| 1341 | - * <pre> |
|
| 1342 | - * relativizePath('c:\some\folder\to\file.txt', 'c:\some\folder'); |
|
| 1343 | - * </pre> |
|
| 1344 | - * |
|
| 1345 | - * Result: <code>to/file.txt</code> |
|
| 1346 | - * |
|
| 1347 | - * @param string $path |
|
| 1348 | - * @param string $relativeTo |
|
| 1349 | - * @return string |
|
| 1350 | - */ |
|
| 1334 | + /** |
|
| 1335 | + * Makes the specified path relative to another path, |
|
| 1336 | + * by removing one from the other if found. Also |
|
| 1337 | + * normalizes the path to use forward slashes. |
|
| 1338 | + * |
|
| 1339 | + * Example: |
|
| 1340 | + * |
|
| 1341 | + * <pre> |
|
| 1342 | + * relativizePath('c:\some\folder\to\file.txt', 'c:\some\folder'); |
|
| 1343 | + * </pre> |
|
| 1344 | + * |
|
| 1345 | + * Result: <code>to/file.txt</code> |
|
| 1346 | + * |
|
| 1347 | + * @param string $path |
|
| 1348 | + * @param string $relativeTo |
|
| 1349 | + * @return string |
|
| 1350 | + */ |
|
| 1351 | 1351 | public static function relativizePath(string $path, string $relativeTo) : string |
| 1352 | 1352 | { |
| 1353 | 1353 | $path = self::normalizePath($path); |
@@ -1359,17 +1359,17 @@ discard block |
||
| 1359 | 1359 | return $relative; |
| 1360 | 1360 | } |
| 1361 | 1361 | |
| 1362 | - /** |
|
| 1363 | - * Checks that the target file exists, and throws an exception |
|
| 1364 | - * if it does not. |
|
| 1365 | - * |
|
| 1366 | - * @param string $path |
|
| 1367 | - * @param int|NULL $errorCode Optional custom error code |
|
| 1368 | - * @throws FileHelper_Exception |
|
| 1369 | - * @return string The real path to the file |
|
| 1370 | - * |
|
| 1371 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
| 1372 | - */ |
|
| 1362 | + /** |
|
| 1363 | + * Checks that the target file exists, and throws an exception |
|
| 1364 | + * if it does not. |
|
| 1365 | + * |
|
| 1366 | + * @param string $path |
|
| 1367 | + * @param int|NULL $errorCode Optional custom error code |
|
| 1368 | + * @throws FileHelper_Exception |
|
| 1369 | + * @return string The real path to the file |
|
| 1370 | + * |
|
| 1371 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
| 1372 | + */ |
|
| 1373 | 1373 | public static function requireFileExists(string $path, ?int $errorCode=null) : string |
| 1374 | 1374 | { |
| 1375 | 1375 | $result = realpath($path); |
@@ -1413,18 +1413,18 @@ discard block |
||
| 1413 | 1413 | ); |
| 1414 | 1414 | } |
| 1415 | 1415 | |
| 1416 | - /** |
|
| 1417 | - * Reads a specific line number from the target file and returns its |
|
| 1418 | - * contents, if the file has such a line. Does so with little memory |
|
| 1419 | - * usage, as the file is not read entirely into memory. |
|
| 1420 | - * |
|
| 1421 | - * @param string $path |
|
| 1422 | - * @param int $lineNumber Note: 1-based; the first line is number 1. |
|
| 1423 | - * @return string|NULL Will return null if the requested line does not exist. |
|
| 1424 | - * @throws FileHelper_Exception |
|
| 1425 | - * |
|
| 1426 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
| 1427 | - */ |
|
| 1416 | + /** |
|
| 1417 | + * Reads a specific line number from the target file and returns its |
|
| 1418 | + * contents, if the file has such a line. Does so with little memory |
|
| 1419 | + * usage, as the file is not read entirely into memory. |
|
| 1420 | + * |
|
| 1421 | + * @param string $path |
|
| 1422 | + * @param int $lineNumber Note: 1-based; the first line is number 1. |
|
| 1423 | + * @return string|NULL Will return null if the requested line does not exist. |
|
| 1424 | + * @throws FileHelper_Exception |
|
| 1425 | + * |
|
| 1426 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
| 1427 | + */ |
|
| 1428 | 1428 | public static function getLineFromFile(string $path, int $lineNumber) : ?string |
| 1429 | 1429 | { |
| 1430 | 1430 | self::requireFileExists($path); |
@@ -1440,19 +1440,19 @@ discard block |
||
| 1440 | 1440 | $file->seek($targetLine); |
| 1441 | 1441 | |
| 1442 | 1442 | if($file->key() !== $targetLine) { |
| 1443 | - return null; |
|
| 1443 | + return null; |
|
| 1444 | 1444 | } |
| 1445 | 1445 | |
| 1446 | 1446 | return $file->current(); |
| 1447 | 1447 | } |
| 1448 | 1448 | |
| 1449 | - /** |
|
| 1450 | - * Retrieves the total amount of lines in the file, without |
|
| 1451 | - * reading the whole file into memory. |
|
| 1452 | - * |
|
| 1453 | - * @param string $path |
|
| 1454 | - * @return int |
|
| 1455 | - */ |
|
| 1449 | + /** |
|
| 1450 | + * Retrieves the total amount of lines in the file, without |
|
| 1451 | + * reading the whole file into memory. |
|
| 1452 | + * |
|
| 1453 | + * @param string $path |
|
| 1454 | + * @return int |
|
| 1455 | + */ |
|
| 1456 | 1456 | public static function countFileLines(string $path) : int |
| 1457 | 1457 | { |
| 1458 | 1458 | self::requireFileExists($path); |
@@ -1482,26 +1482,26 @@ discard block |
||
| 1482 | 1482 | return $number+1; |
| 1483 | 1483 | } |
| 1484 | 1484 | |
| 1485 | - /** |
|
| 1486 | - * Parses the target file to detect any PHP classes contained |
|
| 1487 | - * within, and retrieve information on them. Does not use the |
|
| 1488 | - * PHP reflection API. |
|
| 1489 | - * |
|
| 1490 | - * @param string $filePath |
|
| 1491 | - * @return FileHelper_PHPClassInfo |
|
| 1492 | - */ |
|
| 1485 | + /** |
|
| 1486 | + * Parses the target file to detect any PHP classes contained |
|
| 1487 | + * within, and retrieve information on them. Does not use the |
|
| 1488 | + * PHP reflection API. |
|
| 1489 | + * |
|
| 1490 | + * @param string $filePath |
|
| 1491 | + * @return FileHelper_PHPClassInfo |
|
| 1492 | + */ |
|
| 1493 | 1493 | public static function findPHPClasses(string $filePath) : FileHelper_PHPClassInfo |
| 1494 | 1494 | { |
| 1495 | 1495 | return new FileHelper_PHPClassInfo($filePath); |
| 1496 | 1496 | } |
| 1497 | 1497 | |
| 1498 | - /** |
|
| 1499 | - * Detects the end of line style used in the target file, if any. |
|
| 1500 | - * Can be used with large files, because it only reads part of it. |
|
| 1501 | - * |
|
| 1502 | - * @param string $filePath The path to the file. |
|
| 1503 | - * @return NULL|ConvertHelper_EOL The end of line character information, or NULL if none is found. |
|
| 1504 | - */ |
|
| 1498 | + /** |
|
| 1499 | + * Detects the end of line style used in the target file, if any. |
|
| 1500 | + * Can be used with large files, because it only reads part of it. |
|
| 1501 | + * |
|
| 1502 | + * @param string $filePath The path to the file. |
|
| 1503 | + * @return NULL|ConvertHelper_EOL The end of line character information, or NULL if none is found. |
|
| 1504 | + */ |
|
| 1505 | 1505 | public static function detectEOLCharacter(string $filePath) : ?ConvertHelper_EOL |
| 1506 | 1506 | { |
| 1507 | 1507 | // 20 lines is enough to get a good picture of the newline style in the file. |
@@ -1579,16 +1579,16 @@ discard block |
||
| 1579 | 1579 | return $result; |
| 1580 | 1580 | } |
| 1581 | 1581 | |
| 1582 | - /** |
|
| 1583 | - * Reads all content from a file. |
|
| 1584 | - * |
|
| 1585 | - * @param string $filePath |
|
| 1586 | - * @throws FileHelper_Exception |
|
| 1587 | - * @return string |
|
| 1588 | - * |
|
| 1589 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
| 1590 | - * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS |
|
| 1591 | - */ |
|
| 1582 | + /** |
|
| 1583 | + * Reads all content from a file. |
|
| 1584 | + * |
|
| 1585 | + * @param string $filePath |
|
| 1586 | + * @throws FileHelper_Exception |
|
| 1587 | + * @return string |
|
| 1588 | + * |
|
| 1589 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
| 1590 | + * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS |
|
| 1591 | + */ |
|
| 1592 | 1592 | public static function readContents(string $filePath) : string |
| 1593 | 1593 | { |
| 1594 | 1594 | self::requireFileExists($filePath); |
@@ -1609,18 +1609,18 @@ discard block |
||
| 1609 | 1609 | ); |
| 1610 | 1610 | } |
| 1611 | 1611 | |
| 1612 | - /** |
|
| 1613 | - * Ensures that the target path exists on disk, and is a folder. |
|
| 1614 | - * |
|
| 1615 | - * @param string $path |
|
| 1616 | - * @return string The real path, with normalized slashes. |
|
| 1617 | - * @throws FileHelper_Exception |
|
| 1618 | - * |
|
| 1619 | - * @see FileHelper::normalizePath() |
|
| 1620 | - * |
|
| 1621 | - * @see FileHelper::ERROR_FOLDER_DOES_NOT_EXIST |
|
| 1622 | - * @see FileHelper::ERROR_PATH_IS_NOT_A_FOLDER |
|
| 1623 | - */ |
|
| 1612 | + /** |
|
| 1613 | + * Ensures that the target path exists on disk, and is a folder. |
|
| 1614 | + * |
|
| 1615 | + * @param string $path |
|
| 1616 | + * @return string The real path, with normalized slashes. |
|
| 1617 | + * @throws FileHelper_Exception |
|
| 1618 | + * |
|
| 1619 | + * @see FileHelper::normalizePath() |
|
| 1620 | + * |
|
| 1621 | + * @see FileHelper::ERROR_FOLDER_DOES_NOT_EXIST |
|
| 1622 | + * @see FileHelper::ERROR_PATH_IS_NOT_A_FOLDER |
|
| 1623 | + */ |
|
| 1624 | 1624 | public static function requireFolderExists(string $path) : string |
| 1625 | 1625 | { |
| 1626 | 1626 | $actual = realpath($path); |
@@ -91,7 +91,7 @@ discard block |
||
| 91 | 91 | |
| 92 | 92 | $contents = file_get_contents($file); |
| 93 | 93 | |
| 94 | - if($contents === false) |
|
| 94 | + if ($contents === false) |
|
| 95 | 95 | { |
| 96 | 96 | throw new FileHelper_Exception( |
| 97 | 97 | 'Cannot load serialized content from file.', |
@@ -105,7 +105,7 @@ discard block |
||
| 105 | 105 | |
| 106 | 106 | $result = @unserialize($contents); |
| 107 | 107 | |
| 108 | - if($result !== false) { |
|
| 108 | + if ($result !== false) { |
|
| 109 | 109 | return $result; |
| 110 | 110 | } |
| 111 | 111 | |
@@ -128,7 +128,7 @@ discard block |
||
| 128 | 128 | */ |
| 129 | 129 | public static function deleteTree(string $rootFolder) : bool |
| 130 | 130 | { |
| 131 | - if(!file_exists($rootFolder)) { |
|
| 131 | + if (!file_exists($rootFolder)) { |
|
| 132 | 132 | return true; |
| 133 | 133 | } |
| 134 | 134 | |
@@ -169,7 +169,7 @@ discard block |
||
| 169 | 169 | */ |
| 170 | 170 | public static function createFolder(string $path) : void |
| 171 | 171 | { |
| 172 | - if(is_dir($path) || mkdir($path, 0777, true)) { |
|
| 172 | + if (is_dir($path) || mkdir($path, 0777, true)) { |
|
| 173 | 173 | return; |
| 174 | 174 | } |
| 175 | 175 | |
@@ -204,11 +204,11 @@ discard block |
||
| 204 | 204 | |
| 205 | 205 | if ($item->isDir()) |
| 206 | 206 | { |
| 207 | - FileHelper::copyTree($itemPath, $target . '/' . $baseName); |
|
| 207 | + FileHelper::copyTree($itemPath, $target.'/'.$baseName); |
|
| 208 | 208 | } |
| 209 | - else if($item->isFile()) |
|
| 209 | + else if ($item->isFile()) |
|
| 210 | 210 | { |
| 211 | - self::copyFile($itemPath, $target . '/' . $baseName); |
|
| 211 | + self::copyFile($itemPath, $target.'/'.$baseName); |
|
| 212 | 212 | } |
| 213 | 213 | } |
| 214 | 214 | } |
@@ -236,11 +236,11 @@ discard block |
||
| 236 | 236 | |
| 237 | 237 | $targetFolder = dirname($targetPath); |
| 238 | 238 | |
| 239 | - if(!file_exists($targetFolder)) |
|
| 239 | + if (!file_exists($targetFolder)) |
|
| 240 | 240 | { |
| 241 | 241 | self::createFolder($targetFolder); |
| 242 | 242 | } |
| 243 | - else if(!is_writable($targetFolder)) |
|
| 243 | + else if (!is_writable($targetFolder)) |
|
| 244 | 244 | { |
| 245 | 245 | throw new FileHelper_Exception( |
| 246 | 246 | sprintf('Target folder [%s] is not writable.', basename($targetFolder)), |
@@ -252,7 +252,7 @@ discard block |
||
| 252 | 252 | ); |
| 253 | 253 | } |
| 254 | 254 | |
| 255 | - if(copy($sourcePath, $targetPath)) { |
|
| 255 | + if (copy($sourcePath, $targetPath)) { |
|
| 256 | 256 | return; |
| 257 | 257 | } |
| 258 | 258 | |
@@ -279,11 +279,11 @@ discard block |
||
| 279 | 279 | */ |
| 280 | 280 | public static function deleteFile(string $filePath) : void |
| 281 | 281 | { |
| 282 | - if(!file_exists($filePath)) { |
|
| 282 | + if (!file_exists($filePath)) { |
|
| 283 | 283 | return; |
| 284 | 284 | } |
| 285 | 285 | |
| 286 | - if(unlink($filePath)) { |
|
| 286 | + if (unlink($filePath)) { |
|
| 287 | 287 | return; |
| 288 | 288 | } |
| 289 | 289 | |
@@ -307,10 +307,10 @@ discard block |
||
| 307 | 307 | * @return Csv |
| 308 | 308 | * @see CSVHelper::createParser() |
| 309 | 309 | */ |
| 310 | - public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : Csv |
|
| 310 | + public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : Csv |
|
| 311 | 311 | { |
| 312 | - if($delimiter==='') { $delimiter = ';'; } |
|
| 313 | - if($enclosure==='') { $enclosure = '"'; } |
|
| 312 | + if ($delimiter === '') { $delimiter = ';'; } |
|
| 313 | + if ($enclosure === '') { $enclosure = '"'; } |
|
| 314 | 314 | |
| 315 | 315 | $parser = CSVHelper::createParser($delimiter); |
| 316 | 316 | $parser->enclosure = $enclosure; |
@@ -334,11 +334,11 @@ discard block |
||
| 334 | 334 | * @see parseCSVFile() |
| 335 | 335 | * @see FileHelper::ERROR_PARSING_CSV |
| 336 | 336 | */ |
| 337 | - public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array |
|
| 337 | + public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : array |
|
| 338 | 338 | { |
| 339 | 339 | $parser = self::createCSVParser($delimiter, $enclosure, '\\', $heading); |
| 340 | 340 | |
| 341 | - if($parser->parse($csv)) |
|
| 341 | + if ($parser->parse($csv)) |
|
| 342 | 342 | { |
| 343 | 343 | return $parser->data; |
| 344 | 344 | } |
@@ -366,7 +366,7 @@ discard block |
||
| 366 | 366 | * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
| 367 | 367 | * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS |
| 368 | 368 | */ |
| 369 | - public static function parseCSVFile(string $filePath, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array |
|
| 369 | + public static function parseCSVFile(string $filePath, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : array |
|
| 370 | 370 | { |
| 371 | 371 | $content = self::readContents($filePath); |
| 372 | 372 | |
@@ -383,7 +383,7 @@ discard block |
||
| 383 | 383 | public static function detectMimeType(string $fileName) : ?string |
| 384 | 384 | { |
| 385 | 385 | $ext = self::getExtension($fileName); |
| 386 | - if(empty($ext)) { |
|
| 386 | + if (empty($ext)) { |
|
| 387 | 387 | return null; |
| 388 | 388 | } |
| 389 | 389 | |
@@ -423,11 +423,11 @@ discard block |
||
| 423 | 423 | * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
| 424 | 424 | * @see FileHelper::ERROR_UNKNOWN_FILE_MIME_TYPE |
| 425 | 425 | */ |
| 426 | - public static function sendFile(string $filePath, ?string $fileName = null, bool $asAttachment=true) : void |
|
| 426 | + public static function sendFile(string $filePath, ?string $fileName = null, bool $asAttachment = true) : void |
|
| 427 | 427 | { |
| 428 | 428 | self::requireFileExists($filePath); |
| 429 | 429 | |
| 430 | - if(empty($fileName)) { |
|
| 430 | + if (empty($fileName)) { |
|
| 431 | 431 | $fileName = basename($filePath); |
| 432 | 432 | } |
| 433 | 433 | |
@@ -445,10 +445,10 @@ discard block |
||
| 445 | 445 | |
| 446 | 446 | header("Cache-Control: public", true); |
| 447 | 447 | header("Content-Description: File Transfer", true); |
| 448 | - header("Content-Type: " . $mime, true); |
|
| 448 | + header("Content-Type: ".$mime, true); |
|
| 449 | 449 | |
| 450 | 450 | $disposition = 'inline'; |
| 451 | - if($asAttachment) { |
|
| 451 | + if ($asAttachment) { |
|
| 452 | 452 | $disposition = 'attachment'; |
| 453 | 453 | } |
| 454 | 454 | |
@@ -474,7 +474,7 @@ discard block |
||
| 474 | 474 | public static function downloadFile(string $url) : string |
| 475 | 475 | { |
| 476 | 476 | $ch = curl_init(); |
| 477 | - if(!is_resource($ch)) |
|
| 477 | + if (!is_resource($ch)) |
|
| 478 | 478 | { |
| 479 | 479 | throw new FileHelper_Exception( |
| 480 | 480 | 'Could not initialize a new cURL instance.', |
@@ -495,7 +495,7 @@ discard block |
||
| 495 | 495 | |
| 496 | 496 | $output = curl_exec($ch); |
| 497 | 497 | |
| 498 | - if($output === false) { |
|
| 498 | + if ($output === false) { |
|
| 499 | 499 | throw new FileHelper_Exception( |
| 500 | 500 | 'Unable to open URL', |
| 501 | 501 | sprintf( |
@@ -509,7 +509,7 @@ discard block |
||
| 509 | 509 | |
| 510 | 510 | curl_close($ch); |
| 511 | 511 | |
| 512 | - if(is_string($output)) |
|
| 512 | + if (is_string($output)) |
|
| 513 | 513 | { |
| 514 | 514 | return $output; |
| 515 | 515 | } |
@@ -544,14 +544,14 @@ discard block |
||
| 544 | 544 | */ |
| 545 | 545 | public static function getExtension($pathOrDirIterator, bool $lowercase = true) : string |
| 546 | 546 | { |
| 547 | - if($pathOrDirIterator instanceof DirectoryIterator) { |
|
| 547 | + if ($pathOrDirIterator instanceof DirectoryIterator) { |
|
| 548 | 548 | $filename = $pathOrDirIterator->getFilename(); |
| 549 | 549 | } else { |
| 550 | 550 | $filename = basename(strval($pathOrDirIterator)); |
| 551 | 551 | } |
| 552 | 552 | |
| 553 | 553 | $ext = pathinfo($filename, PATHINFO_EXTENSION); |
| 554 | - if($lowercase) { |
|
| 554 | + if ($lowercase) { |
|
| 555 | 555 | $ext = mb_strtolower($ext); |
| 556 | 556 | } |
| 557 | 557 | |
@@ -573,13 +573,13 @@ discard block |
||
| 573 | 573 | public static function getFilename($pathOrDirIterator, $extension = true) : string |
| 574 | 574 | { |
| 575 | 575 | $path = strval($pathOrDirIterator); |
| 576 | - if($pathOrDirIterator instanceof DirectoryIterator) { |
|
| 576 | + if ($pathOrDirIterator instanceof DirectoryIterator) { |
|
| 577 | 577 | $path = $pathOrDirIterator->getFilename(); |
| 578 | 578 | } |
| 579 | 579 | |
| 580 | 580 | $path = self::normalizePath($path); |
| 581 | 581 | |
| 582 | - if(!$extension) { |
|
| 582 | + if (!$extension) { |
|
| 583 | 583 | return pathinfo($path, PATHINFO_FILENAME); |
| 584 | 584 | } |
| 585 | 585 | |
@@ -599,18 +599,18 @@ discard block |
||
| 599 | 599 | * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE |
| 600 | 600 | * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE |
| 601 | 601 | */ |
| 602 | - public static function parseJSONFile(string $file, string $targetEncoding='', $sourceEncoding=null) : array |
|
| 602 | + public static function parseJSONFile(string $file, string $targetEncoding = '', $sourceEncoding = null) : array |
|
| 603 | 603 | { |
| 604 | 604 | self::requireFileExists($file, self::ERROR_CANNOT_FIND_JSON_FILE); |
| 605 | 605 | |
| 606 | 606 | $content = self::readContents($file); |
| 607 | 607 | |
| 608 | - if(!empty($targetEncoding)) { |
|
| 608 | + if (!empty($targetEncoding)) { |
|
| 609 | 609 | $content = mb_convert_encoding($content, $targetEncoding, $sourceEncoding); |
| 610 | 610 | } |
| 611 | 611 | |
| 612 | 612 | $json = json_decode($content, true); |
| 613 | - if($json === false || $json === NULL) { |
|
| 613 | + if ($json === false || $json === NULL) { |
|
| 614 | 614 | throw new FileHelper_Exception( |
| 615 | 615 | 'Cannot decode json data', |
| 616 | 616 | sprintf( |
@@ -650,13 +650,13 @@ discard block |
||
| 650 | 650 | |
| 651 | 651 | $name = str_replace(array_keys($replaces), array_values($replaces), $name); |
| 652 | 652 | |
| 653 | - while(strstr($name, ' ')) { |
|
| 653 | + while (strstr($name, ' ')) { |
|
| 654 | 654 | $name = str_replace(' ', ' ', $name); |
| 655 | 655 | } |
| 656 | 656 | |
| 657 | 657 | $name = str_replace(array_keys($replaces), array_values($replaces), $name); |
| 658 | 658 | |
| 659 | - while(strstr($name, '..')) { |
|
| 659 | + while (strstr($name, '..')) { |
|
| 660 | 660 | $name = str_replace('..', '.', $name); |
| 661 | 661 | } |
| 662 | 662 | |
@@ -692,7 +692,7 @@ discard block |
||
| 692 | 692 | * @throws FileHelper_Exception |
| 693 | 693 | * @see FileHelper::createFileFinder() |
| 694 | 694 | */ |
| 695 | - public static function findHTMLFiles(string $targetFolder, array $options=array()) : array |
|
| 695 | + public static function findHTMLFiles(string $targetFolder, array $options = array()) : array |
|
| 696 | 696 | { |
| 697 | 697 | return self::findFiles($targetFolder, array('html'), $options); |
| 698 | 698 | } |
@@ -710,7 +710,7 @@ discard block |
||
| 710 | 710 | * @throws FileHelper_Exception |
| 711 | 711 | * @see FileHelper::createFileFinder() |
| 712 | 712 | */ |
| 713 | - public static function findPHPFiles(string $targetFolder, array $options=array()) : array |
|
| 713 | + public static function findPHPFiles(string $targetFolder, array $options = array()) : array |
|
| 714 | 714 | { |
| 715 | 715 | return self::findFiles($targetFolder, array('php'), $options); |
| 716 | 716 | } |
@@ -729,7 +729,7 @@ discard block |
||
| 729 | 729 | * @return string[] |
| 730 | 730 | * @see FileHelper::createFileFinder() |
| 731 | 731 | */ |
| 732 | - public static function findFiles(string $targetFolder, array $extensions=array(), array $options=array()) : array |
|
| 732 | + public static function findFiles(string $targetFolder, array $extensions = array(), array $options = array()) : array |
|
| 733 | 733 | { |
| 734 | 734 | $finder = self::createFileFinder($targetFolder); |
| 735 | 735 | |
@@ -739,16 +739,16 @@ discard block |
||
| 739 | 739 | |
| 740 | 740 | $finder->setPathmodeStrip(); |
| 741 | 741 | |
| 742 | - if(isset($options['relative-path']) && $options['relative-path'] === true) |
|
| 742 | + if (isset($options['relative-path']) && $options['relative-path'] === true) |
|
| 743 | 743 | { |
| 744 | 744 | $finder->setPathmodeRelative(); |
| 745 | 745 | } |
| 746 | - else if(isset($options['absolute-path']) && $options['absolute-path'] === true) |
|
| 746 | + else if (isset($options['absolute-path']) && $options['absolute-path'] === true) |
|
| 747 | 747 | { |
| 748 | 748 | $finder->setPathmodeAbsolute(); |
| 749 | 749 | } |
| 750 | 750 | |
| 751 | - if(isset($options['strip-extension'])) |
|
| 751 | + if (isset($options['strip-extension'])) |
|
| 752 | 752 | { |
| 753 | 753 | $finder->stripExtensions(); |
| 754 | 754 | } |
@@ -766,12 +766,12 @@ discard block |
||
| 766 | 766 | * @param bool $keepPath Whether to keep the path component, if any. Default PHP pathinfo behavior is not to. |
| 767 | 767 | * @return string |
| 768 | 768 | */ |
| 769 | - public static function removeExtension(string $filename, bool $keepPath=false) : string |
|
| 769 | + public static function removeExtension(string $filename, bool $keepPath = false) : string |
|
| 770 | 770 | { |
| 771 | 771 | // normalize paths to allow windows style slashes even on nix servers |
| 772 | 772 | $filename = self::normalizePath($filename); |
| 773 | 773 | |
| 774 | - if(!$keepPath) |
|
| 774 | + if (!$keepPath) |
|
| 775 | 775 | { |
| 776 | 776 | return pathinfo($filename, PATHINFO_FILENAME); |
| 777 | 777 | } |
@@ -807,7 +807,7 @@ discard block |
||
| 807 | 807 | public static function detectUTFBom(string $filename) : ?string |
| 808 | 808 | { |
| 809 | 809 | $fp = fopen($filename, 'r'); |
| 810 | - if($fp === false) |
|
| 810 | + if ($fp === false) |
|
| 811 | 811 | { |
| 812 | 812 | throw new FileHelper_Exception( |
| 813 | 813 | 'Cannot open file for reading', |
@@ -822,10 +822,10 @@ discard block |
||
| 822 | 822 | |
| 823 | 823 | $boms = self::getUTFBOMs(); |
| 824 | 824 | |
| 825 | - foreach($boms as $bom => $value) |
|
| 825 | + foreach ($boms as $bom => $value) |
|
| 826 | 826 | { |
| 827 | 827 | $length = mb_strlen($value); |
| 828 | - if(mb_substr($text, 0, $length) == $value) { |
|
| 828 | + if (mb_substr($text, 0, $length) == $value) { |
|
| 829 | 829 | return $bom; |
| 830 | 830 | } |
| 831 | 831 | } |
@@ -842,13 +842,13 @@ discard block |
||
| 842 | 842 | */ |
| 843 | 843 | public static function getUTFBOMs() : array |
| 844 | 844 | { |
| 845 | - if(!isset(self::$utfBoms)) { |
|
| 845 | + if (!isset(self::$utfBoms)) { |
|
| 846 | 846 | self::$utfBoms = array( |
| 847 | - 'UTF32-BE' => chr(0x00) . chr(0x00) . chr(0xFE) . chr(0xFF), |
|
| 848 | - 'UTF32-LE' => chr(0xFF) . chr(0xFE) . chr(0x00) . chr(0x00), |
|
| 849 | - 'UTF16-BE' => chr(0xFE) . chr(0xFF), |
|
| 850 | - 'UTF16-LE' => chr(0xFF) . chr(0xFE), |
|
| 851 | - 'UTF8' => chr(0xEF) . chr(0xBB) . chr(0xBF) |
|
| 847 | + 'UTF32-BE' => chr(0x00).chr(0x00).chr(0xFE).chr(0xFF), |
|
| 848 | + 'UTF32-LE' => chr(0xFF).chr(0xFE).chr(0x00).chr(0x00), |
|
| 849 | + 'UTF16-BE' => chr(0xFE).chr(0xFF), |
|
| 850 | + 'UTF16-LE' => chr(0xFF).chr(0xFE), |
|
| 851 | + 'UTF8' => chr(0xEF).chr(0xBB).chr(0xBF) |
|
| 852 | 852 | ); |
| 853 | 853 | } |
| 854 | 854 | |
@@ -869,7 +869,7 @@ discard block |
||
| 869 | 869 | $encodings = self::getKnownUnicodeEncodings(); |
| 870 | 870 | |
| 871 | 871 | $keep = array(); |
| 872 | - foreach($encodings as $string) |
|
| 872 | + foreach ($encodings as $string) |
|
| 873 | 873 | { |
| 874 | 874 | $withHyphen = str_replace('UTF', 'UTF-', $string); |
| 875 | 875 | |
@@ -916,16 +916,16 @@ discard block |
||
| 916 | 916 | * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
| 917 | 917 | * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
| 918 | 918 | */ |
| 919 | - public static function saveAsJSON($data, string $file, bool $pretty=false) : void |
|
| 919 | + public static function saveAsJSON($data, string $file, bool $pretty = false) : void |
|
| 920 | 920 | { |
| 921 | 921 | $options = null; |
| 922 | - if($pretty) { |
|
| 922 | + if ($pretty) { |
|
| 923 | 923 | $options = JSON_PRETTY_PRINT; |
| 924 | 924 | } |
| 925 | 925 | |
| 926 | 926 | $json = json_encode($data, $options); |
| 927 | 927 | |
| 928 | - if($json===false) |
|
| 928 | + if ($json === false) |
|
| 929 | 929 | { |
| 930 | 930 | $errorCode = json_last_error(); |
| 931 | 931 | |
@@ -951,14 +951,14 @@ discard block |
||
| 951 | 951 | * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
| 952 | 952 | * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
| 953 | 953 | */ |
| 954 | - public static function saveFile(string $filePath, string $content='') : void |
|
| 954 | + public static function saveFile(string $filePath, string $content = '') : void |
|
| 955 | 955 | { |
| 956 | 956 | $filePath = self::normalizePath($filePath); |
| 957 | 957 | |
| 958 | 958 | // target file already exists |
| 959 | - if(file_exists($filePath)) |
|
| 959 | + if (file_exists($filePath)) |
|
| 960 | 960 | { |
| 961 | - if(!is_writable($filePath)) |
|
| 961 | + if (!is_writable($filePath)) |
|
| 962 | 962 | { |
| 963 | 963 | throw new FileHelper_Exception( |
| 964 | 964 | sprintf('Cannot save file: target file [%s] exists, but is not writable.', basename($filePath)), |
@@ -978,7 +978,7 @@ discard block |
||
| 978 | 978 | // create the folder as needed |
| 979 | 979 | self::createFolder($targetFolder); |
| 980 | 980 | |
| 981 | - if(!is_writable($targetFolder)) |
|
| 981 | + if (!is_writable($targetFolder)) |
|
| 982 | 982 | { |
| 983 | 983 | throw new FileHelper_Exception( |
| 984 | 984 | sprintf('Cannot save file: target folder [%s] is not writable.', basename($targetFolder)), |
@@ -991,7 +991,7 @@ discard block |
||
| 991 | 991 | } |
| 992 | 992 | } |
| 993 | 993 | |
| 994 | - if(is_dir($filePath)) |
|
| 994 | + if (is_dir($filePath)) |
|
| 995 | 995 | { |
| 996 | 996 | throw new FileHelper_Exception( |
| 997 | 997 | sprintf('Cannot save file: the target [%s] is a directory.', basename($filePath)), |
@@ -1003,7 +1003,7 @@ discard block |
||
| 1003 | 1003 | ); |
| 1004 | 1004 | } |
| 1005 | 1005 | |
| 1006 | - if(file_put_contents($filePath, $content) !== false) { |
|
| 1006 | + if (file_put_contents($filePath, $content) !== false) { |
|
| 1007 | 1007 | return; |
| 1008 | 1008 | } |
| 1009 | 1009 | |
@@ -1042,7 +1042,7 @@ discard block |
||
| 1042 | 1042 | { |
| 1043 | 1043 | static $checked = array(); |
| 1044 | 1044 | |
| 1045 | - if(isset($checked[$command])) { |
|
| 1045 | + if (isset($checked[$command])) { |
|
| 1046 | 1046 | return $checked[$command]; |
| 1047 | 1047 | } |
| 1048 | 1048 | |
@@ -1055,7 +1055,7 @@ discard block |
||
| 1055 | 1055 | |
| 1056 | 1056 | $os = strtolower(PHP_OS_FAMILY); |
| 1057 | 1057 | |
| 1058 | - if(!isset($osCommands[$os])) |
|
| 1058 | + if (!isset($osCommands[$os])) |
|
| 1059 | 1059 | { |
| 1060 | 1060 | throw new FileHelper_Exception( |
| 1061 | 1061 | 'Unsupported OS for CLI commands', |
@@ -1081,7 +1081,7 @@ discard block |
||
| 1081 | 1081 | $pipes |
| 1082 | 1082 | ); |
| 1083 | 1083 | |
| 1084 | - if($process === false) { |
|
| 1084 | + if ($process === false) { |
|
| 1085 | 1085 | $checked[$command] = false; |
| 1086 | 1086 | return false; |
| 1087 | 1087 | } |
@@ -1113,7 +1113,7 @@ discard block |
||
| 1113 | 1113 | */ |
| 1114 | 1114 | public static function checkPHPFileSyntax(string $path) |
| 1115 | 1115 | { |
| 1116 | - if(!self::canMakePHPCalls()) { |
|
| 1116 | + if (!self::canMakePHPCalls()) { |
|
| 1117 | 1117 | return true; |
| 1118 | 1118 | } |
| 1119 | 1119 | |
@@ -1124,7 +1124,7 @@ discard block |
||
| 1124 | 1124 | // when the validation is successful, the first entry |
| 1125 | 1125 | // in the array contains the success message. When it |
| 1126 | 1126 | // is invalid, the first entry is always empty. |
| 1127 | - if(!empty($output[0])) { |
|
| 1127 | + if (!empty($output[0])) { |
|
| 1128 | 1128 | return true; |
| 1129 | 1129 | } |
| 1130 | 1130 | |
@@ -1145,7 +1145,7 @@ discard block |
||
| 1145 | 1145 | public static function getModifiedDate(string $path) : ?DateTime |
| 1146 | 1146 | { |
| 1147 | 1147 | $time = filemtime($path); |
| 1148 | - if($time === false) { |
|
| 1148 | + if ($time === false) { |
|
| 1149 | 1149 | return null; |
| 1150 | 1150 | } |
| 1151 | 1151 | |
@@ -1175,11 +1175,11 @@ discard block |
||
| 1175 | 1175 | */ |
| 1176 | 1176 | public static function getSubfolders($targetFolder, array $options = array()) |
| 1177 | 1177 | { |
| 1178 | - if($targetFolder instanceof DirectoryIterator) { |
|
| 1178 | + if ($targetFolder instanceof DirectoryIterator) { |
|
| 1179 | 1179 | $targetFolder = $targetFolder->getPathname(); |
| 1180 | 1180 | } |
| 1181 | 1181 | |
| 1182 | - if(!is_dir($targetFolder)) |
|
| 1182 | + if (!is_dir($targetFolder)) |
|
| 1183 | 1183 | { |
| 1184 | 1184 | throw new FileHelper_Exception( |
| 1185 | 1185 | 'Target folder does not exist', |
@@ -1203,29 +1203,29 @@ discard block |
||
| 1203 | 1203 | |
| 1204 | 1204 | $d = new DirectoryIterator($targetFolder); |
| 1205 | 1205 | |
| 1206 | - foreach($d as $item) |
|
| 1206 | + foreach ($d as $item) |
|
| 1207 | 1207 | { |
| 1208 | - if($item->isDir() && !$item->isDot()) |
|
| 1208 | + if ($item->isDir() && !$item->isDot()) |
|
| 1209 | 1209 | { |
| 1210 | 1210 | $name = $item->getFilename(); |
| 1211 | 1211 | |
| 1212 | - if(!$options['absolute-path']) { |
|
| 1212 | + if (!$options['absolute-path']) { |
|
| 1213 | 1213 | $result[] = $name; |
| 1214 | 1214 | } else { |
| 1215 | 1215 | $result[] = $targetFolder.'/'.$name; |
| 1216 | 1216 | } |
| 1217 | 1217 | |
| 1218 | - if(!$options['recursive']) |
|
| 1218 | + if (!$options['recursive']) |
|
| 1219 | 1219 | { |
| 1220 | 1220 | continue; |
| 1221 | 1221 | } |
| 1222 | 1222 | |
| 1223 | 1223 | $subs = self::getSubfolders($targetFolder.'/'.$name, $options); |
| 1224 | - foreach($subs as $sub) |
|
| 1224 | + foreach ($subs as $sub) |
|
| 1225 | 1225 | { |
| 1226 | 1226 | $relative = $name.'/'.$sub; |
| 1227 | 1227 | |
| 1228 | - if(!$options['absolute-path']) { |
|
| 1228 | + if (!$options['absolute-path']) { |
|
| 1229 | 1229 | $result[] = $relative; |
| 1230 | 1230 | } else { |
| 1231 | 1231 | $result[] = $targetFolder.'/'.$relative; |
@@ -1275,7 +1275,7 @@ discard block |
||
| 1275 | 1275 | $unit = preg_replace('/[^bkmgtpezy]/i', '', $size); // Remove the non-unit characters from the size. |
| 1276 | 1276 | $size = floatval(preg_replace('/[^0-9\.]/', '', $size)); // Remove the non-numeric characters from the size. |
| 1277 | 1277 | |
| 1278 | - if($unit) |
|
| 1278 | + if ($unit) |
|
| 1279 | 1279 | { |
| 1280 | 1280 | // Find the position of the unit in the ordered string which is the power of magnitude to multiply a kilobyte by. |
| 1281 | 1281 | return round($size * pow(1024, stripos('bkmgtpezy', $unit[0]))); |
@@ -1294,7 +1294,7 @@ discard block |
||
| 1294 | 1294 | * @param int $depth The folder depth to reduce the path to |
| 1295 | 1295 | * @return string |
| 1296 | 1296 | */ |
| 1297 | - public static function relativizePathByDepth(string $path, int $depth=2) : string |
|
| 1297 | + public static function relativizePathByDepth(string $path, int $depth = 2) : string |
|
| 1298 | 1298 | { |
| 1299 | 1299 | $path = self::normalizePath($path); |
| 1300 | 1300 | |
@@ -1302,17 +1302,17 @@ discard block |
||
| 1302 | 1302 | $tokens = array_filter($tokens); // remove empty entries (trailing slash for example) |
| 1303 | 1303 | $tokens = array_values($tokens); // re-index keys |
| 1304 | 1304 | |
| 1305 | - if(empty($tokens)) { |
|
| 1305 | + if (empty($tokens)) { |
|
| 1306 | 1306 | return ''; |
| 1307 | 1307 | } |
| 1308 | 1308 | |
| 1309 | 1309 | // remove the drive if present |
| 1310 | - if(strstr($tokens[0], ':')) { |
|
| 1310 | + if (strstr($tokens[0], ':')) { |
|
| 1311 | 1311 | array_shift($tokens); |
| 1312 | 1312 | } |
| 1313 | 1313 | |
| 1314 | 1314 | // path was only the drive |
| 1315 | - if(count($tokens) == 0) { |
|
| 1315 | + if (count($tokens) == 0) { |
|
| 1316 | 1316 | return ''; |
| 1317 | 1317 | } |
| 1318 | 1318 | |
@@ -1321,8 +1321,8 @@ discard block |
||
| 1321 | 1321 | |
| 1322 | 1322 | // reduce the path to the specified depth |
| 1323 | 1323 | $length = count($tokens); |
| 1324 | - if($length > $depth) { |
|
| 1325 | - $tokens = array_slice($tokens, $length-$depth); |
|
| 1324 | + if ($length > $depth) { |
|
| 1325 | + $tokens = array_slice($tokens, $length - $depth); |
|
| 1326 | 1326 | } |
| 1327 | 1327 | |
| 1328 | 1328 | // append the last element again |
@@ -1370,14 +1370,14 @@ discard block |
||
| 1370 | 1370 | * |
| 1371 | 1371 | * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
| 1372 | 1372 | */ |
| 1373 | - public static function requireFileExists(string $path, ?int $errorCode=null) : string |
|
| 1373 | + public static function requireFileExists(string $path, ?int $errorCode = null) : string |
|
| 1374 | 1374 | { |
| 1375 | 1375 | $result = realpath($path); |
| 1376 | - if($result !== false) { |
|
| 1376 | + if ($result !== false) { |
|
| 1377 | 1377 | return $result; |
| 1378 | 1378 | } |
| 1379 | 1379 | |
| 1380 | - if($errorCode === null) { |
|
| 1380 | + if ($errorCode === null) { |
|
| 1381 | 1381 | $errorCode = self::ERROR_FILE_DOES_NOT_EXIST; |
| 1382 | 1382 | } |
| 1383 | 1383 | |
@@ -1394,15 +1394,15 @@ discard block |
||
| 1394 | 1394 | * @return string |
| 1395 | 1395 | * @throws FileHelper_Exception |
| 1396 | 1396 | */ |
| 1397 | - public static function requireFileReadable(string $path, ?int $errorCode=null) : string |
|
| 1397 | + public static function requireFileReadable(string $path, ?int $errorCode = null) : string |
|
| 1398 | 1398 | { |
| 1399 | 1399 | $path = self::requireFileExists($path, $errorCode); |
| 1400 | 1400 | |
| 1401 | - if(is_readable($path)) { |
|
| 1401 | + if (is_readable($path)) { |
|
| 1402 | 1402 | return $path; |
| 1403 | 1403 | } |
| 1404 | 1404 | |
| 1405 | - if($errorCode === null) { |
|
| 1405 | + if ($errorCode === null) { |
|
| 1406 | 1406 | $errorCode = self::ERROR_FILE_NOT_READABLE; |
| 1407 | 1407 | } |
| 1408 | 1408 | |
@@ -1431,15 +1431,15 @@ discard block |
||
| 1431 | 1431 | |
| 1432 | 1432 | $file = new \SplFileObject($path); |
| 1433 | 1433 | |
| 1434 | - if($file->eof()) { |
|
| 1434 | + if ($file->eof()) { |
|
| 1435 | 1435 | return ''; |
| 1436 | 1436 | } |
| 1437 | 1437 | |
| 1438 | - $targetLine = $lineNumber-1; |
|
| 1438 | + $targetLine = $lineNumber - 1; |
|
| 1439 | 1439 | |
| 1440 | 1440 | $file->seek($targetLine); |
| 1441 | 1441 | |
| 1442 | - if($file->key() !== $targetLine) { |
|
| 1442 | + if ($file->key() !== $targetLine) { |
|
| 1443 | 1443 | return null; |
| 1444 | 1444 | } |
| 1445 | 1445 | |
@@ -1465,7 +1465,7 @@ discard block |
||
| 1465 | 1465 | $number = $spl->key(); |
| 1466 | 1466 | |
| 1467 | 1467 | // if seeking to the end the cursor is still at 0, there are no lines. |
| 1468 | - if($number === 0) |
|
| 1468 | + if ($number === 0) |
|
| 1469 | 1469 | { |
| 1470 | 1470 | // since it's a very small file, to get reliable results, |
| 1471 | 1471 | // we read its contents and use that to determine what |
@@ -1473,13 +1473,13 @@ discard block |
||
| 1473 | 1473 | // that this is not pactical to solve with the SplFileObject. |
| 1474 | 1474 | $content = file_get_contents($path); |
| 1475 | 1475 | |
| 1476 | - if(empty($content)) { |
|
| 1476 | + if (empty($content)) { |
|
| 1477 | 1477 | return 0; |
| 1478 | 1478 | } |
| 1479 | 1479 | } |
| 1480 | 1480 | |
| 1481 | 1481 | // return the line number we were able to reach + 1 (key is zero-based) |
| 1482 | - return $number+1; |
|
| 1482 | + return $number + 1; |
|
| 1483 | 1483 | } |
| 1484 | 1484 | |
| 1485 | 1485 | /** |
@@ -1527,13 +1527,13 @@ discard block |
||
| 1527 | 1527 | * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
| 1528 | 1528 | * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES |
| 1529 | 1529 | */ |
| 1530 | - public static function readLines(string $filePath, int $amount=0) : array |
|
| 1530 | + public static function readLines(string $filePath, int $amount = 0) : array |
|
| 1531 | 1531 | { |
| 1532 | 1532 | self::requireFileExists($filePath); |
| 1533 | 1533 | |
| 1534 | 1534 | $fn = fopen($filePath, "r"); |
| 1535 | 1535 | |
| 1536 | - if($fn === false) |
|
| 1536 | + if ($fn === false) |
|
| 1537 | 1537 | { |
| 1538 | 1538 | throw new FileHelper_Exception( |
| 1539 | 1539 | 'Could not open file for reading.', |
@@ -1549,19 +1549,19 @@ discard block |
||
| 1549 | 1549 | $counter = 0; |
| 1550 | 1550 | $first = true; |
| 1551 | 1551 | |
| 1552 | - while(!feof($fn)) |
|
| 1552 | + while (!feof($fn)) |
|
| 1553 | 1553 | { |
| 1554 | 1554 | $counter++; |
| 1555 | 1555 | |
| 1556 | 1556 | $line = fgets($fn); |
| 1557 | 1557 | |
| 1558 | 1558 | // can happen with zero length files |
| 1559 | - if($line === false) { |
|
| 1559 | + if ($line === false) { |
|
| 1560 | 1560 | continue; |
| 1561 | 1561 | } |
| 1562 | 1562 | |
| 1563 | 1563 | // the first line may contain a unicode BOM marker. |
| 1564 | - if($first) |
|
| 1564 | + if ($first) |
|
| 1565 | 1565 | { |
| 1566 | 1566 | $line = ConvertHelper::stripUTFBom($line); |
| 1567 | 1567 | $first = false; |
@@ -1569,7 +1569,7 @@ discard block |
||
| 1569 | 1569 | |
| 1570 | 1570 | $result[] = $line; |
| 1571 | 1571 | |
| 1572 | - if($amount > 0 && $counter == $amount) { |
|
| 1572 | + if ($amount > 0 && $counter == $amount) { |
|
| 1573 | 1573 | break; |
| 1574 | 1574 | } |
| 1575 | 1575 | } |
@@ -1595,7 +1595,7 @@ discard block |
||
| 1595 | 1595 | |
| 1596 | 1596 | $result = file_get_contents($filePath); |
| 1597 | 1597 | |
| 1598 | - if($result !== false) { |
|
| 1598 | + if ($result !== false) { |
|
| 1599 | 1599 | return $result; |
| 1600 | 1600 | } |
| 1601 | 1601 | |
@@ -1625,7 +1625,7 @@ discard block |
||
| 1625 | 1625 | { |
| 1626 | 1626 | $actual = realpath($path); |
| 1627 | 1627 | |
| 1628 | - if($actual === false) |
|
| 1628 | + if ($actual === false) |
|
| 1629 | 1629 | { |
| 1630 | 1630 | throw new FileHelper_Exception( |
| 1631 | 1631 | 'Folder does not exist', |
@@ -1637,7 +1637,7 @@ discard block |
||
| 1637 | 1637 | ); |
| 1638 | 1638 | } |
| 1639 | 1639 | |
| 1640 | - if(is_dir($path)) |
|
| 1640 | + if (is_dir($path)) |
|
| 1641 | 1641 | { |
| 1642 | 1642 | return self::normalizePath($actual); |
| 1643 | 1643 | } |
@@ -1659,7 +1659,7 @@ discard block |
||
| 1659 | 1659 | * @param string[] $paths |
| 1660 | 1660 | * @return FileHelper_PathsReducer |
| 1661 | 1661 | */ |
| 1662 | - public static function createPathsReducer(array $paths=array()) : FileHelper_PathsReducer |
|
| 1662 | + public static function createPathsReducer(array $paths = array()) : FileHelper_PathsReducer |
|
| 1663 | 1663 | { |
| 1664 | 1664 | return new FileHelper_PathsReducer(); |
| 1665 | 1665 | } |
@@ -15,7 +15,7 @@ |
||
| 15 | 15 | $autoload = $root.'/vendor/autoload.php'; |
| 16 | 16 | |
| 17 | 17 | // we need the autoloader to be present |
| 18 | - if($autoload === false) |
|
| 18 | + if ($autoload === false) |
|
| 19 | 19 | { |
| 20 | 20 | die('<b>ERROR:</b> Autoloader not present. Run composer update first.'); |
| 21 | 21 | } |
@@ -29,7 +29,7 @@ |
||
| 29 | 29 | |
| 30 | 30 | // In the case of tel URLs, we convert the syntax to use double |
| 31 | 31 | // slashes to make them parsable. |
| 32 | - if(strstr($url, 'tel:') !== false && strstr($url, 'tel://') === false) { |
|
| 32 | + if (strstr($url, 'tel:') !== false && strstr($url, 'tel://') === false) { |
|
| 33 | 33 | $url = str_replace('tel:', 'tel://', $url); |
| 34 | 34 | } |
| 35 | 35 | |
@@ -29,17 +29,17 @@ discard block |
||
| 29 | 29 | */ |
| 30 | 30 | public static function fromString($string) : bool |
| 31 | 31 | { |
| 32 | - if($string === '' || $string === null || !is_scalar($string)) |
|
| 32 | + if ($string === '' || $string === null || !is_scalar($string)) |
|
| 33 | 33 | { |
| 34 | 34 | return false; |
| 35 | 35 | } |
| 36 | 36 | |
| 37 | - if(is_bool($string)) |
|
| 37 | + if (is_bool($string)) |
|
| 38 | 38 | { |
| 39 | 39 | return $string; |
| 40 | 40 | } |
| 41 | 41 | |
| 42 | - if(array_key_exists($string, self::$booleanStrings)) |
|
| 42 | + if (array_key_exists($string, self::$booleanStrings)) |
|
| 43 | 43 | { |
| 44 | 44 | return self::$booleanStrings[$string]; |
| 45 | 45 | } |
@@ -67,7 +67,7 @@ discard block |
||
| 67 | 67 | public static function toString($boolean, bool $yesno = false) : string |
| 68 | 68 | { |
| 69 | 69 | // allow 'yes', 'true', 'no', 'false' string notations as well |
| 70 | - if(!is_bool($boolean)) { |
|
| 70 | + if (!is_bool($boolean)) { |
|
| 71 | 71 | $boolean = self::fromString($boolean); |
| 72 | 72 | } |
| 73 | 73 | |
@@ -97,11 +97,11 @@ discard block |
||
| 97 | 97 | */ |
| 98 | 98 | public static function isBoolean($value) : bool |
| 99 | 99 | { |
| 100 | - if(is_bool($value)) { |
|
| 100 | + if (is_bool($value)) { |
|
| 101 | 101 | return true; |
| 102 | 102 | } |
| 103 | 103 | |
| 104 | - if(!is_scalar($value)) { |
|
| 104 | + if (!is_scalar($value)) { |
|
| 105 | 105 | return false; |
| 106 | 106 | } |
| 107 | 107 | |
@@ -32,7 +32,7 @@ discard block |
||
| 32 | 32 | * @param string[] $paths |
| 33 | 33 | * @throws FileHelper_Exception |
| 34 | 34 | */ |
| 35 | - public function __construct(array $paths=array()) |
|
| 35 | + public function __construct(array $paths = array()) |
|
| 36 | 36 | { |
| 37 | 37 | $this->addPaths($paths); |
| 38 | 38 | } |
@@ -46,7 +46,7 @@ discard block |
||
| 46 | 46 | */ |
| 47 | 47 | public function addPaths(array $paths) : FileHelper_PathsReducer |
| 48 | 48 | { |
| 49 | - foreach($paths as $path) { |
|
| 49 | + foreach ($paths as $path) { |
|
| 50 | 50 | $this->addPath($path); |
| 51 | 51 | } |
| 52 | 52 | |
@@ -64,7 +64,7 @@ discard block |
||
| 64 | 64 | { |
| 65 | 65 | $path = FileHelper::normalizePath(FileHelper::requireFileExists($path)); |
| 66 | 66 | |
| 67 | - if(!in_array($path, $this->paths)) { |
|
| 67 | + if (!in_array($path, $this->paths)) { |
|
| 68 | 68 | $this->paths[] = $path; |
| 69 | 69 | } |
| 70 | 70 | |
@@ -81,11 +81,11 @@ discard block |
||
| 81 | 81 | { |
| 82 | 82 | $split = $this->splitPaths(); |
| 83 | 83 | |
| 84 | - if(empty($split)) { |
|
| 84 | + if (empty($split)) { |
|
| 85 | 85 | return array(); |
| 86 | 86 | } |
| 87 | 87 | |
| 88 | - while($this->shiftPart($split) === true) {} |
|
| 88 | + while ($this->shiftPart($split) === true) {} |
|
| 89 | 89 | |
| 90 | 90 | return $this->joinPaths($split); |
| 91 | 91 | } |
@@ -99,7 +99,7 @@ discard block |
||
| 99 | 99 | $result = array(); |
| 100 | 100 | |
| 101 | 101 | foreach ($split as $entry) { |
| 102 | - if(!empty($entry)) { |
|
| 102 | + if (!empty($entry)) { |
|
| 103 | 103 | $result[] = implode('/', $entry); |
| 104 | 104 | } |
| 105 | 105 | } |
@@ -116,22 +116,22 @@ discard block |
||
| 116 | 116 | $current = null; |
| 117 | 117 | $result = array(); |
| 118 | 118 | |
| 119 | - foreach($split as $entry) |
|
| 119 | + foreach ($split as $entry) |
|
| 120 | 120 | { |
| 121 | - if(empty($entry)) { |
|
| 121 | + if (empty($entry)) { |
|
| 122 | 122 | return false; |
| 123 | 123 | } |
| 124 | 124 | |
| 125 | 125 | $part = array_shift($entry); |
| 126 | - if(empty($entry)) { |
|
| 126 | + if (empty($entry)) { |
|
| 127 | 127 | return false; |
| 128 | 128 | } |
| 129 | 129 | |
| 130 | - if($current === null) { |
|
| 130 | + if ($current === null) { |
|
| 131 | 131 | $current = $part; |
| 132 | 132 | } |
| 133 | 133 | |
| 134 | - if($part !== $current) { |
|
| 134 | + if ($part !== $current) { |
|
| 135 | 135 | return false; |
| 136 | 136 | } |
| 137 | 137 | |
@@ -147,9 +147,9 @@ discard block |
||
| 147 | 147 | { |
| 148 | 148 | $split = array(); |
| 149 | 149 | |
| 150 | - foreach($this->paths as $path) { |
|
| 150 | + foreach ($this->paths as $path) { |
|
| 151 | 151 | $entry = ConvertHelper::explodeTrim('/', $path); |
| 152 | - if(!empty($entry)) { |
|
| 152 | + if (!empty($entry)) { |
|
| 153 | 153 | $split[] = $entry; |
| 154 | 154 | } |
| 155 | 155 | } |
@@ -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 | /** |
@@ -56,33 +56,33 @@ discard block |
||
| 56 | 56 | $this->description = $description; |
| 57 | 57 | } |
| 58 | 58 | |
| 59 | - /** |
|
| 60 | - * The actual EOL character. |
|
| 61 | - * @return string |
|
| 62 | - */ |
|
| 59 | + /** |
|
| 60 | + * The actual EOL character. |
|
| 61 | + * @return string |
|
| 62 | + */ |
|
| 63 | 63 | public function getCharacter() : string |
| 64 | 64 | { |
| 65 | 65 | return $this->char; |
| 66 | 66 | } |
| 67 | 67 | |
| 68 | - /** |
|
| 69 | - * A more detailed, human readable description of the character. |
|
| 70 | - * @return string |
|
| 71 | - */ |
|
| 68 | + /** |
|
| 69 | + * A more detailed, human readable description of the character. |
|
| 70 | + * @return string |
|
| 71 | + */ |
|
| 72 | 72 | public function getDescription() : string |
| 73 | 73 | { |
| 74 | 74 | return $this->description; |
| 75 | 75 | } |
| 76 | 76 | |
| 77 | - /** |
|
| 78 | - * The EOL character type, e.g. "CR+LF", "CR"... |
|
| 79 | - * @return string |
|
| 80 | - * |
|
| 81 | - * @see ConvertHelper_EOL::TYPE_CR |
|
| 82 | - * @see ConvertHelper_EOL::TYPE_CRLF |
|
| 83 | - * @see ConvertHelper_EOL::TYPE_LF |
|
| 84 | - * @see ConvertHelper_EOL::TYPE_LFCR |
|
| 85 | - */ |
|
| 77 | + /** |
|
| 78 | + * The EOL character type, e.g. "CR+LF", "CR"... |
|
| 79 | + * @return string |
|
| 80 | + * |
|
| 81 | + * @see ConvertHelper_EOL::TYPE_CR |
|
| 82 | + * @see ConvertHelper_EOL::TYPE_CRLF |
|
| 83 | + * @see ConvertHelper_EOL::TYPE_LF |
|
| 84 | + * @see ConvertHelper_EOL::TYPE_LFCR |
|
| 85 | + */ |
|
| 86 | 86 | public function getType() : string |
| 87 | 87 | { |
| 88 | 88 | return $this->type; |
@@ -121,7 +121,7 @@ discard block |
||
| 121 | 121 | */ |
| 122 | 122 | public static function detect(string $subjectString) : ?ConvertHelper_EOL |
| 123 | 123 | { |
| 124 | - if(empty($subjectString)) { |
|
| 124 | + if (empty($subjectString)) { |
|
| 125 | 125 | return null; |
| 126 | 126 | } |
| 127 | 127 | |
@@ -129,18 +129,18 @@ discard block |
||
| 129 | 129 | $results = array(); |
| 130 | 130 | $chars = self::getEOLChars(); |
| 131 | 131 | |
| 132 | - foreach($chars as $def) |
|
| 132 | + foreach ($chars as $def) |
|
| 133 | 133 | { |
| 134 | 134 | $amount = substr_count($subjectString, $def['char']); |
| 135 | 135 | |
| 136 | - if($amount > $max) |
|
| 136 | + if ($amount > $max) |
|
| 137 | 137 | { |
| 138 | 138 | $max = $amount; |
| 139 | 139 | $results[] = $def; |
| 140 | 140 | } |
| 141 | 141 | } |
| 142 | 142 | |
| 143 | - if(empty($results)) { |
|
| 143 | + if (empty($results)) { |
|
| 144 | 144 | return null; |
| 145 | 145 | } |
| 146 | 146 | |
@@ -156,7 +156,7 @@ discard block |
||
| 156 | 156 | */ |
| 157 | 157 | public static function getEOLChars() : array |
| 158 | 158 | { |
| 159 | - if(isset(self::$eolChars)) { |
|
| 159 | + if (isset(self::$eolChars)) { |
|
| 160 | 160 | return self::$eolChars; |
| 161 | 161 | } |
| 162 | 162 | |
@@ -12,9 +12,9 @@ discard block |
||
| 12 | 12 | * @param bool $forceNew |
| 13 | 13 | * @return NumberInfo |
| 14 | 14 | */ |
| 15 | -function parseNumber($value, bool $forceNew=false) |
|
| 15 | +function parseNumber($value, bool $forceNew = false) |
|
| 16 | 16 | { |
| 17 | - if($value instanceof NumberInfo && $forceNew !== true) { |
|
| 17 | + if ($value instanceof NumberInfo && $forceNew !== true) { |
|
| 18 | 18 | return $value; |
| 19 | 19 | } |
| 20 | 20 | |
@@ -95,7 +95,7 @@ discard block |
||
| 95 | 95 | $args = func_get_args(); |
| 96 | 96 | |
| 97 | 97 | // is the localization package installed? |
| 98 | - if(function_exists('\AppLocalize\t')) |
|
| 98 | + if (function_exists('\AppLocalize\t')) |
|
| 99 | 99 | { |
| 100 | 100 | return call_user_func_array('\AppLocalize\t', $args); |
| 101 | 101 | } |
@@ -110,7 +110,7 @@ discard block |
||
| 110 | 110 | * @param bool $initial The initial boolean value to use. |
| 111 | 111 | * @return Value_Bool |
| 112 | 112 | */ |
| 113 | -function valBool(bool $initial=false) : Value_Bool |
|
| 113 | +function valBool(bool $initial = false) : Value_Bool |
|
| 114 | 114 | { |
| 115 | 115 | return new Value_Bool($initial); |
| 116 | 116 | } |
@@ -123,7 +123,7 @@ discard block |
||
| 123 | 123 | * @param bool $initial |
| 124 | 124 | * @return Value_Bool_True |
| 125 | 125 | */ |
| 126 | -function valBoolTrue(bool $initial=false) : Value_Bool_True |
|
| 126 | +function valBoolTrue(bool $initial = false) : Value_Bool_True |
|
| 127 | 127 | { |
| 128 | 128 | return new Value_Bool_True($initial); |
| 129 | 129 | } |
@@ -136,7 +136,7 @@ discard block |
||
| 136 | 136 | * @param bool $initial |
| 137 | 137 | * @return Value_Bool_False |
| 138 | 138 | */ |
| 139 | -function valBoolFalse(bool $initial=true) : Value_Bool_False |
|
| 139 | +function valBoolFalse(bool $initial = true) : Value_Bool_False |
|
| 140 | 140 | { |
| 141 | 141 | return new Value_Bool_False($initial); |
| 142 | 142 | } |
@@ -167,7 +167,7 @@ discard block |
||
| 167 | 167 | */ |
| 168 | 168 | function init() |
| 169 | 169 | { |
| 170 | - if(!class_exists('\AppLocalize\Localization')) { |
|
| 170 | + if (!class_exists('\AppLocalize\Localization')) { |
|
| 171 | 171 | return; |
| 172 | 172 | } |
| 173 | 173 | |
@@ -22,9 +22,9 @@ discard block |
||
| 22 | 22 | { |
| 23 | 23 | use Traits_Optionable; |
| 24 | 24 | |
| 25 | - /** |
|
| 26 | - * @var URLInfo |
|
| 27 | - */ |
|
| 25 | + /** |
|
| 26 | + * @var URLInfo |
|
| 27 | + */ |
|
| 28 | 28 | private $url; |
| 29 | 29 | |
| 30 | 30 | public function __construct(URLInfo $url) |
@@ -41,13 +41,13 @@ discard block |
||
| 41 | 41 | ); |
| 42 | 42 | } |
| 43 | 43 | |
| 44 | - /** |
|
| 45 | - * Whether to verify the host's SSL certificate, in |
|
| 46 | - * case of an https connection. |
|
| 47 | - * |
|
| 48 | - * @param bool $verifySSL |
|
| 49 | - * @return URLInfo_ConnectionTester |
|
| 50 | - */ |
|
| 44 | + /** |
|
| 45 | + * Whether to verify the host's SSL certificate, in |
|
| 46 | + * case of an https connection. |
|
| 47 | + * |
|
| 48 | + * @param bool $verifySSL |
|
| 49 | + * @return URLInfo_ConnectionTester |
|
| 50 | + */ |
|
| 51 | 51 | public function setVerifySSL(bool $verifySSL=true) : URLInfo_ConnectionTester |
| 52 | 52 | { |
| 53 | 53 | $this->setOption('verify-ssl', $verifySSL); |
@@ -81,12 +81,12 @@ discard block |
||
| 81 | 81 | return $this->getIntOption('timeout'); |
| 82 | 82 | } |
| 83 | 83 | |
| 84 | - /** |
|
| 85 | - * Initializes the CURL instance. |
|
| 86 | - * |
|
| 87 | - * @throws BaseException |
|
| 88 | - * @return resource |
|
| 89 | - */ |
|
| 84 | + /** |
|
| 85 | + * Initializes the CURL instance. |
|
| 86 | + * |
|
| 87 | + * @throws BaseException |
|
| 88 | + * @return resource |
|
| 89 | + */ |
|
| 90 | 90 | private function initCURL() |
| 91 | 91 | { |
| 92 | 92 | $ch = curl_init(); |
@@ -103,9 +103,9 @@ discard block |
||
| 103 | 103 | return $ch; |
| 104 | 104 | } |
| 105 | 105 | |
| 106 | - /** |
|
| 107 | - * @param resource $ch |
|
| 108 | - */ |
|
| 106 | + /** |
|
| 107 | + * @param resource $ch |
|
| 108 | + */ |
|
| 109 | 109 | private function configureOptions($ch) : void |
| 110 | 110 | { |
| 111 | 111 | if($this->isVerboseModeEnabled()) |
@@ -48,7 +48,7 @@ discard block |
||
| 48 | 48 | * @param bool $verifySSL |
| 49 | 49 | * @return URLInfo_ConnectionTester |
| 50 | 50 | */ |
| 51 | - public function setVerifySSL(bool $verifySSL=true) : URLInfo_ConnectionTester |
|
| 51 | + public function setVerifySSL(bool $verifySSL = true) : URLInfo_ConnectionTester |
|
| 52 | 52 | { |
| 53 | 53 | $this->setOption('verify-ssl', $verifySSL); |
| 54 | 54 | return $this; |
@@ -59,7 +59,7 @@ discard block |
||
| 59 | 59 | return $this->getBoolOption('verify-ssl'); |
| 60 | 60 | } |
| 61 | 61 | |
| 62 | - public function setVerboseMode(bool $enabled=true) : URLInfo_ConnectionTester |
|
| 62 | + public function setVerboseMode(bool $enabled = true) : URLInfo_ConnectionTester |
|
| 63 | 63 | { |
| 64 | 64 | $this->setOption('curl-verbose', $enabled); |
| 65 | 65 | return $this; |
@@ -91,7 +91,7 @@ discard block |
||
| 91 | 91 | { |
| 92 | 92 | $ch = curl_init(); |
| 93 | 93 | |
| 94 | - if(!is_resource($ch)) |
|
| 94 | + if (!is_resource($ch)) |
|
| 95 | 95 | { |
| 96 | 96 | throw new BaseException( |
| 97 | 97 | 'Could not initialize a new cURL instance.', |
@@ -108,7 +108,7 @@ discard block |
||
| 108 | 108 | */ |
| 109 | 109 | private function configureOptions($ch) : void |
| 110 | 110 | { |
| 111 | - if($this->isVerboseModeEnabled()) |
|
| 111 | + if ($this->isVerboseModeEnabled()) |
|
| 112 | 112 | { |
| 113 | 113 | curl_setopt($ch, CURLOPT_VERBOSE, true); |
| 114 | 114 | } |
@@ -118,13 +118,13 @@ discard block |
||
| 118 | 118 | curl_setopt($ch, CURLOPT_TIMEOUT, $this->getTimeout()); |
| 119 | 119 | curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true); |
| 120 | 120 | |
| 121 | - if(!$this->isVerifySSLEnabled()) |
|
| 121 | + if (!$this->isVerifySSLEnabled()) |
|
| 122 | 122 | { |
| 123 | 123 | curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false); |
| 124 | 124 | curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); |
| 125 | 125 | } |
| 126 | 126 | |
| 127 | - if($this->url->hasUsername()) |
|
| 127 | + if ($this->url->hasUsername()) |
|
| 128 | 128 | { |
| 129 | 129 | curl_setopt($ch, CURLOPT_USERNAME, $this->url->getUsername()); |
| 130 | 130 | curl_setopt($ch, CURLOPT_PASSWORD, $this->url->getPassword()); |