| 1 |
<?php |
| 2 |
|
| 3 |
declare(strict_types=1); |
| 4 |
|
| 5 |
namespace League\Flysystem; |
| 6 |
|
| 7 |
interface FilesystemAdapter |
| 8 |
{ |
| 9 |
/** |
| 10 |
* @throws FilesystemException |
| 11 |
* @throws UnableToCheckExistence |
| 12 |
*/ |
| 13 |
public function fileExists(string $path): bool; |
| 14 |
|
| 15 |
/** |
| 16 |
* @throws FilesystemException |
| 17 |
* @throws UnableToCheckExistence |
| 18 |
*/ |
| 19 |
public function directoryExists(string $path): bool; |
| 20 |
|
| 21 |
/** |
| 22 |
* @throws UnableToWriteFile |
| 23 |
* @throws FilesystemException |
| 24 |
*/ |
| 25 |
public function write(string $path, string $contents, Config $config): void; |
| 26 |
|
| 27 |
/** |
| 28 |
* @param resource $contents |
| 29 |
* |
| 30 |
* @throws UnableToWriteFile |
| 31 |
* @throws FilesystemException |
| 32 |
*/ |
| 33 |
public function writeStream(string $path, $contents, Config $config): void; |
| 34 |
|
| 35 |
/** |
| 36 |
* @throws UnableToReadFile |
| 37 |
* @throws FilesystemException |
| 38 |
*/ |
| 39 |
public function read(string $path): string; |
| 40 |
|
| 41 |
/** |
| 42 |
* @return resource |
| 43 |
* |
| 44 |
* @throws UnableToReadFile |
| 45 |
* @throws FilesystemException |
| 46 |
*/ |
| 47 |
public function readStream(string $path); |
| 48 |
|
| 49 |
/** |
| 50 |
* @throws UnableToDeleteFile |
| 51 |
* @throws FilesystemException |
| 52 |
*/ |
| 53 |
public function delete(string $path): void; |
| 54 |
|
| 55 |
/** |
| 56 |
* @throws UnableToDeleteDirectory |
| 57 |
* @throws FilesystemException |
| 58 |
*/ |
| 59 |
public function deleteDirectory(string $path): void; |
| 60 |
|
| 61 |
/** |
| 62 |
* @throws UnableToCreateDirectory |
| 63 |
* @throws FilesystemException |
| 64 |
*/ |
| 65 |
public function createDirectory(string $path, Config $config): void; |
| 66 |
|
| 67 |
/** |
| 68 |
* @throws InvalidVisibilityProvided |
| 69 |
* @throws FilesystemException |
| 70 |
*/ |
| 71 |
public function setVisibility(string $path, string $visibility): void; |
| 72 |
|
| 73 |
/** |
| 74 |
* @throws UnableToRetrieveMetadata |
| 75 |
* @throws FilesystemException |
| 76 |
*/ |
| 77 |
public function visibility(string $path): FileAttributes; |
| 78 |
|
| 79 |
/** |
| 80 |
* @throws UnableToRetrieveMetadata |
| 81 |
* @throws FilesystemException |
| 82 |
*/ |
| 83 |
public function mimeType(string $path): FileAttributes; |
| 84 |
|
| 85 |
/** |
| 86 |
* @throws UnableToRetrieveMetadata |
| 87 |
* @throws FilesystemException |
| 88 |
*/ |
| 89 |
public function lastModified(string $path): FileAttributes; |
| 90 |
|
| 91 |
/** |
| 92 |
* @throws UnableToRetrieveMetadata |
| 93 |
* @throws FilesystemException |
| 94 |
*/ |
| 95 |
public function fileSize(string $path): FileAttributes; |
| 96 |
|
| 97 |
/** |
| 98 |
* @return iterable<StorageAttributes> |
| 99 |
* |
| 100 |
* @throws FilesystemException |
| 101 |
*/ |
| 102 |
public function listContents(string $path, bool $deep): iterable; |
| 103 |
|
| 104 |
/** |
| 105 |
* @throws UnableToMoveFile |
| 106 |
* @throws FilesystemException |
| 107 |
*/ |
| 108 |
public function move(string $source, string $destination, Config $config): void; |
| 109 |
|
| 110 |
/** |
| 111 |
* @throws UnableToCopyFile |
| 112 |
* @throws FilesystemException |
| 113 |
*/ |
| 114 |
public function copy(string $source, string $destination, Config $config): void; |
| 115 |
} |
| 116 |
|