@@ -19,51 +19,51 @@ discard block |
||
| 19 | 19 | */ |
| 20 | 20 | class RequestHelper_Response |
| 21 | 21 | { |
| 22 | - /** |
|
| 23 | - * @var RequestHelper |
|
| 24 | - */ |
|
| 22 | + /** |
|
| 23 | + * @var RequestHelper |
|
| 24 | + */ |
|
| 25 | 25 | protected $request; |
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * @var string |
|
| 29 | - */ |
|
| 27 | + /** |
|
| 28 | + * @var string |
|
| 29 | + */ |
|
| 30 | 30 | protected $body = ''; |
| 31 | 31 | |
| 32 | - /** |
|
| 33 | - * @var array |
|
| 34 | - */ |
|
| 32 | + /** |
|
| 33 | + * @var array |
|
| 34 | + */ |
|
| 35 | 35 | protected $info; |
| 36 | 36 | |
| 37 | - /** |
|
| 38 | - * @var bool |
|
| 39 | - */ |
|
| 37 | + /** |
|
| 38 | + * @var bool |
|
| 39 | + */ |
|
| 40 | 40 | protected $isError = false; |
| 41 | 41 | |
| 42 | - /** |
|
| 43 | - * @var string |
|
| 44 | - */ |
|
| 42 | + /** |
|
| 43 | + * @var string |
|
| 44 | + */ |
|
| 45 | 45 | protected $errorMessage = ''; |
| 46 | 46 | |
| 47 | - /** |
|
| 48 | - * @var integer |
|
| 49 | - */ |
|
| 47 | + /** |
|
| 48 | + * @var integer |
|
| 49 | + */ |
|
| 50 | 50 | protected $errorCode = 0; |
| 51 | 51 | |
| 52 | - /** |
|
| 53 | - * @param RequestHelper $helper |
|
| 54 | - * @param array $info The CURL info array from curl_getinfo(). |
|
| 55 | - */ |
|
| 52 | + /** |
|
| 53 | + * @param RequestHelper $helper |
|
| 54 | + * @param array $info The CURL info array from curl_getinfo(). |
|
| 55 | + */ |
|
| 56 | 56 | public function __construct(RequestHelper $helper, array $info) |
| 57 | 57 | { |
| 58 | 58 | $this->request = $helper; |
| 59 | 59 | $this->info = $info; |
| 60 | 60 | } |
| 61 | 61 | |
| 62 | - /** |
|
| 63 | - * Retrieves the request instance that initiated the request. |
|
| 64 | - * |
|
| 65 | - * @return RequestHelper |
|
| 66 | - */ |
|
| 62 | + /** |
|
| 63 | + * Retrieves the request instance that initiated the request. |
|
| 64 | + * |
|
| 65 | + * @return RequestHelper |
|
| 66 | + */ |
|
| 67 | 67 | public function getRequest() : RequestHelper |
| 68 | 68 | { |
| 69 | 69 | return $this->request; |
@@ -84,79 +84,79 @@ discard block |
||
| 84 | 84 | return $this; |
| 85 | 85 | } |
| 86 | 86 | |
| 87 | - /** |
|
| 88 | - * Whether an error occurred in the request. |
|
| 89 | - * @return bool |
|
| 90 | - */ |
|
| 87 | + /** |
|
| 88 | + * Whether an error occurred in the request. |
|
| 89 | + * @return bool |
|
| 90 | + */ |
|
| 91 | 91 | public function isError() : bool |
| 92 | 92 | { |
| 93 | 93 | return $this->isError; |
| 94 | 94 | } |
| 95 | 95 | |
| 96 | - /** |
|
| 97 | - * Whether the request timed out. |
|
| 98 | - * @return bool |
|
| 99 | - */ |
|
| 96 | + /** |
|
| 97 | + * Whether the request timed out. |
|
| 98 | + * @return bool |
|
| 99 | + */ |
|
| 100 | 100 | public function isTimeout() : bool |
| 101 | 101 | { |
| 102 | 102 | return $this->errorCode === RequestHelper_CURL::OPERATION_TIMEDOUT; |
| 103 | 103 | } |
| 104 | 104 | |
| 105 | - /** |
|
| 106 | - * Retrieves the native error message, if an error occurred. |
|
| 107 | - * @return string |
|
| 108 | - */ |
|
| 105 | + /** |
|
| 106 | + * Retrieves the native error message, if an error occurred. |
|
| 107 | + * @return string |
|
| 108 | + */ |
|
| 109 | 109 | public function getErrorMessage() : string |
| 110 | 110 | { |
| 111 | 111 | return $this->errorMessage; |
| 112 | 112 | } |
| 113 | 113 | |
| 114 | - /** |
|
| 115 | - * Retrieves the native CURL error code, if an error occurred. |
|
| 116 | - * @return int |
|
| 117 | - * @see RequestHelper_CURL For a list of error codes. |
|
| 118 | - */ |
|
| 114 | + /** |
|
| 115 | + * Retrieves the native CURL error code, if an error occurred. |
|
| 116 | + * @return int |
|
| 117 | + * @see RequestHelper_CURL For a list of error codes. |
|
| 118 | + */ |
|
| 119 | 119 | public function getErrorCode() : int |
| 120 | 120 | { |
| 121 | 121 | return $this->errorCode; |
| 122 | 122 | } |
| 123 | 123 | |
| 124 | - /** |
|
| 125 | - * Retrieves the full body of the request. |
|
| 126 | - * |
|
| 127 | - * @return string |
|
| 128 | - */ |
|
| 124 | + /** |
|
| 125 | + * Retrieves the full body of the request. |
|
| 126 | + * |
|
| 127 | + * @return string |
|
| 128 | + */ |
|
| 129 | 129 | public function getRequestBody() : string |
| 130 | 130 | { |
| 131 | 131 | return $this->request->getBody(); |
| 132 | 132 | } |
| 133 | 133 | |
| 134 | - /** |
|
| 135 | - * Retrieves the body of the response, if any. |
|
| 136 | - * |
|
| 137 | - * @return string |
|
| 138 | - */ |
|
| 134 | + /** |
|
| 135 | + * Retrieves the body of the response, if any. |
|
| 136 | + * |
|
| 137 | + * @return string |
|
| 138 | + */ |
|
| 139 | 139 | public function getResponseBody() : string |
| 140 | 140 | { |
| 141 | 141 | return $this->body; |
| 142 | 142 | } |
| 143 | 143 | |
| 144 | - /** |
|
| 145 | - * The response HTTP code. |
|
| 146 | - * |
|
| 147 | - * @return int The code, or 0 if none was sent (on error). |
|
| 148 | - */ |
|
| 144 | + /** |
|
| 145 | + * The response HTTP code. |
|
| 146 | + * |
|
| 147 | + * @return int The code, or 0 if none was sent (on error). |
|
| 148 | + */ |
|
| 149 | 149 | public function getCode() : int |
| 150 | 150 | { |
| 151 | 151 | return intval($this->getInfoKey('http_code')); |
| 152 | 152 | } |
| 153 | 153 | |
| 154 | - /** |
|
| 155 | - * Retrieves the actual headers that were sent in the request: |
|
| 156 | - * one header by entry in the indexed array. |
|
| 157 | - * |
|
| 158 | - * @return array |
|
| 159 | - */ |
|
| 154 | + /** |
|
| 155 | + * Retrieves the actual headers that were sent in the request: |
|
| 156 | + * one header by entry in the indexed array. |
|
| 157 | + * |
|
| 158 | + * @return array |
|
| 159 | + */ |
|
| 160 | 160 | public function getHeaders() : array |
| 161 | 161 | { |
| 162 | 162 | return ConvertHelper::explodeTrim("\n", $this->getInfoKey('request_header')); |
@@ -50,32 +50,32 @@ discard block |
||
| 50 | 50 | const ERROR_PATH_IS_NOT_A_FOLDER = 340034; |
| 51 | 51 | const ERROR_CANNOT_WRITE_TO_FOLDER = 340035; |
| 52 | 52 | |
| 53 | - /** |
|
| 54 | - * Opens a serialized file and returns the unserialized data. |
|
| 55 | - * |
|
| 56 | - * @param string $file |
|
| 57 | - * @throws FileHelper_Exception |
|
| 58 | - * @return array |
|
| 59 | - * @deprecated Use parseSerializedFile() instead. |
|
| 60 | - * @see FileHelper::parseSerializedFile() |
|
| 61 | - */ |
|
| 53 | + /** |
|
| 54 | + * Opens a serialized file and returns the unserialized data. |
|
| 55 | + * |
|
| 56 | + * @param string $file |
|
| 57 | + * @throws FileHelper_Exception |
|
| 58 | + * @return array |
|
| 59 | + * @deprecated Use parseSerializedFile() instead. |
|
| 60 | + * @see FileHelper::parseSerializedFile() |
|
| 61 | + */ |
|
| 62 | 62 | public static function openUnserialized(string $file) : array |
| 63 | 63 | { |
| 64 | 64 | return self::parseSerializedFile($file); |
| 65 | 65 | } |
| 66 | 66 | |
| 67 | - /** |
|
| 68 | - * Opens a serialized file and returns the unserialized data. |
|
| 69 | - * |
|
| 70 | - * @param string $file |
|
| 71 | - * @throws FileHelper_Exception |
|
| 72 | - * @return array |
|
| 73 | - * @see FileHelper::parseSerializedFile() |
|
| 74 | - * |
|
| 75 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
| 76 | - * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ |
|
| 77 | - * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED |
|
| 78 | - */ |
|
| 67 | + /** |
|
| 68 | + * Opens a serialized file and returns the unserialized data. |
|
| 69 | + * |
|
| 70 | + * @param string $file |
|
| 71 | + * @throws FileHelper_Exception |
|
| 72 | + * @return array |
|
| 73 | + * @see FileHelper::parseSerializedFile() |
|
| 74 | + * |
|
| 75 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
| 76 | + * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ |
|
| 77 | + * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED |
|
| 78 | + */ |
|
| 79 | 79 | public static function parseSerializedFile(string $file) |
| 80 | 80 | { |
| 81 | 81 | self::requireFileExists($file); |
@@ -144,13 +144,13 @@ discard block |
||
| 144 | 144 | return rmdir($rootFolder); |
| 145 | 145 | } |
| 146 | 146 | |
| 147 | - /** |
|
| 148 | - * Create a folder, if it does not exist yet. |
|
| 149 | - * |
|
| 150 | - * @param string $path |
|
| 151 | - * @throws FileHelper_Exception |
|
| 152 | - * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER |
|
| 153 | - */ |
|
| 147 | + /** |
|
| 148 | + * Create a folder, if it does not exist yet. |
|
| 149 | + * |
|
| 150 | + * @param string $path |
|
| 151 | + * @throws FileHelper_Exception |
|
| 152 | + * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER |
|
| 153 | + */ |
|
| 154 | 154 | public static function createFolder($path) |
| 155 | 155 | { |
| 156 | 156 | if(is_dir($path) || mkdir($path, 0777, true)) { |
@@ -197,22 +197,22 @@ discard block |
||
| 197 | 197 | } |
| 198 | 198 | } |
| 199 | 199 | |
| 200 | - /** |
|
| 201 | - * Copies a file to the target location. Includes checks |
|
| 202 | - * for most error sources, like the source file not being |
|
| 203 | - * readable. Automatically creates the target folder if it |
|
| 204 | - * does not exist yet. |
|
| 205 | - * |
|
| 206 | - * @param string $sourcePath |
|
| 207 | - * @param string $targetPath |
|
| 208 | - * @throws FileHelper_Exception |
|
| 209 | - * |
|
| 210 | - * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER |
|
| 211 | - * @see FileHelper::ERROR_SOURCE_FILE_NOT_FOUND |
|
| 212 | - * @see FileHelper::ERROR_SOURCE_FILE_NOT_READABLE |
|
| 213 | - * @see FileHelper::ERROR_TARGET_COPY_FOLDER_NOT_WRITABLE |
|
| 214 | - * @see FileHelper::ERROR_CANNOT_COPY_FILE |
|
| 215 | - */ |
|
| 200 | + /** |
|
| 201 | + * Copies a file to the target location. Includes checks |
|
| 202 | + * for most error sources, like the source file not being |
|
| 203 | + * readable. Automatically creates the target folder if it |
|
| 204 | + * does not exist yet. |
|
| 205 | + * |
|
| 206 | + * @param string $sourcePath |
|
| 207 | + * @param string $targetPath |
|
| 208 | + * @throws FileHelper_Exception |
|
| 209 | + * |
|
| 210 | + * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER |
|
| 211 | + * @see FileHelper::ERROR_SOURCE_FILE_NOT_FOUND |
|
| 212 | + * @see FileHelper::ERROR_SOURCE_FILE_NOT_READABLE |
|
| 213 | + * @see FileHelper::ERROR_TARGET_COPY_FOLDER_NOT_WRITABLE |
|
| 214 | + * @see FileHelper::ERROR_CANNOT_COPY_FILE |
|
| 215 | + */ |
|
| 216 | 216 | public static function copyFile($sourcePath, $targetPath) |
| 217 | 217 | { |
| 218 | 218 | self::requireFileExists($sourcePath, self::ERROR_SOURCE_FILE_NOT_FOUND); |
@@ -263,15 +263,15 @@ discard block |
||
| 263 | 263 | ); |
| 264 | 264 | } |
| 265 | 265 | |
| 266 | - /** |
|
| 267 | - * Deletes the target file. Ignored if it cannot be found, |
|
| 268 | - * and throws an exception if it fails. |
|
| 269 | - * |
|
| 270 | - * @param string $filePath |
|
| 271 | - * @throws FileHelper_Exception |
|
| 272 | - * |
|
| 273 | - * @see FileHelper::ERROR_CANNOT_DELETE_FILE |
|
| 274 | - */ |
|
| 266 | + /** |
|
| 267 | + * Deletes the target file. Ignored if it cannot be found, |
|
| 268 | + * and throws an exception if it fails. |
|
| 269 | + * |
|
| 270 | + * @param string $filePath |
|
| 271 | + * @throws FileHelper_Exception |
|
| 272 | + * |
|
| 273 | + * @see FileHelper::ERROR_CANNOT_DELETE_FILE |
|
| 274 | + */ |
|
| 275 | 275 | public static function deleteFile(string $filePath) : void |
| 276 | 276 | { |
| 277 | 277 | if(!file_exists($filePath)) { |
@@ -293,15 +293,15 @@ discard block |
||
| 293 | 293 | } |
| 294 | 294 | |
| 295 | 295 | /** |
| 296 | - * Creates a new CSV parser instance and returns it. |
|
| 297 | - * |
|
| 298 | - * @param string $delimiter |
|
| 299 | - * @param string $enclosure |
|
| 300 | - * @param string $escape |
|
| 301 | - * @param bool $heading |
|
| 302 | - * @return \parseCSV |
|
| 303 | - * @todo Move this to the CSV helper. |
|
| 304 | - */ |
|
| 296 | + * Creates a new CSV parser instance and returns it. |
|
| 297 | + * |
|
| 298 | + * @param string $delimiter |
|
| 299 | + * @param string $enclosure |
|
| 300 | + * @param string $escape |
|
| 301 | + * @param bool $heading |
|
| 302 | + * @return \parseCSV |
|
| 303 | + * @todo Move this to the CSV helper. |
|
| 304 | + */ |
|
| 305 | 305 | public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : \parseCSV |
| 306 | 306 | { |
| 307 | 307 | if($delimiter==='') { $delimiter = ';'; } |
@@ -316,23 +316,23 @@ discard block |
||
| 316 | 316 | return $parser; |
| 317 | 317 | } |
| 318 | 318 | |
| 319 | - /** |
|
| 320 | - * Parses all lines in the specified string and returns an |
|
| 321 | - * indexed array with all csv values in each line. |
|
| 322 | - * |
|
| 323 | - * @param string $csv |
|
| 324 | - * @param string $delimiter |
|
| 325 | - * @param string $enclosure |
|
| 326 | - * @param string $escape |
|
| 327 | - * @param bool $heading |
|
| 328 | - * @return array |
|
| 329 | - * @throws FileHelper_Exception |
|
| 330 | - * |
|
| 331 | - * @todo Move this to the CSVHelper. |
|
| 332 | - * |
|
| 333 | - * @see parseCSVFile() |
|
| 334 | - * @see FileHelper::ERROR_PARSING_CSV |
|
| 335 | - */ |
|
| 319 | + /** |
|
| 320 | + * Parses all lines in the specified string and returns an |
|
| 321 | + * indexed array with all csv values in each line. |
|
| 322 | + * |
|
| 323 | + * @param string $csv |
|
| 324 | + * @param string $delimiter |
|
| 325 | + * @param string $enclosure |
|
| 326 | + * @param string $escape |
|
| 327 | + * @param bool $heading |
|
| 328 | + * @return array |
|
| 329 | + * @throws FileHelper_Exception |
|
| 330 | + * |
|
| 331 | + * @todo Move this to the CSVHelper. |
|
| 332 | + * |
|
| 333 | + * @see parseCSVFile() |
|
| 334 | + * @see FileHelper::ERROR_PARSING_CSV |
|
| 335 | + */ |
|
| 336 | 336 | public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array |
| 337 | 337 | { |
| 338 | 338 | $parser = self::createCSVParser($delimiter, $enclosure, $escape, $heading); |
@@ -504,31 +504,31 @@ discard block |
||
| 504 | 504 | ); |
| 505 | 505 | } |
| 506 | 506 | |
| 507 | - /** |
|
| 508 | - * Verifies whether the target file is a PHP file. The path |
|
| 509 | - * to the file can be a path to a file as a string, or a |
|
| 510 | - * DirectoryIterator object instance. |
|
| 511 | - * |
|
| 512 | - * @param string|\DirectoryIterator $pathOrDirIterator |
|
| 513 | - * @return boolean |
|
| 514 | - */ |
|
| 507 | + /** |
|
| 508 | + * Verifies whether the target file is a PHP file. The path |
|
| 509 | + * to the file can be a path to a file as a string, or a |
|
| 510 | + * DirectoryIterator object instance. |
|
| 511 | + * |
|
| 512 | + * @param string|\DirectoryIterator $pathOrDirIterator |
|
| 513 | + * @return boolean |
|
| 514 | + */ |
|
| 515 | 515 | public static function isPHPFile($pathOrDirIterator) |
| 516 | 516 | { |
| 517 | - if(self::getExtension($pathOrDirIterator) == 'php') { |
|
| 518 | - return true; |
|
| 519 | - } |
|
| 517 | + if(self::getExtension($pathOrDirIterator) == 'php') { |
|
| 518 | + return true; |
|
| 519 | + } |
|
| 520 | 520 | |
| 521 | - return false; |
|
| 521 | + return false; |
|
| 522 | 522 | } |
| 523 | 523 | |
| 524 | - /** |
|
| 525 | - * Retrieves the extension of the specified file. Can be a path |
|
| 526 | - * to a file as a string, or a DirectoryIterator object instance. |
|
| 527 | - * |
|
| 528 | - * @param string|\DirectoryIterator $pathOrDirIterator |
|
| 529 | - * @param bool $lowercase |
|
| 530 | - * @return string |
|
| 531 | - */ |
|
| 524 | + /** |
|
| 525 | + * Retrieves the extension of the specified file. Can be a path |
|
| 526 | + * to a file as a string, or a DirectoryIterator object instance. |
|
| 527 | + * |
|
| 528 | + * @param string|\DirectoryIterator $pathOrDirIterator |
|
| 529 | + * @param bool $lowercase |
|
| 530 | + * @return string |
|
| 531 | + */ |
|
| 532 | 532 | public static function getExtension($pathOrDirIterator, bool $lowercase = true) : string |
| 533 | 533 | { |
| 534 | 534 | if($pathOrDirIterator instanceof \DirectoryIterator) { |
@@ -539,51 +539,51 @@ discard block |
||
| 539 | 539 | |
| 540 | 540 | $ext = pathinfo($filename, PATHINFO_EXTENSION); |
| 541 | 541 | if($lowercase) { |
| 542 | - $ext = mb_strtolower($ext); |
|
| 542 | + $ext = mb_strtolower($ext); |
|
| 543 | 543 | } |
| 544 | 544 | |
| 545 | 545 | return $ext; |
| 546 | 546 | } |
| 547 | 547 | |
| 548 | - /** |
|
| 549 | - * Retrieves the file name from a path, with or without extension. |
|
| 550 | - * The path to the file can be a string, or a DirectoryIterator object |
|
| 551 | - * instance. |
|
| 552 | - * |
|
| 553 | - * In case of folders, behaves like the pathinfo function: returns |
|
| 554 | - * the name of the folder. |
|
| 555 | - * |
|
| 556 | - * @param string|\DirectoryIterator $pathOrDirIterator |
|
| 557 | - * @param bool $extension |
|
| 558 | - * @return string |
|
| 559 | - */ |
|
| 548 | + /** |
|
| 549 | + * Retrieves the file name from a path, with or without extension. |
|
| 550 | + * The path to the file can be a string, or a DirectoryIterator object |
|
| 551 | + * instance. |
|
| 552 | + * |
|
| 553 | + * In case of folders, behaves like the pathinfo function: returns |
|
| 554 | + * the name of the folder. |
|
| 555 | + * |
|
| 556 | + * @param string|\DirectoryIterator $pathOrDirIterator |
|
| 557 | + * @param bool $extension |
|
| 558 | + * @return string |
|
| 559 | + */ |
|
| 560 | 560 | public static function getFilename($pathOrDirIterator, $extension = true) |
| 561 | 561 | { |
| 562 | 562 | $path = $pathOrDirIterator; |
| 563 | - if($pathOrDirIterator instanceof \DirectoryIterator) { |
|
| 564 | - $path = $pathOrDirIterator->getFilename(); |
|
| 565 | - } |
|
| 563 | + if($pathOrDirIterator instanceof \DirectoryIterator) { |
|
| 564 | + $path = $pathOrDirIterator->getFilename(); |
|
| 565 | + } |
|
| 566 | 566 | |
| 567 | - $path = self::normalizePath($path); |
|
| 567 | + $path = self::normalizePath($path); |
|
| 568 | 568 | |
| 569 | - if(!$extension) { |
|
| 570 | - return pathinfo($path, PATHINFO_FILENAME); |
|
| 571 | - } |
|
| 569 | + if(!$extension) { |
|
| 570 | + return pathinfo($path, PATHINFO_FILENAME); |
|
| 571 | + } |
|
| 572 | 572 | |
| 573 | - return pathinfo($path, PATHINFO_BASENAME); |
|
| 573 | + return pathinfo($path, PATHINFO_BASENAME); |
|
| 574 | 574 | } |
| 575 | 575 | |
| 576 | - /** |
|
| 577 | - * Tries to read the contents of the target file and |
|
| 578 | - * treat it as JSON to return the decoded JSON data. |
|
| 579 | - * |
|
| 580 | - * @param string $file |
|
| 581 | - * @throws FileHelper_Exception |
|
| 582 | - * @return array |
|
| 583 | - * |
|
| 584 | - * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE |
|
| 585 | - * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE |
|
| 586 | - */ |
|
| 576 | + /** |
|
| 577 | + * Tries to read the contents of the target file and |
|
| 578 | + * treat it as JSON to return the decoded JSON data. |
|
| 579 | + * |
|
| 580 | + * @param string $file |
|
| 581 | + * @throws FileHelper_Exception |
|
| 582 | + * @return array |
|
| 583 | + * |
|
| 584 | + * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE |
|
| 585 | + * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE |
|
| 586 | + */ |
|
| 587 | 587 | public static function parseJSONFile(string $file, $targetEncoding=null, $sourceEncoding=null) |
| 588 | 588 | { |
| 589 | 589 | self::requireFileExists($file, self::ERROR_CANNOT_FIND_JSON_FILE); |
@@ -619,16 +619,16 @@ discard block |
||
| 619 | 619 | return $json; |
| 620 | 620 | } |
| 621 | 621 | |
| 622 | - /** |
|
| 623 | - * Corrects common formatting mistakes when users enter |
|
| 624 | - * file names, like too many spaces, dots and the like. |
|
| 625 | - * |
|
| 626 | - * NOTE: if the file name contains a path, the path is |
|
| 627 | - * stripped, leaving only the file name. |
|
| 628 | - * |
|
| 629 | - * @param string $name |
|
| 630 | - * @return string |
|
| 631 | - */ |
|
| 622 | + /** |
|
| 623 | + * Corrects common formatting mistakes when users enter |
|
| 624 | + * file names, like too many spaces, dots and the like. |
|
| 625 | + * |
|
| 626 | + * NOTE: if the file name contains a path, the path is |
|
| 627 | + * stripped, leaving only the file name. |
|
| 628 | + * |
|
| 629 | + * @param string $name |
|
| 630 | + * @return string |
|
| 631 | + */ |
|
| 632 | 632 | public static function fixFileName(string $name) : string |
| 633 | 633 | { |
| 634 | 634 | $name = trim($name); |
@@ -658,68 +658,68 @@ discard block |
||
| 658 | 658 | return $name; |
| 659 | 659 | } |
| 660 | 660 | |
| 661 | - /** |
|
| 662 | - * Creates an instance of the file finder, which is an easier |
|
| 663 | - * alternative to the other manual findFile methods, since all |
|
| 664 | - * options can be set by chaining. |
|
| 665 | - * |
|
| 666 | - * @param string $path |
|
| 667 | - * @return FileHelper_FileFinder |
|
| 668 | - */ |
|
| 661 | + /** |
|
| 662 | + * Creates an instance of the file finder, which is an easier |
|
| 663 | + * alternative to the other manual findFile methods, since all |
|
| 664 | + * options can be set by chaining. |
|
| 665 | + * |
|
| 666 | + * @param string $path |
|
| 667 | + * @return FileHelper_FileFinder |
|
| 668 | + */ |
|
| 669 | 669 | public static function createFileFinder(string $path) : FileHelper_FileFinder |
| 670 | 670 | { |
| 671 | 671 | return new FileHelper_FileFinder($path); |
| 672 | 672 | } |
| 673 | 673 | |
| 674 | - /** |
|
| 675 | - * Searches for all HTML files in the target folder. |
|
| 676 | - * |
|
| 677 | - * NOTE: This method only exists for backwards compatibility. |
|
| 678 | - * Use the `createFileFinder()` method instead, which offers |
|
| 679 | - * an object oriented interface that is much easier to use. |
|
| 680 | - * |
|
| 681 | - * @param string $targetFolder |
|
| 682 | - * @param array $options |
|
| 683 | - * @return array An indexed array with files. |
|
| 684 | - * @see FileHelper::createFileFinder() |
|
| 685 | - */ |
|
| 674 | + /** |
|
| 675 | + * Searches for all HTML files in the target folder. |
|
| 676 | + * |
|
| 677 | + * NOTE: This method only exists for backwards compatibility. |
|
| 678 | + * Use the `createFileFinder()` method instead, which offers |
|
| 679 | + * an object oriented interface that is much easier to use. |
|
| 680 | + * |
|
| 681 | + * @param string $targetFolder |
|
| 682 | + * @param array $options |
|
| 683 | + * @return array An indexed array with files. |
|
| 684 | + * @see FileHelper::createFileFinder() |
|
| 685 | + */ |
|
| 686 | 686 | public static function findHTMLFiles(string $targetFolder, array $options=array()) : array |
| 687 | 687 | { |
| 688 | 688 | return self::findFiles($targetFolder, array('html'), $options); |
| 689 | 689 | } |
| 690 | 690 | |
| 691 | - /** |
|
| 692 | - * Searches for all PHP files in the target folder. |
|
| 693 | - * |
|
| 694 | - * NOTE: This method only exists for backwards compatibility. |
|
| 695 | - * Use the `createFileFinder()` method instead, which offers |
|
| 696 | - * an object oriented interface that is much easier to use. |
|
| 697 | - * |
|
| 698 | - * @param string $targetFolder |
|
| 699 | - * @param array $options |
|
| 700 | - * @return array An indexed array of PHP files. |
|
| 701 | - * @see FileHelper::createFileFinder() |
|
| 702 | - */ |
|
| 691 | + /** |
|
| 692 | + * Searches for all PHP files in the target folder. |
|
| 693 | + * |
|
| 694 | + * NOTE: This method only exists for backwards compatibility. |
|
| 695 | + * Use the `createFileFinder()` method instead, which offers |
|
| 696 | + * an object oriented interface that is much easier to use. |
|
| 697 | + * |
|
| 698 | + * @param string $targetFolder |
|
| 699 | + * @param array $options |
|
| 700 | + * @return array An indexed array of PHP files. |
|
| 701 | + * @see FileHelper::createFileFinder() |
|
| 702 | + */ |
|
| 703 | 703 | public static function findPHPFiles(string $targetFolder, array $options=array()) : array |
| 704 | 704 | { |
| 705 | 705 | return self::findFiles($targetFolder, array('php'), $options); |
| 706 | 706 | } |
| 707 | 707 | |
| 708 | - /** |
|
| 709 | - * Finds files according to the specified options. |
|
| 710 | - * |
|
| 711 | - * NOTE: This method only exists for backwards compatibility. |
|
| 712 | - * Use the `createFileFinder()` method instead, which offers |
|
| 713 | - * an object oriented interface that is much easier to use. |
|
| 714 | - * |
|
| 715 | - * @param string $targetFolder |
|
| 716 | - * @param array $extensions |
|
| 717 | - * @param array $options |
|
| 718 | - * @param array $files |
|
| 719 | - * @throws FileHelper_Exception |
|
| 720 | - * @return array |
|
| 721 | - * @see FileHelper::createFileFinder() |
|
| 722 | - */ |
|
| 708 | + /** |
|
| 709 | + * Finds files according to the specified options. |
|
| 710 | + * |
|
| 711 | + * NOTE: This method only exists for backwards compatibility. |
|
| 712 | + * Use the `createFileFinder()` method instead, which offers |
|
| 713 | + * an object oriented interface that is much easier to use. |
|
| 714 | + * |
|
| 715 | + * @param string $targetFolder |
|
| 716 | + * @param array $extensions |
|
| 717 | + * @param array $options |
|
| 718 | + * @param array $files |
|
| 719 | + * @throws FileHelper_Exception |
|
| 720 | + * @return array |
|
| 721 | + * @see FileHelper::createFileFinder() |
|
| 722 | + */ |
|
| 723 | 723 | public static function findFiles(string $targetFolder, array $extensions=array(), array $options=array(), array $files=array()) : array |
| 724 | 724 | { |
| 725 | 725 | $finder = self::createFileFinder($targetFolder); |
@@ -745,14 +745,14 @@ discard block |
||
| 745 | 745 | return $finder->getAll(); |
| 746 | 746 | } |
| 747 | 747 | |
| 748 | - /** |
|
| 749 | - * Removes the extension from the specified path or file name, |
|
| 750 | - * if any, and returns the name without the extension. |
|
| 751 | - * |
|
| 752 | - * @param string $filename |
|
| 753 | - * @param bool $keepPath Whether to keep the path component, if any. Default PHP pathinfo behavior is not to. |
|
| 754 | - * @return string |
|
| 755 | - */ |
|
| 748 | + /** |
|
| 749 | + * Removes the extension from the specified path or file name, |
|
| 750 | + * if any, and returns the name without the extension. |
|
| 751 | + * |
|
| 752 | + * @param string $filename |
|
| 753 | + * @param bool $keepPath Whether to keep the path component, if any. Default PHP pathinfo behavior is not to. |
|
| 754 | + * @return string |
|
| 755 | + */ |
|
| 756 | 756 | public static function removeExtension(string $filename, bool $keepPath=false) : string |
| 757 | 757 | { |
| 758 | 758 | // normalize paths to allow windows style slashes even on nix servers |
@@ -772,22 +772,22 @@ discard block |
||
| 772 | 772 | return implode('/', $parts); |
| 773 | 773 | } |
| 774 | 774 | |
| 775 | - /** |
|
| 776 | - * Detects the UTF BOM in the target file, if any. Returns |
|
| 777 | - * the encoding matching the BOM, which can be any of the |
|
| 778 | - * following: |
|
| 779 | - * |
|
| 780 | - * <ul> |
|
| 781 | - * <li>UTF32-BE</li> |
|
| 782 | - * <li>UTF32-LE</li> |
|
| 783 | - * <li>UTF16-BE</li> |
|
| 784 | - * <li>UTF16-LE</li> |
|
| 785 | - * <li>UTF8</li> |
|
| 786 | - * </ul> |
|
| 787 | - * |
|
| 788 | - * @param string $filename |
|
| 789 | - * @return string|NULL |
|
| 790 | - */ |
|
| 775 | + /** |
|
| 776 | + * Detects the UTF BOM in the target file, if any. Returns |
|
| 777 | + * the encoding matching the BOM, which can be any of the |
|
| 778 | + * following: |
|
| 779 | + * |
|
| 780 | + * <ul> |
|
| 781 | + * <li>UTF32-BE</li> |
|
| 782 | + * <li>UTF32-LE</li> |
|
| 783 | + * <li>UTF16-BE</li> |
|
| 784 | + * <li>UTF16-LE</li> |
|
| 785 | + * <li>UTF8</li> |
|
| 786 | + * </ul> |
|
| 787 | + * |
|
| 788 | + * @param string $filename |
|
| 789 | + * @return string|NULL |
|
| 790 | + */ |
|
| 791 | 791 | public static function detectUTFBom(string $filename) : ?string |
| 792 | 792 | { |
| 793 | 793 | $fp = fopen($filename, 'r'); |
@@ -819,13 +819,13 @@ discard block |
||
| 819 | 819 | |
| 820 | 820 | protected static $utfBoms; |
| 821 | 821 | |
| 822 | - /** |
|
| 823 | - * Retrieves a list of all UTF byte order mark character |
|
| 824 | - * sequences, as an assocative array with UTF encoding => bom sequence |
|
| 825 | - * pairs. |
|
| 826 | - * |
|
| 827 | - * @return array |
|
| 828 | - */ |
|
| 822 | + /** |
|
| 823 | + * Retrieves a list of all UTF byte order mark character |
|
| 824 | + * sequences, as an assocative array with UTF encoding => bom sequence |
|
| 825 | + * pairs. |
|
| 826 | + * |
|
| 827 | + * @return array |
|
| 828 | + */ |
|
| 829 | 829 | public static function getUTFBOMs() |
| 830 | 830 | { |
| 831 | 831 | if(!isset(self::$utfBoms)) { |
@@ -841,15 +841,15 @@ discard block |
||
| 841 | 841 | return self::$utfBoms; |
| 842 | 842 | } |
| 843 | 843 | |
| 844 | - /** |
|
| 845 | - * Checks whether the specified encoding is a valid |
|
| 846 | - * unicode encoding, for example "UTF16-LE" or "UTF8". |
|
| 847 | - * Also accounts for alternate way to write the, like |
|
| 848 | - * "UTF-8", and omitting little/big endian suffixes. |
|
| 849 | - * |
|
| 850 | - * @param string $encoding |
|
| 851 | - * @return boolean |
|
| 852 | - */ |
|
| 844 | + /** |
|
| 845 | + * Checks whether the specified encoding is a valid |
|
| 846 | + * unicode encoding, for example "UTF16-LE" or "UTF8". |
|
| 847 | + * Also accounts for alternate way to write the, like |
|
| 848 | + * "UTF-8", and omitting little/big endian suffixes. |
|
| 849 | + * |
|
| 850 | + * @param string $encoding |
|
| 851 | + * @return boolean |
|
| 852 | + */ |
|
| 853 | 853 | public static function isValidUnicodeEncoding(string $encoding) : bool |
| 854 | 854 | { |
| 855 | 855 | $encodings = self::getKnownUnicodeEncodings(); |
@@ -868,40 +868,40 @@ discard block |
||
| 868 | 868 | return in_array($encoding, $keep); |
| 869 | 869 | } |
| 870 | 870 | |
| 871 | - /** |
|
| 872 | - * Retrieves a list of all known unicode file encodings. |
|
| 873 | - * @return array |
|
| 874 | - */ |
|
| 871 | + /** |
|
| 872 | + * Retrieves a list of all known unicode file encodings. |
|
| 873 | + * @return array |
|
| 874 | + */ |
|
| 875 | 875 | public static function getKnownUnicodeEncodings() |
| 876 | 876 | { |
| 877 | 877 | return array_keys(self::getUTFBOMs()); |
| 878 | 878 | } |
| 879 | 879 | |
| 880 | - /** |
|
| 881 | - * Normalizes the slash style in a file or folder path, |
|
| 882 | - * by replacing any antislashes with forward slashes. |
|
| 883 | - * |
|
| 884 | - * @param string $path |
|
| 885 | - * @return string |
|
| 886 | - */ |
|
| 880 | + /** |
|
| 881 | + * Normalizes the slash style in a file or folder path, |
|
| 882 | + * by replacing any antislashes with forward slashes. |
|
| 883 | + * |
|
| 884 | + * @param string $path |
|
| 885 | + * @return string |
|
| 886 | + */ |
|
| 887 | 887 | public static function normalizePath(string $path) : string |
| 888 | 888 | { |
| 889 | 889 | return str_replace(array('\\', '//'), array('/', '/'), $path); |
| 890 | 890 | } |
| 891 | 891 | |
| 892 | - /** |
|
| 893 | - * Saves the specified data to a file, JSON encoded. |
|
| 894 | - * |
|
| 895 | - * @param mixed $data |
|
| 896 | - * @param string $file |
|
| 897 | - * @param bool $pretty |
|
| 898 | - * @throws FileHelper_Exception |
|
| 899 | - * |
|
| 900 | - * @see FileHelper::ERROR_JSON_ENCODE_ERROR |
|
| 901 | - * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE |
|
| 902 | - * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
|
| 903 | - * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
|
| 904 | - */ |
|
| 892 | + /** |
|
| 893 | + * Saves the specified data to a file, JSON encoded. |
|
| 894 | + * |
|
| 895 | + * @param mixed $data |
|
| 896 | + * @param string $file |
|
| 897 | + * @param bool $pretty |
|
| 898 | + * @throws FileHelper_Exception |
|
| 899 | + * |
|
| 900 | + * @see FileHelper::ERROR_JSON_ENCODE_ERROR |
|
| 901 | + * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE |
|
| 902 | + * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
|
| 903 | + * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
|
| 904 | + */ |
|
| 905 | 905 | public static function saveAsJSON($data, string $file, bool $pretty=false) |
| 906 | 906 | { |
| 907 | 907 | $options = null; |
@@ -925,18 +925,18 @@ discard block |
||
| 925 | 925 | self::saveFile($file, $json); |
| 926 | 926 | } |
| 927 | 927 | |
| 928 | - /** |
|
| 929 | - * Saves the specified content to the target file, creating |
|
| 930 | - * the file and the folder as necessary. |
|
| 931 | - * |
|
| 932 | - * @param string $filePath |
|
| 933 | - * @param string $content |
|
| 934 | - * @throws FileHelper_Exception |
|
| 935 | - * |
|
| 936 | - * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE |
|
| 937 | - * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
|
| 938 | - * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
|
| 939 | - */ |
|
| 928 | + /** |
|
| 929 | + * Saves the specified content to the target file, creating |
|
| 930 | + * the file and the folder as necessary. |
|
| 931 | + * |
|
| 932 | + * @param string $filePath |
|
| 933 | + * @param string $content |
|
| 934 | + * @throws FileHelper_Exception |
|
| 935 | + * |
|
| 936 | + * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE |
|
| 937 | + * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
|
| 938 | + * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
|
| 939 | + */ |
|
| 940 | 940 | public static function saveFile(string $filePath, string $content='') : void |
| 941 | 941 | { |
| 942 | 942 | $filePath = self::normalizePath($filePath); |
@@ -1003,12 +1003,12 @@ discard block |
||
| 1003 | 1003 | ); |
| 1004 | 1004 | } |
| 1005 | 1005 | |
| 1006 | - /** |
|
| 1007 | - * Checks whether it is possible to run PHP command |
|
| 1008 | - * line commands. |
|
| 1009 | - * |
|
| 1010 | - * @return boolean |
|
| 1011 | - */ |
|
| 1006 | + /** |
|
| 1007 | + * Checks whether it is possible to run PHP command |
|
| 1008 | + * line commands. |
|
| 1009 | + * |
|
| 1010 | + * @return boolean |
|
| 1011 | + */ |
|
| 1012 | 1012 | public static function canMakePHPCalls() : bool |
| 1013 | 1013 | { |
| 1014 | 1014 | return self::cliCommandExists('php'); |
@@ -1085,16 +1085,16 @@ discard block |
||
| 1085 | 1085 | return $result; |
| 1086 | 1086 | } |
| 1087 | 1087 | |
| 1088 | - /** |
|
| 1089 | - * Validates a PHP file's syntax. |
|
| 1090 | - * |
|
| 1091 | - * NOTE: This will fail silently if the PHP command line |
|
| 1092 | - * is not available. Use {@link FileHelper::canMakePHPCalls()} |
|
| 1093 | - * to check this beforehand as needed. |
|
| 1094 | - * |
|
| 1095 | - * @param string $path |
|
| 1096 | - * @return boolean|array A boolean true if the file is valid, an array with validation messages otherwise. |
|
| 1097 | - */ |
|
| 1088 | + /** |
|
| 1089 | + * Validates a PHP file's syntax. |
|
| 1090 | + * |
|
| 1091 | + * NOTE: This will fail silently if the PHP command line |
|
| 1092 | + * is not available. Use {@link FileHelper::canMakePHPCalls()} |
|
| 1093 | + * to check this beforehand as needed. |
|
| 1094 | + * |
|
| 1095 | + * @param string $path |
|
| 1096 | + * @return boolean|array A boolean true if the file is valid, an array with validation messages otherwise. |
|
| 1097 | + */ |
|
| 1098 | 1098 | public static function checkPHPFileSyntax($path) |
| 1099 | 1099 | { |
| 1100 | 1100 | if(!self::canMakePHPCalls()) { |
@@ -1118,14 +1118,14 @@ discard block |
||
| 1118 | 1118 | return $output; |
| 1119 | 1119 | } |
| 1120 | 1120 | |
| 1121 | - /** |
|
| 1122 | - * Retrieves the last modified date for the specified file or folder. |
|
| 1123 | - * |
|
| 1124 | - * Note: If the target does not exist, returns null. |
|
| 1125 | - * |
|
| 1126 | - * @param string $path |
|
| 1127 | - * @return \DateTime|NULL |
|
| 1128 | - */ |
|
| 1121 | + /** |
|
| 1122 | + * Retrieves the last modified date for the specified file or folder. |
|
| 1123 | + * |
|
| 1124 | + * Note: If the target does not exist, returns null. |
|
| 1125 | + * |
|
| 1126 | + * @param string $path |
|
| 1127 | + * @return \DateTime|NULL |
|
| 1128 | + */ |
|
| 1129 | 1129 | public static function getModifiedDate($path) |
| 1130 | 1130 | { |
| 1131 | 1131 | $time = filemtime($path); |
@@ -1138,24 +1138,24 @@ discard block |
||
| 1138 | 1138 | return null; |
| 1139 | 1139 | } |
| 1140 | 1140 | |
| 1141 | - /** |
|
| 1142 | - * Retrieves the names of all subfolders in the specified path. |
|
| 1143 | - * |
|
| 1144 | - * Available options: |
|
| 1145 | - * |
|
| 1146 | - * - recursive: true/false |
|
| 1147 | - * Whether to search for subfolders recursively. |
|
| 1148 | - * |
|
| 1149 | - * - absolute-paths: true/false |
|
| 1150 | - * Whether to return a list of absolute paths. |
|
| 1151 | - * |
|
| 1152 | - * @param string $targetFolder |
|
| 1153 | - * @param array $options |
|
| 1154 | - * @throws FileHelper_Exception |
|
| 1155 | - * @return string[] |
|
| 1156 | - * |
|
| 1157 | - * @todo Move this to a separate class. |
|
| 1158 | - */ |
|
| 1141 | + /** |
|
| 1142 | + * Retrieves the names of all subfolders in the specified path. |
|
| 1143 | + * |
|
| 1144 | + * Available options: |
|
| 1145 | + * |
|
| 1146 | + * - recursive: true/false |
|
| 1147 | + * Whether to search for subfolders recursively. |
|
| 1148 | + * |
|
| 1149 | + * - absolute-paths: true/false |
|
| 1150 | + * Whether to return a list of absolute paths. |
|
| 1151 | + * |
|
| 1152 | + * @param string $targetFolder |
|
| 1153 | + * @param array $options |
|
| 1154 | + * @throws FileHelper_Exception |
|
| 1155 | + * @return string[] |
|
| 1156 | + * |
|
| 1157 | + * @todo Move this to a separate class. |
|
| 1158 | + */ |
|
| 1159 | 1159 | public static function getSubfolders($targetFolder, $options = array()) |
| 1160 | 1160 | { |
| 1161 | 1161 | if(!is_dir($targetFolder)) |
@@ -1216,16 +1216,16 @@ discard block |
||
| 1216 | 1216 | return $result; |
| 1217 | 1217 | } |
| 1218 | 1218 | |
| 1219 | - /** |
|
| 1220 | - * Retrieves the maximum allowed upload file size, in bytes. |
|
| 1221 | - * Takes into account the PHP ini settings <code>post_max_size</code> |
|
| 1222 | - * and <code>upload_max_filesize</code>. Since these cannot |
|
| 1223 | - * be modified at runtime, they are the hard limits for uploads. |
|
| 1224 | - * |
|
| 1225 | - * NOTE: Based on binary values, where 1KB = 1024 Bytes. |
|
| 1226 | - * |
|
| 1227 | - * @return int Will return <code>-1</code> if no limit. |
|
| 1228 | - */ |
|
| 1219 | + /** |
|
| 1220 | + * Retrieves the maximum allowed upload file size, in bytes. |
|
| 1221 | + * Takes into account the PHP ini settings <code>post_max_size</code> |
|
| 1222 | + * and <code>upload_max_filesize</code>. Since these cannot |
|
| 1223 | + * be modified at runtime, they are the hard limits for uploads. |
|
| 1224 | + * |
|
| 1225 | + * NOTE: Based on binary values, where 1KB = 1024 Bytes. |
|
| 1226 | + * |
|
| 1227 | + * @return int Will return <code>-1</code> if no limit. |
|
| 1228 | + */ |
|
| 1229 | 1229 | public static function getMaxUploadFilesize() : int |
| 1230 | 1230 | { |
| 1231 | 1231 | static $max_size = -1; |
@@ -1263,16 +1263,16 @@ discard block |
||
| 1263 | 1263 | return round($size); |
| 1264 | 1264 | } |
| 1265 | 1265 | |
| 1266 | - /** |
|
| 1267 | - * Makes a path relative using a folder depth: will reduce the |
|
| 1268 | - * length of the path so that only the amount of folders defined |
|
| 1269 | - * in the <code>$depth</code> attribute are shown below the actual |
|
| 1270 | - * folder or file in the path. |
|
| 1271 | - * |
|
| 1272 | - * @param string $path The absolute or relative path |
|
| 1273 | - * @param int $depth The folder depth to reduce the path to |
|
| 1274 | - * @return string |
|
| 1275 | - */ |
|
| 1266 | + /** |
|
| 1267 | + * Makes a path relative using a folder depth: will reduce the |
|
| 1268 | + * length of the path so that only the amount of folders defined |
|
| 1269 | + * in the <code>$depth</code> attribute are shown below the actual |
|
| 1270 | + * folder or file in the path. |
|
| 1271 | + * |
|
| 1272 | + * @param string $path The absolute or relative path |
|
| 1273 | + * @param int $depth The folder depth to reduce the path to |
|
| 1274 | + * @return string |
|
| 1275 | + */ |
|
| 1276 | 1276 | public static function relativizePathByDepth(string $path, int $depth=2) : string |
| 1277 | 1277 | { |
| 1278 | 1278 | $path = self::normalizePath($path); |
@@ -1310,23 +1310,23 @@ discard block |
||
| 1310 | 1310 | return trim(implode('/', $tokens), '/'); |
| 1311 | 1311 | } |
| 1312 | 1312 | |
| 1313 | - /** |
|
| 1314 | - * Makes the specified path relative to another path, |
|
| 1315 | - * by removing one from the other if found. Also |
|
| 1316 | - * normalizes the path to use forward slashes. |
|
| 1317 | - * |
|
| 1318 | - * Example: |
|
| 1319 | - * |
|
| 1320 | - * <pre> |
|
| 1321 | - * relativizePath('c:\some\folder\to\file.txt', 'c:\some\folder'); |
|
| 1322 | - * </pre> |
|
| 1323 | - * |
|
| 1324 | - * Result: <code>to/file.txt</code> |
|
| 1325 | - * |
|
| 1326 | - * @param string $path |
|
| 1327 | - * @param string $relativeTo |
|
| 1328 | - * @return string |
|
| 1329 | - */ |
|
| 1313 | + /** |
|
| 1314 | + * Makes the specified path relative to another path, |
|
| 1315 | + * by removing one from the other if found. Also |
|
| 1316 | + * normalizes the path to use forward slashes. |
|
| 1317 | + * |
|
| 1318 | + * Example: |
|
| 1319 | + * |
|
| 1320 | + * <pre> |
|
| 1321 | + * relativizePath('c:\some\folder\to\file.txt', 'c:\some\folder'); |
|
| 1322 | + * </pre> |
|
| 1323 | + * |
|
| 1324 | + * Result: <code>to/file.txt</code> |
|
| 1325 | + * |
|
| 1326 | + * @param string $path |
|
| 1327 | + * @param string $relativeTo |
|
| 1328 | + * @return string |
|
| 1329 | + */ |
|
| 1330 | 1330 | public static function relativizePath(string $path, string $relativeTo) : string |
| 1331 | 1331 | { |
| 1332 | 1332 | $path = self::normalizePath($path); |
@@ -1338,17 +1338,17 @@ discard block |
||
| 1338 | 1338 | return $relative; |
| 1339 | 1339 | } |
| 1340 | 1340 | |
| 1341 | - /** |
|
| 1342 | - * Checks that the target file exists, and throws an exception |
|
| 1343 | - * if it does not. |
|
| 1344 | - * |
|
| 1345 | - * @param string $path |
|
| 1346 | - * @param int|NULL $errorCode Optional custom error code |
|
| 1347 | - * @throws FileHelper_Exception |
|
| 1348 | - * @return string The real path to the file |
|
| 1349 | - * |
|
| 1350 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
| 1351 | - */ |
|
| 1341 | + /** |
|
| 1342 | + * Checks that the target file exists, and throws an exception |
|
| 1343 | + * if it does not. |
|
| 1344 | + * |
|
| 1345 | + * @param string $path |
|
| 1346 | + * @param int|NULL $errorCode Optional custom error code |
|
| 1347 | + * @throws FileHelper_Exception |
|
| 1348 | + * @return string The real path to the file |
|
| 1349 | + * |
|
| 1350 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
| 1351 | + */ |
|
| 1352 | 1352 | public static function requireFileExists(string $path, $errorCode=null) : string |
| 1353 | 1353 | { |
| 1354 | 1354 | $result = realpath($path); |
@@ -1367,18 +1367,18 @@ discard block |
||
| 1367 | 1367 | ); |
| 1368 | 1368 | } |
| 1369 | 1369 | |
| 1370 | - /** |
|
| 1371 | - * Reads a specific line number from the target file and returns its |
|
| 1372 | - * contents, if the file has such a line. Does so with little memory |
|
| 1373 | - * usage, as the file is not read entirely into memory. |
|
| 1374 | - * |
|
| 1375 | - * @param string $path |
|
| 1376 | - * @param int $lineNumber Note: 1-based; the first line is number 1. |
|
| 1377 | - * @return string|NULL Will return null if the requested line does not exist. |
|
| 1378 | - * @throws FileHelper_Exception |
|
| 1379 | - * |
|
| 1380 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
| 1381 | - */ |
|
| 1370 | + /** |
|
| 1371 | + * Reads a specific line number from the target file and returns its |
|
| 1372 | + * contents, if the file has such a line. Does so with little memory |
|
| 1373 | + * usage, as the file is not read entirely into memory. |
|
| 1374 | + * |
|
| 1375 | + * @param string $path |
|
| 1376 | + * @param int $lineNumber Note: 1-based; the first line is number 1. |
|
| 1377 | + * @return string|NULL Will return null if the requested line does not exist. |
|
| 1378 | + * @throws FileHelper_Exception |
|
| 1379 | + * |
|
| 1380 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
| 1381 | + */ |
|
| 1382 | 1382 | public static function getLineFromFile(string $path, int $lineNumber) : ?string |
| 1383 | 1383 | { |
| 1384 | 1384 | self::requireFileExists($path); |
@@ -1394,19 +1394,19 @@ discard block |
||
| 1394 | 1394 | $file->seek($targetLine); |
| 1395 | 1395 | |
| 1396 | 1396 | if($file->key() !== $targetLine) { |
| 1397 | - return null; |
|
| 1397 | + return null; |
|
| 1398 | 1398 | } |
| 1399 | 1399 | |
| 1400 | 1400 | return $file->current(); |
| 1401 | 1401 | } |
| 1402 | 1402 | |
| 1403 | - /** |
|
| 1404 | - * Retrieves the total amount of lines in the file, without |
|
| 1405 | - * reading the whole file into memory. |
|
| 1406 | - * |
|
| 1407 | - * @param string $path |
|
| 1408 | - * @return int |
|
| 1409 | - */ |
|
| 1403 | + /** |
|
| 1404 | + * Retrieves the total amount of lines in the file, without |
|
| 1405 | + * reading the whole file into memory. |
|
| 1406 | + * |
|
| 1407 | + * @param string $path |
|
| 1408 | + * @return int |
|
| 1409 | + */ |
|
| 1410 | 1410 | public static function countFileLines(string $path) : int |
| 1411 | 1411 | { |
| 1412 | 1412 | self::requireFileExists($path); |
@@ -1436,26 +1436,26 @@ discard block |
||
| 1436 | 1436 | return $number+1; |
| 1437 | 1437 | } |
| 1438 | 1438 | |
| 1439 | - /** |
|
| 1440 | - * Parses the target file to detect any PHP classes contained |
|
| 1441 | - * within, and retrieve information on them. Does not use the |
|
| 1442 | - * PHP reflection API. |
|
| 1443 | - * |
|
| 1444 | - * @param string $filePath |
|
| 1445 | - * @return FileHelper_PHPClassInfo |
|
| 1446 | - */ |
|
| 1439 | + /** |
|
| 1440 | + * Parses the target file to detect any PHP classes contained |
|
| 1441 | + * within, and retrieve information on them. Does not use the |
|
| 1442 | + * PHP reflection API. |
|
| 1443 | + * |
|
| 1444 | + * @param string $filePath |
|
| 1445 | + * @return FileHelper_PHPClassInfo |
|
| 1446 | + */ |
|
| 1447 | 1447 | public static function findPHPClasses(string $filePath) : FileHelper_PHPClassInfo |
| 1448 | 1448 | { |
| 1449 | 1449 | return new FileHelper_PHPClassInfo($filePath); |
| 1450 | 1450 | } |
| 1451 | 1451 | |
| 1452 | - /** |
|
| 1453 | - * Detects the end of line style used in the target file, if any. |
|
| 1454 | - * Can be used with large files, because it only reads part of it. |
|
| 1455 | - * |
|
| 1456 | - * @param string $filePath The path to the file. |
|
| 1457 | - * @return NULL|ConvertHelper_EOL The end of line character information, or NULL if none is found. |
|
| 1458 | - */ |
|
| 1452 | + /** |
|
| 1453 | + * Detects the end of line style used in the target file, if any. |
|
| 1454 | + * Can be used with large files, because it only reads part of it. |
|
| 1455 | + * |
|
| 1456 | + * @param string $filePath The path to the file. |
|
| 1457 | + * @return NULL|ConvertHelper_EOL The end of line character information, or NULL if none is found. |
|
| 1458 | + */ |
|
| 1459 | 1459 | public static function detectEOLCharacter(string $filePath) : ?ConvertHelper_EOL |
| 1460 | 1460 | { |
| 1461 | 1461 | // 20 lines is enough to get a good picture of the newline style in the file. |
@@ -1468,18 +1468,18 @@ discard block |
||
| 1468 | 1468 | return ConvertHelper::detectEOLCharacter($string); |
| 1469 | 1469 | } |
| 1470 | 1470 | |
| 1471 | - /** |
|
| 1472 | - * Reads the specified amount of lines from the target file. |
|
| 1473 | - * Unicode BOM compatible: any byte order marker is stripped |
|
| 1474 | - * from the resulting lines. |
|
| 1475 | - * |
|
| 1476 | - * @param string $filePath |
|
| 1477 | - * @param int $amount Set to 0 to read all lines. |
|
| 1478 | - * @return array |
|
| 1479 | - * |
|
| 1480 | - * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES |
|
| 1481 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
| 1482 | - */ |
|
| 1471 | + /** |
|
| 1472 | + * Reads the specified amount of lines from the target file. |
|
| 1473 | + * Unicode BOM compatible: any byte order marker is stripped |
|
| 1474 | + * from the resulting lines. |
|
| 1475 | + * |
|
| 1476 | + * @param string $filePath |
|
| 1477 | + * @param int $amount Set to 0 to read all lines. |
|
| 1478 | + * @return array |
|
| 1479 | + * |
|
| 1480 | + * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES |
|
| 1481 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
| 1482 | + */ |
|
| 1483 | 1483 | public static function readLines(string $filePath, int $amount=0) : array |
| 1484 | 1484 | { |
| 1485 | 1485 | self::requireFileExists($filePath); |
@@ -1532,16 +1532,16 @@ discard block |
||
| 1532 | 1532 | return $result; |
| 1533 | 1533 | } |
| 1534 | 1534 | |
| 1535 | - /** |
|
| 1536 | - * Reads all content from a file. |
|
| 1537 | - * |
|
| 1538 | - * @param string $filePath |
|
| 1539 | - * @throws FileHelper_Exception |
|
| 1540 | - * @return string |
|
| 1541 | - * |
|
| 1542 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
| 1543 | - * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS |
|
| 1544 | - */ |
|
| 1535 | + /** |
|
| 1536 | + * Reads all content from a file. |
|
| 1537 | + * |
|
| 1538 | + * @param string $filePath |
|
| 1539 | + * @throws FileHelper_Exception |
|
| 1540 | + * @return string |
|
| 1541 | + * |
|
| 1542 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
| 1543 | + * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS |
|
| 1544 | + */ |
|
| 1545 | 1545 | public static function readContents(string $filePath) : string |
| 1546 | 1546 | { |
| 1547 | 1547 | self::requireFileExists($filePath); |
@@ -1562,18 +1562,18 @@ discard block |
||
| 1562 | 1562 | ); |
| 1563 | 1563 | } |
| 1564 | 1564 | |
| 1565 | - /** |
|
| 1566 | - * Ensures that the target path exists on disk, and is a folder. |
|
| 1567 | - * |
|
| 1568 | - * @param string $path |
|
| 1569 | - * @return string The real path, with normalized slashes. |
|
| 1570 | - * @throws FileHelper_Exception |
|
| 1571 | - * |
|
| 1572 | - * @see FileHelper::normalizePath() |
|
| 1573 | - * |
|
| 1574 | - * @see FileHelper::ERROR_FOLDER_DOES_NOT_EXIST |
|
| 1575 | - * @see FileHelper::ERROR_PATH_IS_NOT_A_FOLDER |
|
| 1576 | - */ |
|
| 1565 | + /** |
|
| 1566 | + * Ensures that the target path exists on disk, and is a folder. |
|
| 1567 | + * |
|
| 1568 | + * @param string $path |
|
| 1569 | + * @return string The real path, with normalized slashes. |
|
| 1570 | + * @throws FileHelper_Exception |
|
| 1571 | + * |
|
| 1572 | + * @see FileHelper::normalizePath() |
|
| 1573 | + * |
|
| 1574 | + * @see FileHelper::ERROR_FOLDER_DOES_NOT_EXIST |
|
| 1575 | + * @see FileHelper::ERROR_PATH_IS_NOT_A_FOLDER |
|
| 1576 | + */ |
|
| 1577 | 1577 | public static function requireFolderExists(string $path) : string |
| 1578 | 1578 | { |
| 1579 | 1579 | $actual = realpath($path); |
@@ -82,7 +82,7 @@ discard block |
||
| 82 | 82 | |
| 83 | 83 | $contents = file_get_contents($file); |
| 84 | 84 | |
| 85 | - if($contents === false) |
|
| 85 | + if ($contents === false) |
|
| 86 | 86 | { |
| 87 | 87 | throw new FileHelper_Exception( |
| 88 | 88 | 'Cannot load serialized content from file.', |
@@ -96,7 +96,7 @@ discard block |
||
| 96 | 96 | |
| 97 | 97 | $result = @unserialize($contents); |
| 98 | 98 | |
| 99 | - if($result !== false) { |
|
| 99 | + if ($result !== false) { |
|
| 100 | 100 | return $result; |
| 101 | 101 | } |
| 102 | 102 | |
@@ -112,7 +112,7 @@ discard block |
||
| 112 | 112 | |
| 113 | 113 | public static function deleteTree($rootFolder) |
| 114 | 114 | { |
| 115 | - if(!file_exists($rootFolder)) { |
|
| 115 | + if (!file_exists($rootFolder)) { |
|
| 116 | 116 | return true; |
| 117 | 117 | } |
| 118 | 118 | |
@@ -153,7 +153,7 @@ discard block |
||
| 153 | 153 | */ |
| 154 | 154 | public static function createFolder($path) |
| 155 | 155 | { |
| 156 | - if(is_dir($path) || mkdir($path, 0777, true)) { |
|
| 156 | + if (is_dir($path) || mkdir($path, 0777, true)) { |
|
| 157 | 157 | return; |
| 158 | 158 | } |
| 159 | 159 | |
@@ -188,11 +188,11 @@ discard block |
||
| 188 | 188 | |
| 189 | 189 | if ($item->isDir()) |
| 190 | 190 | { |
| 191 | - FileHelper::copyTree(str_replace('\\', '/', $itemPath), $target . '/' . $baseName); |
|
| 191 | + FileHelper::copyTree(str_replace('\\', '/', $itemPath), $target.'/'.$baseName); |
|
| 192 | 192 | } |
| 193 | - else if($item->isFile()) |
|
| 193 | + else if ($item->isFile()) |
|
| 194 | 194 | { |
| 195 | - self::copyFile($itemPath, $target . '/' . $baseName); |
|
| 195 | + self::copyFile($itemPath, $target.'/'.$baseName); |
|
| 196 | 196 | } |
| 197 | 197 | } |
| 198 | 198 | } |
@@ -217,7 +217,7 @@ discard block |
||
| 217 | 217 | { |
| 218 | 218 | self::requireFileExists($sourcePath, self::ERROR_SOURCE_FILE_NOT_FOUND); |
| 219 | 219 | |
| 220 | - if(!is_readable($sourcePath)) |
|
| 220 | + if (!is_readable($sourcePath)) |
|
| 221 | 221 | { |
| 222 | 222 | throw new FileHelper_Exception( |
| 223 | 223 | sprintf('Source file [%s] to copy is not readable.', basename($sourcePath)), |
@@ -231,11 +231,11 @@ discard block |
||
| 231 | 231 | |
| 232 | 232 | $targetFolder = dirname($targetPath); |
| 233 | 233 | |
| 234 | - if(!file_exists($targetFolder)) |
|
| 234 | + if (!file_exists($targetFolder)) |
|
| 235 | 235 | { |
| 236 | 236 | self::createFolder($targetFolder); |
| 237 | 237 | } |
| 238 | - else if(!is_writable($targetFolder)) |
|
| 238 | + else if (!is_writable($targetFolder)) |
|
| 239 | 239 | { |
| 240 | 240 | throw new FileHelper_Exception( |
| 241 | 241 | sprintf('Target folder [%s] is not writable.', basename($targetFolder)), |
@@ -247,7 +247,7 @@ discard block |
||
| 247 | 247 | ); |
| 248 | 248 | } |
| 249 | 249 | |
| 250 | - if(copy($sourcePath, $targetPath)) { |
|
| 250 | + if (copy($sourcePath, $targetPath)) { |
|
| 251 | 251 | return; |
| 252 | 252 | } |
| 253 | 253 | |
@@ -274,11 +274,11 @@ discard block |
||
| 274 | 274 | */ |
| 275 | 275 | public static function deleteFile(string $filePath) : void |
| 276 | 276 | { |
| 277 | - if(!file_exists($filePath)) { |
|
| 277 | + if (!file_exists($filePath)) { |
|
| 278 | 278 | return; |
| 279 | 279 | } |
| 280 | 280 | |
| 281 | - if(unlink($filePath)) { |
|
| 281 | + if (unlink($filePath)) { |
|
| 282 | 282 | return; |
| 283 | 283 | } |
| 284 | 284 | |
@@ -302,10 +302,10 @@ discard block |
||
| 302 | 302 | * @return \parseCSV |
| 303 | 303 | * @todo Move this to the CSV helper. |
| 304 | 304 | */ |
| 305 | - public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : \parseCSV |
|
| 305 | + public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : \parseCSV |
|
| 306 | 306 | { |
| 307 | - if($delimiter==='') { $delimiter = ';'; } |
|
| 308 | - if($enclosure==='') { $enclosure = '"'; } |
|
| 307 | + if ($delimiter === '') { $delimiter = ';'; } |
|
| 308 | + if ($enclosure === '') { $enclosure = '"'; } |
|
| 309 | 309 | |
| 310 | 310 | $parser = new \parseCSV(null, null, null, array()); |
| 311 | 311 | |
@@ -333,11 +333,11 @@ discard block |
||
| 333 | 333 | * @see parseCSVFile() |
| 334 | 334 | * @see FileHelper::ERROR_PARSING_CSV |
| 335 | 335 | */ |
| 336 | - public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array |
|
| 336 | + public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : array |
|
| 337 | 337 | { |
| 338 | 338 | $parser = self::createCSVParser($delimiter, $enclosure, $escape, $heading); |
| 339 | 339 | $result = $parser->parse_string(/** @scrutinizer ignore-type */ $csv); |
| 340 | - if(is_array($result)) { |
|
| 340 | + if (is_array($result)) { |
|
| 341 | 341 | return $result; |
| 342 | 342 | } |
| 343 | 343 | |
@@ -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 | |
@@ -404,11 +404,11 @@ discard block |
||
| 404 | 404 | * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
| 405 | 405 | * @see FileHelper::ERROR_UNKNOWN_FILE_MIME_TYPE |
| 406 | 406 | */ |
| 407 | - public static function sendFile(string $filePath, $fileName = null, bool $asAttachment=true) |
|
| 407 | + public static function sendFile(string $filePath, $fileName = null, bool $asAttachment = true) |
|
| 408 | 408 | { |
| 409 | 409 | self::requireFileExists($filePath); |
| 410 | 410 | |
| 411 | - if(empty($fileName)) { |
|
| 411 | + if (empty($fileName)) { |
|
| 412 | 412 | $fileName = basename($filePath); |
| 413 | 413 | } |
| 414 | 414 | |
@@ -426,10 +426,10 @@ discard block |
||
| 426 | 426 | |
| 427 | 427 | header("Cache-Control: public", true); |
| 428 | 428 | header("Content-Description: File Transfer", true); |
| 429 | - header("Content-Type: " . $mime, true); |
|
| 429 | + header("Content-Type: ".$mime, true); |
|
| 430 | 430 | |
| 431 | 431 | $disposition = 'inline'; |
| 432 | - if($asAttachment) { |
|
| 432 | + if ($asAttachment) { |
|
| 433 | 433 | $disposition = 'attachment'; |
| 434 | 434 | } |
| 435 | 435 | |
@@ -457,7 +457,7 @@ discard block |
||
| 457 | 457 | requireCURL(); |
| 458 | 458 | |
| 459 | 459 | $ch = curl_init(); |
| 460 | - if(!is_resource($ch)) |
|
| 460 | + if (!is_resource($ch)) |
|
| 461 | 461 | { |
| 462 | 462 | throw new FileHelper_Exception( |
| 463 | 463 | 'Could not initialize a new cURL instance.', |
@@ -478,7 +478,7 @@ discard block |
||
| 478 | 478 | |
| 479 | 479 | $output = curl_exec($ch); |
| 480 | 480 | |
| 481 | - if($output === false) { |
|
| 481 | + if ($output === false) { |
|
| 482 | 482 | throw new FileHelper_Exception( |
| 483 | 483 | 'Unable to open URL', |
| 484 | 484 | sprintf( |
@@ -492,7 +492,7 @@ discard block |
||
| 492 | 492 | |
| 493 | 493 | curl_close($ch); |
| 494 | 494 | |
| 495 | - if(is_string($output)) |
|
| 495 | + if (is_string($output)) |
|
| 496 | 496 | { |
| 497 | 497 | return $output; |
| 498 | 498 | } |
@@ -514,7 +514,7 @@ discard block |
||
| 514 | 514 | */ |
| 515 | 515 | public static function isPHPFile($pathOrDirIterator) |
| 516 | 516 | { |
| 517 | - if(self::getExtension($pathOrDirIterator) == 'php') { |
|
| 517 | + if (self::getExtension($pathOrDirIterator) == 'php') { |
|
| 518 | 518 | return true; |
| 519 | 519 | } |
| 520 | 520 | |
@@ -531,14 +531,14 @@ discard block |
||
| 531 | 531 | */ |
| 532 | 532 | public static function getExtension($pathOrDirIterator, bool $lowercase = true) : string |
| 533 | 533 | { |
| 534 | - if($pathOrDirIterator instanceof \DirectoryIterator) { |
|
| 534 | + if ($pathOrDirIterator instanceof \DirectoryIterator) { |
|
| 535 | 535 | $filename = $pathOrDirIterator->getFilename(); |
| 536 | 536 | } else { |
| 537 | 537 | $filename = basename($pathOrDirIterator); |
| 538 | 538 | } |
| 539 | 539 | |
| 540 | 540 | $ext = pathinfo($filename, PATHINFO_EXTENSION); |
| 541 | - if($lowercase) { |
|
| 541 | + if ($lowercase) { |
|
| 542 | 542 | $ext = mb_strtolower($ext); |
| 543 | 543 | } |
| 544 | 544 | |
@@ -560,13 +560,13 @@ discard block |
||
| 560 | 560 | public static function getFilename($pathOrDirIterator, $extension = true) |
| 561 | 561 | { |
| 562 | 562 | $path = $pathOrDirIterator; |
| 563 | - if($pathOrDirIterator instanceof \DirectoryIterator) { |
|
| 563 | + if ($pathOrDirIterator instanceof \DirectoryIterator) { |
|
| 564 | 564 | $path = $pathOrDirIterator->getFilename(); |
| 565 | 565 | } |
| 566 | 566 | |
| 567 | 567 | $path = self::normalizePath($path); |
| 568 | 568 | |
| 569 | - if(!$extension) { |
|
| 569 | + if (!$extension) { |
|
| 570 | 570 | return pathinfo($path, PATHINFO_FILENAME); |
| 571 | 571 | } |
| 572 | 572 | |
@@ -584,12 +584,12 @@ discard block |
||
| 584 | 584 | * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE |
| 585 | 585 | * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE |
| 586 | 586 | */ |
| 587 | - public static function parseJSONFile(string $file, $targetEncoding=null, $sourceEncoding=null) |
|
| 587 | + public static function parseJSONFile(string $file, $targetEncoding = null, $sourceEncoding = null) |
|
| 588 | 588 | { |
| 589 | 589 | self::requireFileExists($file, self::ERROR_CANNOT_FIND_JSON_FILE); |
| 590 | 590 | |
| 591 | 591 | $content = file_get_contents($file); |
| 592 | - if(!$content) { |
|
| 592 | + if (!$content) { |
|
| 593 | 593 | throw new FileHelper_Exception( |
| 594 | 594 | 'Cannot get file contents', |
| 595 | 595 | sprintf( |
@@ -600,12 +600,12 @@ discard block |
||
| 600 | 600 | ); |
| 601 | 601 | } |
| 602 | 602 | |
| 603 | - if(isset($targetEncoding)) { |
|
| 603 | + if (isset($targetEncoding)) { |
|
| 604 | 604 | $content = mb_convert_encoding($content, $targetEncoding, $sourceEncoding); |
| 605 | 605 | } |
| 606 | 606 | |
| 607 | 607 | $json = json_decode($content, true); |
| 608 | - if($json === false || $json === NULL) { |
|
| 608 | + if ($json === false || $json === NULL) { |
|
| 609 | 609 | throw new FileHelper_Exception( |
| 610 | 610 | 'Cannot decode json data', |
| 611 | 611 | sprintf( |
@@ -645,13 +645,13 @@ discard block |
||
| 645 | 645 | |
| 646 | 646 | $name = str_replace(array_keys($replaces), array_values($replaces), $name); |
| 647 | 647 | |
| 648 | - while(strstr($name, ' ')) { |
|
| 648 | + while (strstr($name, ' ')) { |
|
| 649 | 649 | $name = str_replace(' ', ' ', $name); |
| 650 | 650 | } |
| 651 | 651 | |
| 652 | 652 | $name = str_replace(array_keys($replaces), array_values($replaces), $name); |
| 653 | 653 | |
| 654 | - while(strstr($name, '..')) { |
|
| 654 | + while (strstr($name, '..')) { |
|
| 655 | 655 | $name = str_replace('..', '.', $name); |
| 656 | 656 | } |
| 657 | 657 | |
@@ -683,7 +683,7 @@ discard block |
||
| 683 | 683 | * @return array An indexed array with files. |
| 684 | 684 | * @see FileHelper::createFileFinder() |
| 685 | 685 | */ |
| 686 | - public static function findHTMLFiles(string $targetFolder, array $options=array()) : array |
|
| 686 | + public static function findHTMLFiles(string $targetFolder, array $options = array()) : array |
|
| 687 | 687 | { |
| 688 | 688 | return self::findFiles($targetFolder, array('html'), $options); |
| 689 | 689 | } |
@@ -700,7 +700,7 @@ discard block |
||
| 700 | 700 | * @return array An indexed array of PHP files. |
| 701 | 701 | * @see FileHelper::createFileFinder() |
| 702 | 702 | */ |
| 703 | - public static function findPHPFiles(string $targetFolder, array $options=array()) : array |
|
| 703 | + public static function findPHPFiles(string $targetFolder, array $options = array()) : array |
|
| 704 | 704 | { |
| 705 | 705 | return self::findFiles($targetFolder, array('php'), $options); |
| 706 | 706 | } |
@@ -720,22 +720,22 @@ discard block |
||
| 720 | 720 | * @return array |
| 721 | 721 | * @see FileHelper::createFileFinder() |
| 722 | 722 | */ |
| 723 | - public static function findFiles(string $targetFolder, array $extensions=array(), array $options=array(), array $files=array()) : array |
|
| 723 | + public static function findFiles(string $targetFolder, array $extensions = array(), array $options = array(), array $files = array()) : array |
|
| 724 | 724 | { |
| 725 | 725 | $finder = self::createFileFinder($targetFolder); |
| 726 | 726 | |
| 727 | 727 | $finder->setPathmodeStrip(); |
| 728 | 728 | |
| 729 | - if(isset($options['relative-path']) && $options['relative-path'] === true) |
|
| 729 | + if (isset($options['relative-path']) && $options['relative-path'] === true) |
|
| 730 | 730 | { |
| 731 | 731 | $finder->setPathmodeRelative(); |
| 732 | 732 | } |
| 733 | - else if(isset($options['absolute-path']) && $options['absolute-path'] === true) |
|
| 733 | + else if (isset($options['absolute-path']) && $options['absolute-path'] === true) |
|
| 734 | 734 | { |
| 735 | 735 | $finder->setPathmodeAbsolute(); |
| 736 | 736 | } |
| 737 | 737 | |
| 738 | - if(isset($options['strip-extension'])) |
|
| 738 | + if (isset($options['strip-extension'])) |
|
| 739 | 739 | { |
| 740 | 740 | $finder->stripExtensions(); |
| 741 | 741 | } |
@@ -753,12 +753,12 @@ discard block |
||
| 753 | 753 | * @param bool $keepPath Whether to keep the path component, if any. Default PHP pathinfo behavior is not to. |
| 754 | 754 | * @return string |
| 755 | 755 | */ |
| 756 | - public static function removeExtension(string $filename, bool $keepPath=false) : string |
|
| 756 | + public static function removeExtension(string $filename, bool $keepPath = false) : string |
|
| 757 | 757 | { |
| 758 | 758 | // normalize paths to allow windows style slashes even on nix servers |
| 759 | 759 | $filename = self::normalizePath($filename); |
| 760 | 760 | |
| 761 | - if(!$keepPath) |
|
| 761 | + if (!$keepPath) |
|
| 762 | 762 | { |
| 763 | 763 | return pathinfo($filename, PATHINFO_FILENAME); |
| 764 | 764 | } |
@@ -791,7 +791,7 @@ discard block |
||
| 791 | 791 | public static function detectUTFBom(string $filename) : ?string |
| 792 | 792 | { |
| 793 | 793 | $fp = fopen($filename, 'r'); |
| 794 | - if($fp === false) |
|
| 794 | + if ($fp === false) |
|
| 795 | 795 | { |
| 796 | 796 | throw new FileHelper_Exception( |
| 797 | 797 | 'Cannot open file for reading', |
@@ -806,10 +806,10 @@ discard block |
||
| 806 | 806 | |
| 807 | 807 | $boms = self::getUTFBOMs(); |
| 808 | 808 | |
| 809 | - foreach($boms as $bom => $value) |
|
| 809 | + foreach ($boms as $bom => $value) |
|
| 810 | 810 | { |
| 811 | 811 | $length = mb_strlen($value); |
| 812 | - if(mb_substr($text, 0, $length) == $value) { |
|
| 812 | + if (mb_substr($text, 0, $length) == $value) { |
|
| 813 | 813 | return $bom; |
| 814 | 814 | } |
| 815 | 815 | } |
@@ -828,13 +828,13 @@ discard block |
||
| 828 | 828 | */ |
| 829 | 829 | public static function getUTFBOMs() |
| 830 | 830 | { |
| 831 | - if(!isset(self::$utfBoms)) { |
|
| 831 | + if (!isset(self::$utfBoms)) { |
|
| 832 | 832 | self::$utfBoms = array( |
| 833 | - 'UTF32-BE' => chr(0x00) . chr(0x00) . chr(0xFE) . chr(0xFF), |
|
| 834 | - 'UTF32-LE' => chr(0xFF) . chr(0xFE) . chr(0x00) . chr(0x00), |
|
| 835 | - 'UTF16-BE' => chr(0xFE) . chr(0xFF), |
|
| 836 | - 'UTF16-LE' => chr(0xFF) . chr(0xFE), |
|
| 837 | - 'UTF8' => chr(0xEF) . chr(0xBB) . chr(0xBF) |
|
| 833 | + 'UTF32-BE' => chr(0x00).chr(0x00).chr(0xFE).chr(0xFF), |
|
| 834 | + 'UTF32-LE' => chr(0xFF).chr(0xFE).chr(0x00).chr(0x00), |
|
| 835 | + 'UTF16-BE' => chr(0xFE).chr(0xFF), |
|
| 836 | + 'UTF16-LE' => chr(0xFF).chr(0xFE), |
|
| 837 | + 'UTF8' => chr(0xEF).chr(0xBB).chr(0xBF) |
|
| 838 | 838 | ); |
| 839 | 839 | } |
| 840 | 840 | |
@@ -855,7 +855,7 @@ discard block |
||
| 855 | 855 | $encodings = self::getKnownUnicodeEncodings(); |
| 856 | 856 | |
| 857 | 857 | $keep = array(); |
| 858 | - foreach($encodings as $string) |
|
| 858 | + foreach ($encodings as $string) |
|
| 859 | 859 | { |
| 860 | 860 | $withHyphen = str_replace('UTF', 'UTF-', $string); |
| 861 | 861 | |
@@ -902,16 +902,16 @@ discard block |
||
| 902 | 902 | * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
| 903 | 903 | * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
| 904 | 904 | */ |
| 905 | - public static function saveAsJSON($data, string $file, bool $pretty=false) |
|
| 905 | + public static function saveAsJSON($data, string $file, bool $pretty = false) |
|
| 906 | 906 | { |
| 907 | 907 | $options = null; |
| 908 | - if($pretty) { |
|
| 908 | + if ($pretty) { |
|
| 909 | 909 | $options = JSON_PRETTY_PRINT; |
| 910 | 910 | } |
| 911 | 911 | |
| 912 | 912 | $json = json_encode($data, $options); |
| 913 | 913 | |
| 914 | - if($json===false) |
|
| 914 | + if ($json === false) |
|
| 915 | 915 | { |
| 916 | 916 | $errorCode = json_last_error(); |
| 917 | 917 | |
@@ -937,14 +937,14 @@ discard block |
||
| 937 | 937 | * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
| 938 | 938 | * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
| 939 | 939 | */ |
| 940 | - public static function saveFile(string $filePath, string $content='') : void |
|
| 940 | + public static function saveFile(string $filePath, string $content = '') : void |
|
| 941 | 941 | { |
| 942 | 942 | $filePath = self::normalizePath($filePath); |
| 943 | 943 | |
| 944 | 944 | // target file already exists |
| 945 | - if(file_exists($filePath)) |
|
| 945 | + if (file_exists($filePath)) |
|
| 946 | 946 | { |
| 947 | - if(!is_writable($filePath)) |
|
| 947 | + if (!is_writable($filePath)) |
|
| 948 | 948 | { |
| 949 | 949 | throw new FileHelper_Exception( |
| 950 | 950 | sprintf('Cannot save file: target file [%s] exists, but is not writable.', basename($filePath)), |
@@ -964,7 +964,7 @@ discard block |
||
| 964 | 964 | // create the folder as needed |
| 965 | 965 | self::createFolder($targetFolder); |
| 966 | 966 | |
| 967 | - if(!is_writable($targetFolder)) |
|
| 967 | + if (!is_writable($targetFolder)) |
|
| 968 | 968 | { |
| 969 | 969 | throw new FileHelper_Exception( |
| 970 | 970 | sprintf('Cannot save file: target folder [%s] is not writable.', basename($targetFolder)), |
@@ -977,7 +977,7 @@ discard block |
||
| 977 | 977 | } |
| 978 | 978 | } |
| 979 | 979 | |
| 980 | - if(is_dir($filePath)) |
|
| 980 | + if (is_dir($filePath)) |
|
| 981 | 981 | { |
| 982 | 982 | throw new FileHelper_Exception( |
| 983 | 983 | sprintf('Cannot save file: the target [%s] is a directory.', basename($filePath)), |
@@ -989,7 +989,7 @@ discard block |
||
| 989 | 989 | ); |
| 990 | 990 | } |
| 991 | 991 | |
| 992 | - if(file_put_contents($filePath, $content) !== false) { |
|
| 992 | + if (file_put_contents($filePath, $content) !== false) { |
|
| 993 | 993 | return; |
| 994 | 994 | } |
| 995 | 995 | |
@@ -1027,7 +1027,7 @@ discard block |
||
| 1027 | 1027 | { |
| 1028 | 1028 | static $checked = array(); |
| 1029 | 1029 | |
| 1030 | - if(isset($checked[$command])) { |
|
| 1030 | + if (isset($checked[$command])) { |
|
| 1031 | 1031 | return $checked[$command]; |
| 1032 | 1032 | } |
| 1033 | 1033 | |
@@ -1040,7 +1040,7 @@ discard block |
||
| 1040 | 1040 | |
| 1041 | 1041 | $os = strtolower(PHP_OS_FAMILY); |
| 1042 | 1042 | |
| 1043 | - if(!isset($osCommands[$os])) |
|
| 1043 | + if (!isset($osCommands[$os])) |
|
| 1044 | 1044 | { |
| 1045 | 1045 | throw new FileHelper_Exception( |
| 1046 | 1046 | 'Unsupported OS for CLI commands', |
@@ -1066,7 +1066,7 @@ discard block |
||
| 1066 | 1066 | $pipes |
| 1067 | 1067 | ); |
| 1068 | 1068 | |
| 1069 | - if($process === false) { |
|
| 1069 | + if ($process === false) { |
|
| 1070 | 1070 | $checked[$command] = false; |
| 1071 | 1071 | return false; |
| 1072 | 1072 | } |
@@ -1097,7 +1097,7 @@ discard block |
||
| 1097 | 1097 | */ |
| 1098 | 1098 | public static function checkPHPFileSyntax($path) |
| 1099 | 1099 | { |
| 1100 | - if(!self::canMakePHPCalls()) { |
|
| 1100 | + if (!self::canMakePHPCalls()) { |
|
| 1101 | 1101 | return true; |
| 1102 | 1102 | } |
| 1103 | 1103 | |
@@ -1108,7 +1108,7 @@ discard block |
||
| 1108 | 1108 | // when the validation is successful, the first entry |
| 1109 | 1109 | // in the array contains the success message. When it |
| 1110 | 1110 | // is invalid, the first entry is always empty. |
| 1111 | - if(!empty($output[0])) { |
|
| 1111 | + if (!empty($output[0])) { |
|
| 1112 | 1112 | return true; |
| 1113 | 1113 | } |
| 1114 | 1114 | |
@@ -1129,7 +1129,7 @@ discard block |
||
| 1129 | 1129 | public static function getModifiedDate($path) |
| 1130 | 1130 | { |
| 1131 | 1131 | $time = filemtime($path); |
| 1132 | - if($time !== false) { |
|
| 1132 | + if ($time !== false) { |
|
| 1133 | 1133 | $date = new \DateTime(); |
| 1134 | 1134 | $date->setTimestamp($time); |
| 1135 | 1135 | return $date; |
@@ -1158,7 +1158,7 @@ discard block |
||
| 1158 | 1158 | */ |
| 1159 | 1159 | public static function getSubfolders($targetFolder, $options = array()) |
| 1160 | 1160 | { |
| 1161 | - if(!is_dir($targetFolder)) |
|
| 1161 | + if (!is_dir($targetFolder)) |
|
| 1162 | 1162 | { |
| 1163 | 1163 | throw new FileHelper_Exception( |
| 1164 | 1164 | 'Target folder does not exist', |
@@ -1182,29 +1182,29 @@ discard block |
||
| 1182 | 1182 | |
| 1183 | 1183 | $d = new \DirectoryIterator($targetFolder); |
| 1184 | 1184 | |
| 1185 | - foreach($d as $item) |
|
| 1185 | + foreach ($d as $item) |
|
| 1186 | 1186 | { |
| 1187 | - if($item->isDir() && !$item->isDot()) |
|
| 1187 | + if ($item->isDir() && !$item->isDot()) |
|
| 1188 | 1188 | { |
| 1189 | 1189 | $name = $item->getFilename(); |
| 1190 | 1190 | |
| 1191 | - if(!$options['absolute-path']) { |
|
| 1191 | + if (!$options['absolute-path']) { |
|
| 1192 | 1192 | $result[] = $name; |
| 1193 | 1193 | } else { |
| 1194 | 1194 | $result[] = $targetFolder.'/'.$name; |
| 1195 | 1195 | } |
| 1196 | 1196 | |
| 1197 | - if(!$options['recursive']) |
|
| 1197 | + if (!$options['recursive']) |
|
| 1198 | 1198 | { |
| 1199 | 1199 | continue; |
| 1200 | 1200 | } |
| 1201 | 1201 | |
| 1202 | 1202 | $subs = self::getSubfolders($targetFolder.'/'.$name, $options); |
| 1203 | - foreach($subs as $sub) |
|
| 1203 | + foreach ($subs as $sub) |
|
| 1204 | 1204 | { |
| 1205 | 1205 | $relative = $name.'/'.$sub; |
| 1206 | 1206 | |
| 1207 | - if(!$options['absolute-path']) { |
|
| 1207 | + if (!$options['absolute-path']) { |
|
| 1208 | 1208 | $result[] = $relative; |
| 1209 | 1209 | } else { |
| 1210 | 1210 | $result[] = $targetFolder.'/'.$relative; |
@@ -1254,7 +1254,7 @@ discard block |
||
| 1254 | 1254 | $unit = preg_replace('/[^bkmgtpezy]/i', '', $size); // Remove the non-unit characters from the size. |
| 1255 | 1255 | $size = floatval(preg_replace('/[^0-9\.]/', '', $size)); // Remove the non-numeric characters from the size. |
| 1256 | 1256 | |
| 1257 | - if($unit) |
|
| 1257 | + if ($unit) |
|
| 1258 | 1258 | { |
| 1259 | 1259 | // Find the position of the unit in the ordered string which is the power of magnitude to multiply a kilobyte by. |
| 1260 | 1260 | return round($size * pow(1024, stripos('bkmgtpezy', $unit[0]))); |
@@ -1273,7 +1273,7 @@ discard block |
||
| 1273 | 1273 | * @param int $depth The folder depth to reduce the path to |
| 1274 | 1274 | * @return string |
| 1275 | 1275 | */ |
| 1276 | - public static function relativizePathByDepth(string $path, int $depth=2) : string |
|
| 1276 | + public static function relativizePathByDepth(string $path, int $depth = 2) : string |
|
| 1277 | 1277 | { |
| 1278 | 1278 | $path = self::normalizePath($path); |
| 1279 | 1279 | |
@@ -1281,17 +1281,17 @@ discard block |
||
| 1281 | 1281 | $tokens = array_filter($tokens); // remove empty entries (trailing slash for example) |
| 1282 | 1282 | $tokens = array_values($tokens); // re-index keys |
| 1283 | 1283 | |
| 1284 | - if(empty($tokens)) { |
|
| 1284 | + if (empty($tokens)) { |
|
| 1285 | 1285 | return ''; |
| 1286 | 1286 | } |
| 1287 | 1287 | |
| 1288 | 1288 | // remove the drive if present |
| 1289 | - if(strstr($tokens[0], ':')) { |
|
| 1289 | + if (strstr($tokens[0], ':')) { |
|
| 1290 | 1290 | array_shift($tokens); |
| 1291 | 1291 | } |
| 1292 | 1292 | |
| 1293 | 1293 | // path was only the drive |
| 1294 | - if(count($tokens) == 0) { |
|
| 1294 | + if (count($tokens) == 0) { |
|
| 1295 | 1295 | return ''; |
| 1296 | 1296 | } |
| 1297 | 1297 | |
@@ -1300,8 +1300,8 @@ discard block |
||
| 1300 | 1300 | |
| 1301 | 1301 | // reduce the path to the specified depth |
| 1302 | 1302 | $length = count($tokens); |
| 1303 | - if($length > $depth) { |
|
| 1304 | - $tokens = array_slice($tokens, $length-$depth); |
|
| 1303 | + if ($length > $depth) { |
|
| 1304 | + $tokens = array_slice($tokens, $length - $depth); |
|
| 1305 | 1305 | } |
| 1306 | 1306 | |
| 1307 | 1307 | // append the last element again |
@@ -1349,14 +1349,14 @@ discard block |
||
| 1349 | 1349 | * |
| 1350 | 1350 | * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
| 1351 | 1351 | */ |
| 1352 | - public static function requireFileExists(string $path, $errorCode=null) : string |
|
| 1352 | + public static function requireFileExists(string $path, $errorCode = null) : string |
|
| 1353 | 1353 | { |
| 1354 | 1354 | $result = realpath($path); |
| 1355 | - if($result !== false) { |
|
| 1355 | + if ($result !== false) { |
|
| 1356 | 1356 | return $result; |
| 1357 | 1357 | } |
| 1358 | 1358 | |
| 1359 | - if($errorCode === null) { |
|
| 1359 | + if ($errorCode === null) { |
|
| 1360 | 1360 | $errorCode = self::ERROR_FILE_DOES_NOT_EXIST; |
| 1361 | 1361 | } |
| 1362 | 1362 | |
@@ -1385,15 +1385,15 @@ discard block |
||
| 1385 | 1385 | |
| 1386 | 1386 | $file = new \SplFileObject($path); |
| 1387 | 1387 | |
| 1388 | - if($file->eof()) { |
|
| 1388 | + if ($file->eof()) { |
|
| 1389 | 1389 | return ''; |
| 1390 | 1390 | } |
| 1391 | 1391 | |
| 1392 | - $targetLine = $lineNumber-1; |
|
| 1392 | + $targetLine = $lineNumber - 1; |
|
| 1393 | 1393 | |
| 1394 | 1394 | $file->seek($targetLine); |
| 1395 | 1395 | |
| 1396 | - if($file->key() !== $targetLine) { |
|
| 1396 | + if ($file->key() !== $targetLine) { |
|
| 1397 | 1397 | return null; |
| 1398 | 1398 | } |
| 1399 | 1399 | |
@@ -1419,7 +1419,7 @@ discard block |
||
| 1419 | 1419 | $number = $spl->key(); |
| 1420 | 1420 | |
| 1421 | 1421 | // if seeking to the end the cursor is still at 0, there are no lines. |
| 1422 | - if($number === 0) |
|
| 1422 | + if ($number === 0) |
|
| 1423 | 1423 | { |
| 1424 | 1424 | // since it's a very small file, to get reliable results, |
| 1425 | 1425 | // we read its contents and use that to determine what |
@@ -1427,13 +1427,13 @@ discard block |
||
| 1427 | 1427 | // that this is not pactical to solve with the SplFileObject. |
| 1428 | 1428 | $content = file_get_contents($path); |
| 1429 | 1429 | |
| 1430 | - if(empty($content)) { |
|
| 1430 | + if (empty($content)) { |
|
| 1431 | 1431 | return 0; |
| 1432 | 1432 | } |
| 1433 | 1433 | } |
| 1434 | 1434 | |
| 1435 | 1435 | // return the line number we were able to reach + 1 (key is zero-based) |
| 1436 | - return $number+1; |
|
| 1436 | + return $number + 1; |
|
| 1437 | 1437 | } |
| 1438 | 1438 | |
| 1439 | 1439 | /** |
@@ -1480,13 +1480,13 @@ discard block |
||
| 1480 | 1480 | * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES |
| 1481 | 1481 | * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
| 1482 | 1482 | */ |
| 1483 | - public static function readLines(string $filePath, int $amount=0) : array |
|
| 1483 | + public static function readLines(string $filePath, int $amount = 0) : array |
|
| 1484 | 1484 | { |
| 1485 | 1485 | self::requireFileExists($filePath); |
| 1486 | 1486 | |
| 1487 | 1487 | $fn = fopen($filePath, "r"); |
| 1488 | 1488 | |
| 1489 | - if($fn === false) |
|
| 1489 | + if ($fn === false) |
|
| 1490 | 1490 | { |
| 1491 | 1491 | throw new FileHelper_Exception( |
| 1492 | 1492 | 'Could not open file for reading.', |
@@ -1502,19 +1502,19 @@ discard block |
||
| 1502 | 1502 | $counter = 0; |
| 1503 | 1503 | $first = true; |
| 1504 | 1504 | |
| 1505 | - while(!feof($fn)) |
|
| 1505 | + while (!feof($fn)) |
|
| 1506 | 1506 | { |
| 1507 | 1507 | $counter++; |
| 1508 | 1508 | |
| 1509 | 1509 | $line = fgets($fn); |
| 1510 | 1510 | |
| 1511 | 1511 | // can happen with zero length files |
| 1512 | - if($line === false) { |
|
| 1512 | + if ($line === false) { |
|
| 1513 | 1513 | continue; |
| 1514 | 1514 | } |
| 1515 | 1515 | |
| 1516 | 1516 | // the first line may contain a unicode BOM marker. |
| 1517 | - if($first) |
|
| 1517 | + if ($first) |
|
| 1518 | 1518 | { |
| 1519 | 1519 | $line = ConvertHelper::stripUTFBom($line); |
| 1520 | 1520 | $first = false; |
@@ -1522,7 +1522,7 @@ discard block |
||
| 1522 | 1522 | |
| 1523 | 1523 | $result[] = $line; |
| 1524 | 1524 | |
| 1525 | - if($amount > 0 && $counter == $amount) { |
|
| 1525 | + if ($amount > 0 && $counter == $amount) { |
|
| 1526 | 1526 | break; |
| 1527 | 1527 | } |
| 1528 | 1528 | } |
@@ -1548,7 +1548,7 @@ discard block |
||
| 1548 | 1548 | |
| 1549 | 1549 | $result = file_get_contents($filePath); |
| 1550 | 1550 | |
| 1551 | - if($result !== false) { |
|
| 1551 | + if ($result !== false) { |
|
| 1552 | 1552 | return $result; |
| 1553 | 1553 | } |
| 1554 | 1554 | |
@@ -1578,7 +1578,7 @@ discard block |
||
| 1578 | 1578 | { |
| 1579 | 1579 | $actual = realpath($path); |
| 1580 | 1580 | |
| 1581 | - if($actual === false) |
|
| 1581 | + if ($actual === false) |
|
| 1582 | 1582 | { |
| 1583 | 1583 | throw new FileHelper_Exception( |
| 1584 | 1584 | 'Folder does not exist', |
@@ -1590,7 +1590,7 @@ discard block |
||
| 1590 | 1590 | ); |
| 1591 | 1591 | } |
| 1592 | 1592 | |
| 1593 | - if(is_dir($path)) |
|
| 1593 | + if (is_dir($path)) |
|
| 1594 | 1594 | { |
| 1595 | 1595 | return self::normalizePath($actual); |
| 1596 | 1596 | } |
@@ -32,62 +32,62 @@ discard block |
||
| 32 | 32 | const ERROR_CURL_INIT_FAILED = 17903; |
| 33 | 33 | const ERROR_CANNOT_OPEN_LOGFILE = 17904; |
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * @var string |
|
| 37 | - */ |
|
| 35 | + /** |
|
| 36 | + * @var string |
|
| 37 | + */ |
|
| 38 | 38 | protected $eol = "\r\n"; |
| 39 | 39 | |
| 40 | - /** |
|
| 41 | - * @var string |
|
| 42 | - */ |
|
| 40 | + /** |
|
| 41 | + * @var string |
|
| 42 | + */ |
|
| 43 | 43 | protected $mimeBoundary; |
| 44 | 44 | |
| 45 | - /** |
|
| 46 | - * @var string |
|
| 47 | - */ |
|
| 45 | + /** |
|
| 46 | + * @var string |
|
| 47 | + */ |
|
| 48 | 48 | protected $destination; |
| 49 | 49 | |
| 50 | - /** |
|
| 51 | - * @var array<string,string> |
|
| 52 | - */ |
|
| 50 | + /** |
|
| 51 | + * @var array<string,string> |
|
| 52 | + */ |
|
| 53 | 53 | protected $headers = array(); |
| 54 | 54 | |
| 55 | - /** |
|
| 56 | - * Whether to verify SSL certificates. |
|
| 57 | - * @var bool |
|
| 58 | - */ |
|
| 55 | + /** |
|
| 56 | + * Whether to verify SSL certificates. |
|
| 57 | + * @var bool |
|
| 58 | + */ |
|
| 59 | 59 | protected $verifySSL = true; |
| 60 | 60 | |
| 61 | - /** |
|
| 62 | - * @var RequestHelper_Boundaries |
|
| 63 | - */ |
|
| 61 | + /** |
|
| 62 | + * @var RequestHelper_Boundaries |
|
| 63 | + */ |
|
| 64 | 64 | protected $boundaries; |
| 65 | 65 | |
| 66 | - /** |
|
| 67 | - * @var RequestHelper_Response|NULL |
|
| 68 | - */ |
|
| 66 | + /** |
|
| 67 | + * @var RequestHelper_Response|NULL |
|
| 68 | + */ |
|
| 69 | 69 | protected $response; |
| 70 | 70 | |
| 71 | - /** |
|
| 72 | - * Timeout duration, in seconds. |
|
| 73 | - * @var integer |
|
| 74 | - */ |
|
| 71 | + /** |
|
| 72 | + * Timeout duration, in seconds. |
|
| 73 | + * @var integer |
|
| 74 | + */ |
|
| 75 | 75 | protected $timeout = 30; |
| 76 | 76 | |
| 77 | - /** |
|
| 78 | - * @var string |
|
| 79 | - */ |
|
| 77 | + /** |
|
| 78 | + * @var string |
|
| 79 | + */ |
|
| 80 | 80 | protected $logfile = ''; |
| 81 | 81 | |
| 82 | - /** |
|
| 83 | - * @var resource|NULL |
|
| 84 | - */ |
|
| 82 | + /** |
|
| 83 | + * @var resource|NULL |
|
| 84 | + */ |
|
| 85 | 85 | protected $logfilePointer = null; |
| 86 | 86 | |
| 87 | - /** |
|
| 88 | - * Creates a new request helper to send POST data to the specified destination URL. |
|
| 89 | - * @param string $destinationURL |
|
| 90 | - */ |
|
| 87 | + /** |
|
| 88 | + * Creates a new request helper to send POST data to the specified destination URL. |
|
| 89 | + * @param string $destinationURL |
|
| 90 | + */ |
|
| 91 | 91 | public function __construct(string $destinationURL) |
| 92 | 92 | { |
| 93 | 93 | $this->destination = $destinationURL; |
@@ -112,13 +112,13 @@ discard block |
||
| 112 | 112 | return $this->eol; |
| 113 | 113 | } |
| 114 | 114 | |
| 115 | - /** |
|
| 116 | - * Sets the timeout for the request, in seconds. If the request |
|
| 117 | - * takes longer, it will be cancelled and an exception triggered. |
|
| 118 | - * |
|
| 119 | - * @param int $seconds |
|
| 120 | - * @return RequestHelper |
|
| 121 | - */ |
|
| 115 | + /** |
|
| 116 | + * Sets the timeout for the request, in seconds. If the request |
|
| 117 | + * takes longer, it will be cancelled and an exception triggered. |
|
| 118 | + * |
|
| 119 | + * @param int $seconds |
|
| 120 | + * @return RequestHelper |
|
| 121 | + */ |
|
| 122 | 122 | public function setTimeout(int $seconds) : RequestHelper |
| 123 | 123 | { |
| 124 | 124 | $this->timeout = $seconds; |
@@ -131,13 +131,13 @@ discard block |
||
| 131 | 131 | return $this->timeout; |
| 132 | 132 | } |
| 133 | 133 | |
| 134 | - /** |
|
| 135 | - * Enables verbose logging of the CURL request, which |
|
| 136 | - * is then redirected to the target file. |
|
| 137 | - * |
|
| 138 | - * @param string $targetFile |
|
| 139 | - * @return RequestHelper |
|
| 140 | - */ |
|
| 134 | + /** |
|
| 135 | + * Enables verbose logging of the CURL request, which |
|
| 136 | + * is then redirected to the target file. |
|
| 137 | + * |
|
| 138 | + * @param string $targetFile |
|
| 139 | + * @return RequestHelper |
|
| 140 | + */ |
|
| 141 | 141 | public function enableLogging(string $targetFile) : RequestHelper |
| 142 | 142 | { |
| 143 | 143 | $this->logfile = $targetFile; |
@@ -145,15 +145,15 @@ discard block |
||
| 145 | 145 | return $this; |
| 146 | 146 | } |
| 147 | 147 | |
| 148 | - /** |
|
| 149 | - * Adds a file to be sent with the request. |
|
| 150 | - * |
|
| 151 | - * @param string $varName The variable name to send the file in |
|
| 152 | - * @param string $fileName The name of the file as it should be received at the destination |
|
| 153 | - * @param string $content The raw content of the file |
|
| 154 | - * @param string $contentType The content type, use the constants to specify this |
|
| 155 | - * @param string $encoding The encoding of the file, use the constants to specify this |
|
| 156 | - */ |
|
| 148 | + /** |
|
| 149 | + * Adds a file to be sent with the request. |
|
| 150 | + * |
|
| 151 | + * @param string $varName The variable name to send the file in |
|
| 152 | + * @param string $fileName The name of the file as it should be received at the destination |
|
| 153 | + * @param string $content The raw content of the file |
|
| 154 | + * @param string $contentType The content type, use the constants to specify this |
|
| 155 | + * @param string $encoding The encoding of the file, use the constants to specify this |
|
| 156 | + */ |
|
| 157 | 157 | public function addFile(string $varName, string $fileName, string $content, string $contentType = '', string $encoding = '') : RequestHelper |
| 158 | 158 | { |
| 159 | 159 | $this->boundaries->addFile($varName, $fileName, $content, $contentType, $encoding); |
@@ -161,13 +161,13 @@ discard block |
||
| 161 | 161 | return $this; |
| 162 | 162 | } |
| 163 | 163 | |
| 164 | - /** |
|
| 165 | - * Adds arbitrary content. |
|
| 166 | - * |
|
| 167 | - * @param string $varName The variable name to send the content in. |
|
| 168 | - * @param string $content |
|
| 169 | - * @param string $contentType |
|
| 170 | - */ |
|
| 164 | + /** |
|
| 165 | + * Adds arbitrary content. |
|
| 166 | + * |
|
| 167 | + * @param string $varName The variable name to send the content in. |
|
| 168 | + * @param string $content |
|
| 169 | + * @param string $contentType |
|
| 170 | + */ |
|
| 171 | 171 | public function addContent(string $varName, string $content, string $contentType) : RequestHelper |
| 172 | 172 | { |
| 173 | 173 | $this->boundaries->addContent($varName, $content, $contentType); |
@@ -175,13 +175,13 @@ discard block |
||
| 175 | 175 | return $this; |
| 176 | 176 | } |
| 177 | 177 | |
| 178 | - /** |
|
| 179 | - * Adds a variable to be sent with the request. If it |
|
| 180 | - * already exists, its value is overwritten. |
|
| 181 | - * |
|
| 182 | - * @param string $name |
|
| 183 | - * @param string $value |
|
| 184 | - */ |
|
| 178 | + /** |
|
| 179 | + * Adds a variable to be sent with the request. If it |
|
| 180 | + * already exists, its value is overwritten. |
|
| 181 | + * |
|
| 182 | + * @param string $name |
|
| 183 | + * @param string $value |
|
| 184 | + */ |
|
| 185 | 185 | public function addVariable(string $name, string $value) : RequestHelper |
| 186 | 186 | { |
| 187 | 187 | $this->boundaries->addVariable($name, $value); |
@@ -189,13 +189,13 @@ discard block |
||
| 189 | 189 | return $this; |
| 190 | 190 | } |
| 191 | 191 | |
| 192 | - /** |
|
| 193 | - * Sets an HTTP header to include in the request. |
|
| 194 | - * |
|
| 195 | - * @param string $name |
|
| 196 | - * @param string $value |
|
| 197 | - * @return RequestHelper |
|
| 198 | - */ |
|
| 192 | + /** |
|
| 193 | + * Sets an HTTP header to include in the request. |
|
| 194 | + * |
|
| 195 | + * @param string $name |
|
| 196 | + * @param string $value |
|
| 197 | + * @return RequestHelper |
|
| 198 | + */ |
|
| 199 | 199 | public function setHeader(string $name, string $value) : RequestHelper |
| 200 | 200 | { |
| 201 | 201 | $this->headers[$name] = $value; |
@@ -203,36 +203,36 @@ discard block |
||
| 203 | 203 | return $this; |
| 204 | 204 | } |
| 205 | 205 | |
| 206 | - /** |
|
| 207 | - * Disables SSL certificate checking. |
|
| 208 | - * |
|
| 209 | - * @return RequestHelper |
|
| 210 | - */ |
|
| 206 | + /** |
|
| 207 | + * Disables SSL certificate checking. |
|
| 208 | + * |
|
| 209 | + * @return RequestHelper |
|
| 210 | + */ |
|
| 211 | 211 | public function disableSSLChecks() : RequestHelper |
| 212 | 212 | { |
| 213 | 213 | $this->verifySSL = false; |
| 214 | 214 | return $this; |
| 215 | 215 | } |
| 216 | 216 | |
| 217 | - /** |
|
| 218 | - * @var integer |
|
| 219 | - */ |
|
| 217 | + /** |
|
| 218 | + * @var integer |
|
| 219 | + */ |
|
| 220 | 220 | protected $contentLength = 0; |
| 221 | 221 | |
| 222 | - /** |
|
| 223 | - * Sends the POST request to the destination, and returns |
|
| 224 | - * the response text. |
|
| 225 | - * |
|
| 226 | - * The response object is stored internally, so after calling |
|
| 227 | - * this method it may be retrieved at any moment using the |
|
| 228 | - * {@link getResponse()} method. |
|
| 229 | - * |
|
| 230 | - * @return string |
|
| 231 | - * @see RequestHelper::getResponse() |
|
| 232 | - * @throws RequestHelper_Exception |
|
| 233 | - * |
|
| 234 | - * @see RequestHelper::ERROR_REQUEST_FAILED |
|
| 235 | - */ |
|
| 222 | + /** |
|
| 223 | + * Sends the POST request to the destination, and returns |
|
| 224 | + * the response text. |
|
| 225 | + * |
|
| 226 | + * The response object is stored internally, so after calling |
|
| 227 | + * this method it may be retrieved at any moment using the |
|
| 228 | + * {@link getResponse()} method. |
|
| 229 | + * |
|
| 230 | + * @return string |
|
| 231 | + * @see RequestHelper::getResponse() |
|
| 232 | + * @throws RequestHelper_Exception |
|
| 233 | + * |
|
| 234 | + * @see RequestHelper::ERROR_REQUEST_FAILED |
|
| 235 | + */ |
|
| 236 | 236 | public function send() : string |
| 237 | 237 | { |
| 238 | 238 | $info = parseURL($this->destination); |
@@ -277,14 +277,14 @@ discard block |
||
| 277 | 277 | return $this->data; |
| 278 | 278 | } |
| 279 | 279 | |
| 280 | - /** |
|
| 281 | - * Creates a new CURL resource configured according to the |
|
| 282 | - * request's settings. |
|
| 283 | - * |
|
| 284 | - * @param URLInfo $url |
|
| 285 | - * @throws RequestHelper_Exception |
|
| 286 | - * @return resource |
|
| 287 | - */ |
|
| 280 | + /** |
|
| 281 | + * Creates a new CURL resource configured according to the |
|
| 282 | + * request's settings. |
|
| 283 | + * |
|
| 284 | + * @param URLInfo $url |
|
| 285 | + * @throws RequestHelper_Exception |
|
| 286 | + * @return resource |
|
| 287 | + */ |
|
| 288 | 288 | protected function createCURL(URLInfo $url) |
| 289 | 289 | { |
| 290 | 290 | $ch = curl_init(); |
@@ -332,10 +332,10 @@ discard block |
||
| 332 | 332 | return $ch; |
| 333 | 333 | } |
| 334 | 334 | |
| 335 | - /** |
|
| 336 | - * @param resource $ch |
|
| 337 | - * @return bool Whether logging is enabled. |
|
| 338 | - */ |
|
| 335 | + /** |
|
| 336 | + * @param resource $ch |
|
| 337 | + * @return bool Whether logging is enabled. |
|
| 338 | + */ |
|
| 339 | 339 | protected function configureLogging($ch) : bool |
| 340 | 340 | { |
| 341 | 341 | if(empty($this->logfile)) |
@@ -362,13 +362,13 @@ discard block |
||
| 362 | 362 | return true; |
| 363 | 363 | } |
| 364 | 364 | |
| 365 | - /** |
|
| 366 | - * Compiles the associative headers array into |
|
| 367 | - * the format understood by CURL, namely an indexed |
|
| 368 | - * array with one header string per entry. |
|
| 369 | - * |
|
| 370 | - * @return array |
|
| 371 | - */ |
|
| 365 | + /** |
|
| 366 | + * Compiles the associative headers array into |
|
| 367 | + * the format understood by CURL, namely an indexed |
|
| 368 | + * array with one header string per entry. |
|
| 369 | + * |
|
| 370 | + * @return array |
|
| 371 | + */ |
|
| 372 | 372 | protected function renderHeaders() : array |
| 373 | 373 | { |
| 374 | 374 | $result = array(); |
@@ -382,12 +382,12 @@ discard block |
||
| 382 | 382 | return $result; |
| 383 | 383 | } |
| 384 | 384 | |
| 385 | - /** |
|
| 386 | - * Retrieves the raw response header, in the form of an indexed |
|
| 387 | - * array containing all response header lines. |
|
| 388 | - * |
|
| 389 | - * @return array |
|
| 390 | - */ |
|
| 385 | + /** |
|
| 386 | + * Retrieves the raw response header, in the form of an indexed |
|
| 387 | + * array containing all response header lines. |
|
| 388 | + * |
|
| 389 | + * @return array |
|
| 390 | + */ |
|
| 391 | 391 | public function getResponseHeader() : array |
| 392 | 392 | { |
| 393 | 393 | $response = $this->getResponse(); |
@@ -399,33 +399,33 @@ discard block |
||
| 399 | 399 | return array(); |
| 400 | 400 | } |
| 401 | 401 | |
| 402 | - /** |
|
| 403 | - * After calling the {@link send()} method, this may be used to |
|
| 404 | - * retrieve the response text from the POST request. |
|
| 405 | - * |
|
| 406 | - * @return RequestHelper_Response|NULL |
|
| 407 | - */ |
|
| 402 | + /** |
|
| 403 | + * After calling the {@link send()} method, this may be used to |
|
| 404 | + * retrieve the response text from the POST request. |
|
| 405 | + * |
|
| 406 | + * @return RequestHelper_Response|NULL |
|
| 407 | + */ |
|
| 408 | 408 | public function getResponse() : ?RequestHelper_Response |
| 409 | 409 | { |
| 410 | 410 | return $this->response; |
| 411 | 411 | } |
| 412 | 412 | |
| 413 | - /** |
|
| 414 | - * Retrieves all headers set until now. |
|
| 415 | - * |
|
| 416 | - * @return array<string,string> |
|
| 417 | - */ |
|
| 413 | + /** |
|
| 414 | + * Retrieves all headers set until now. |
|
| 415 | + * |
|
| 416 | + * @return array<string,string> |
|
| 417 | + */ |
|
| 418 | 418 | public function getHeaders() : array |
| 419 | 419 | { |
| 420 | 420 | return $this->headers; |
| 421 | 421 | } |
| 422 | 422 | |
| 423 | - /** |
|
| 424 | - * Retrieves the value of a header by its name. |
|
| 425 | - * |
|
| 426 | - * @param string $name |
|
| 427 | - * @return string The header value, or an empty string if not set. |
|
| 428 | - */ |
|
| 423 | + /** |
|
| 424 | + * Retrieves the value of a header by its name. |
|
| 425 | + * |
|
| 426 | + * @param string $name |
|
| 427 | + * @return string The header value, or an empty string if not set. |
|
| 428 | + */ |
|
| 429 | 429 | public function getHeader(string $name) : string |
| 430 | 430 | { |
| 431 | 431 | if(isset($this->headers[$name])) |
@@ -241,7 +241,7 @@ discard block |
||
| 241 | 241 | |
| 242 | 242 | $output = curl_exec($ch); |
| 243 | 243 | |
| 244 | - if(isset($this->logfilePointer)) |
|
| 244 | + if (isset($this->logfilePointer)) |
|
| 245 | 245 | { |
| 246 | 246 | fclose($this->logfilePointer); |
| 247 | 247 | } |
@@ -253,7 +253,7 @@ discard block |
||
| 253 | 253 | // CURL will complain about an empty response when the |
| 254 | 254 | // server sends a 100-continue code. That should not be |
| 255 | 255 | // regarded as an error. |
| 256 | - if($output === false && $this->response->getCode() !== 100) |
|
| 256 | + if ($output === false && $this->response->getCode() !== 100) |
|
| 257 | 257 | { |
| 258 | 258 | $curlCode = curl_errno($ch); |
| 259 | 259 | |
@@ -289,7 +289,7 @@ discard block |
||
| 289 | 289 | { |
| 290 | 290 | $ch = curl_init(); |
| 291 | 291 | |
| 292 | - if(!is_resource($ch)) |
|
| 292 | + if (!is_resource($ch)) |
|
| 293 | 293 | { |
| 294 | 294 | throw new RequestHelper_Exception( |
| 295 | 295 | 'Could not initialize a new cURL instance.', |
@@ -299,7 +299,7 @@ discard block |
||
| 299 | 299 | } |
| 300 | 300 | |
| 301 | 301 | $this->setHeader('Content-Length', (string)$this->boundaries->getContentLength()); |
| 302 | - $this->setHeader('Content-Type', 'multipart/form-data; boundary=' . $this->mimeBoundary); |
|
| 302 | + $this->setHeader('Content-Type', 'multipart/form-data; boundary='.$this->mimeBoundary); |
|
| 303 | 303 | |
| 304 | 304 | curl_setopt($ch, CURLOPT_POST, true); |
| 305 | 305 | curl_setopt($ch, CURLOPT_URL, $url->getNormalizedWithoutAuth()); |
@@ -312,18 +312,18 @@ discard block |
||
| 312 | 312 | |
| 313 | 313 | $loggingEnabled = $this->configureLogging($ch); |
| 314 | 314 | |
| 315 | - if(!$loggingEnabled) |
|
| 315 | + if (!$loggingEnabled) |
|
| 316 | 316 | { |
| 317 | 317 | curl_setopt($ch, CURLINFO_HEADER_OUT, true); |
| 318 | 318 | } |
| 319 | 319 | |
| 320 | - if($this->verifySSL) |
|
| 320 | + if ($this->verifySSL) |
|
| 321 | 321 | { |
| 322 | 322 | curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false); |
| 323 | 323 | curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); |
| 324 | 324 | } |
| 325 | 325 | |
| 326 | - if($url->hasUsername()) |
|
| 326 | + if ($url->hasUsername()) |
|
| 327 | 327 | { |
| 328 | 328 | curl_setopt($ch, CURLOPT_USERNAME, $url->getUsername()); |
| 329 | 329 | curl_setopt($ch, CURLOPT_PASSWORD, $url->getPassword()); |
@@ -338,14 +338,14 @@ discard block |
||
| 338 | 338 | */ |
| 339 | 339 | protected function configureLogging($ch) : bool |
| 340 | 340 | { |
| 341 | - if(empty($this->logfile)) |
|
| 341 | + if (empty($this->logfile)) |
|
| 342 | 342 | { |
| 343 | 343 | return false; |
| 344 | 344 | } |
| 345 | 345 | |
| 346 | 346 | $res = fopen($this->logfile, 'w+'); |
| 347 | 347 | |
| 348 | - if($res === false) |
|
| 348 | + if ($res === false) |
|
| 349 | 349 | { |
| 350 | 350 | throw new RequestHelper_Exception( |
| 351 | 351 | 'Cannot open logfile for writing.', |
@@ -375,7 +375,7 @@ discard block |
||
| 375 | 375 | |
| 376 | 376 | $this->setHeader('Expect', ''); |
| 377 | 377 | |
| 378 | - foreach($this->headers as $name => $value) { |
|
| 378 | + foreach ($this->headers as $name => $value) { |
|
| 379 | 379 | $result[] = $name.': '.$value; |
| 380 | 380 | } |
| 381 | 381 | |
@@ -392,7 +392,7 @@ discard block |
||
| 392 | 392 | { |
| 393 | 393 | $response = $this->getResponse(); |
| 394 | 394 | |
| 395 | - if($response !== null) { |
|
| 395 | + if ($response !== null) { |
|
| 396 | 396 | return $response->getHeaders(); |
| 397 | 397 | } |
| 398 | 398 | |
@@ -428,7 +428,7 @@ discard block |
||
| 428 | 428 | */ |
| 429 | 429 | public function getHeader(string $name) : string |
| 430 | 430 | { |
| 431 | - if(isset($this->headers[$name])) |
|
| 431 | + if (isset($this->headers[$name])) |
|
| 432 | 432 | { |
| 433 | 433 | return $this->headers[$name]; |
| 434 | 434 | } |
@@ -261,8 +261,7 @@ |
||
| 261 | 261 | $curlCode, |
| 262 | 262 | curl_error($ch).' | Explanation: '.curl_strerror($curlCode) |
| 263 | 263 | ); |
| 264 | - } |
|
| 265 | - else |
|
| 264 | + } else |
|
| 266 | 265 | { |
| 267 | 266 | $this->response->setBody((string)$output); |
| 268 | 267 | } |