Cloud.php
2 years ago
Factory.php
2 years ago
FileExistsException.php
2 years ago
FileNotFoundException.php
2 years ago
Filesystem.php
2 years ago
LockTimeoutException.php
2 years ago
Filesystem.php
179 lines
| 1 | <?php |
| 2 | |
| 3 | namespace IAWPSCOPED\Illuminate\Contracts\Filesystem; |
| 4 | |
| 5 | /** @internal */ |
| 6 | interface Filesystem |
| 7 | { |
| 8 | /** |
| 9 | * The public visibility setting. |
| 10 | * |
| 11 | * @var string |
| 12 | */ |
| 13 | const VISIBILITY_PUBLIC = 'public'; |
| 14 | /** |
| 15 | * The private visibility setting. |
| 16 | * |
| 17 | * @var string |
| 18 | */ |
| 19 | const VISIBILITY_PRIVATE = 'private'; |
| 20 | /** |
| 21 | * Determine if a file exists. |
| 22 | * |
| 23 | * @param string $path |
| 24 | * @return bool |
| 25 | */ |
| 26 | public function exists($path); |
| 27 | /** |
| 28 | * Get the contents of a file. |
| 29 | * |
| 30 | * @param string $path |
| 31 | * @return string |
| 32 | * |
| 33 | * @throws \Illuminate\Contracts\Filesystem\FileNotFoundException |
| 34 | */ |
| 35 | public function get($path); |
| 36 | /** |
| 37 | * Get a resource to read the file. |
| 38 | * |
| 39 | * @param string $path |
| 40 | * @return resource|null The path resource or null on failure. |
| 41 | * |
| 42 | * @throws \Illuminate\Contracts\Filesystem\FileNotFoundException |
| 43 | */ |
| 44 | public function readStream($path); |
| 45 | /** |
| 46 | * Write the contents of a file. |
| 47 | * |
| 48 | * @param string $path |
| 49 | * @param string|resource $contents |
| 50 | * @param mixed $options |
| 51 | * @return bool |
| 52 | */ |
| 53 | public function put($path, $contents, $options = []); |
| 54 | /** |
| 55 | * Write a new file using a stream. |
| 56 | * |
| 57 | * @param string $path |
| 58 | * @param resource $resource |
| 59 | * @param array $options |
| 60 | * @return bool |
| 61 | * |
| 62 | * @throws \InvalidArgumentException If $resource is not a file handle. |
| 63 | * @throws \Illuminate\Contracts\Filesystem\FileExistsException |
| 64 | */ |
| 65 | public function writeStream($path, $resource, array $options = []); |
| 66 | /** |
| 67 | * Get the visibility for the given path. |
| 68 | * |
| 69 | * @param string $path |
| 70 | * @return string |
| 71 | */ |
| 72 | public function getVisibility($path); |
| 73 | /** |
| 74 | * Set the visibility for the given path. |
| 75 | * |
| 76 | * @param string $path |
| 77 | * @param string $visibility |
| 78 | * @return bool |
| 79 | */ |
| 80 | public function setVisibility($path, $visibility); |
| 81 | /** |
| 82 | * Prepend to a file. |
| 83 | * |
| 84 | * @param string $path |
| 85 | * @param string $data |
| 86 | * @return bool |
| 87 | */ |
| 88 | public function prepend($path, $data); |
| 89 | /** |
| 90 | * Append to a file. |
| 91 | * |
| 92 | * @param string $path |
| 93 | * @param string $data |
| 94 | * @return bool |
| 95 | */ |
| 96 | public function append($path, $data); |
| 97 | /** |
| 98 | * Delete the file at a given path. |
| 99 | * |
| 100 | * @param string|array $paths |
| 101 | * @return bool |
| 102 | */ |
| 103 | public function delete($paths); |
| 104 | /** |
| 105 | * Copy a file to a new location. |
| 106 | * |
| 107 | * @param string $from |
| 108 | * @param string $to |
| 109 | * @return bool |
| 110 | */ |
| 111 | public function copy($from, $to); |
| 112 | /** |
| 113 | * Move a file to a new location. |
| 114 | * |
| 115 | * @param string $from |
| 116 | * @param string $to |
| 117 | * @return bool |
| 118 | */ |
| 119 | public function move($from, $to); |
| 120 | /** |
| 121 | * Get the file size of a given file. |
| 122 | * |
| 123 | * @param string $path |
| 124 | * @return int |
| 125 | */ |
| 126 | public function size($path); |
| 127 | /** |
| 128 | * Get the file's last modification time. |
| 129 | * |
| 130 | * @param string $path |
| 131 | * @return int |
| 132 | */ |
| 133 | public function lastModified($path); |
| 134 | /** |
| 135 | * Get an array of all files in a directory. |
| 136 | * |
| 137 | * @param string|null $directory |
| 138 | * @param bool $recursive |
| 139 | * @return array |
| 140 | */ |
| 141 | public function files($directory = null, $recursive = \false); |
| 142 | /** |
| 143 | * Get all of the files from the given directory (recursive). |
| 144 | * |
| 145 | * @param string|null $directory |
| 146 | * @return array |
| 147 | */ |
| 148 | public function allFiles($directory = null); |
| 149 | /** |
| 150 | * Get all of the directories within a given directory. |
| 151 | * |
| 152 | * @param string|null $directory |
| 153 | * @param bool $recursive |
| 154 | * @return array |
| 155 | */ |
| 156 | public function directories($directory = null, $recursive = \false); |
| 157 | /** |
| 158 | * Get all (recursive) of the directories within a given directory. |
| 159 | * |
| 160 | * @param string|null $directory |
| 161 | * @return array |
| 162 | */ |
| 163 | public function allDirectories($directory = null); |
| 164 | /** |
| 165 | * Create a directory. |
| 166 | * |
| 167 | * @param string $path |
| 168 | * @return bool |
| 169 | */ |
| 170 | public function makeDirectory($path); |
| 171 | /** |
| 172 | * Recursively delete a directory. |
| 173 | * |
| 174 | * @param string $directory |
| 175 | * @return bool |
| 176 | */ |
| 177 | public function deleteDirectory($directory); |
| 178 | } |
| 179 |