class FilesystemAdapter implements Cloud mixin FilesystemOperator (View source)
| Conditionable | |
| Macroable |
| static protected array | $macros | The registered string macros. | from Macroable |
| protected FilesystemOperator | $driver | The Flysystem filesystem implementation. | |
| protected FilesystemAdapter | $adapter | The Flysystem adapter implementation. | |
| protected array | $config | The filesystem configuration. | |
| protected PathPrefixer | $prefixer | The Flysystem PathPrefixer instance. | |
| protected Closure|null | $temporaryUrlCallback | The temporary URL builder callback. |
| $this|TWhenReturnType | when($value = null, callable|null $callback = null, callable|null $default = null)
Apply the callback if the given "value" is (or resolves to) truthy. | from Conditionable |
| $this|TUnlessReturnType | unless($value = null, callable|null $callback = null, callable|null $default = null)
Apply the callback if the given "value" is (or resolves to) falsy. | from Conditionable |
| static void | macro(string $name, object|callable $macro)
Register a custom macro. | from Macroable |
| static void | mixin(object $mixin, bool $replace = true)
Mix another object into the class. | from Macroable |
| static bool | hasMacro(string $name)
Checks if macro is registered. | from Macroable |
| static void | flushMacros()
Flush the existing macros. | from Macroable |
| static mixed | __callStatic(string $method, array $parameters)
Dynamically handle calls to the class. | from Macroable |
| mixed | __call(string $method, array $parameters)
Pass dynamic methods call onto Flysystem. | |
| void | __construct(FilesystemOperator $driver, FilesystemAdapter $adapter, array $config = [])
Create a new filesystem adapter instance. | |
| $this | assertExists(string|array $path, string|null $content = null)
Assert that the given file or directory exists. | |
| $this | assertMissing(string|array $path)
Assert that the given file or directory does not exist. | |
| $this | assertDirectoryEmpty(string $path)
Assert that the given directory is empty. | |
| bool | exists(string $path)
Determine if a file or directory exists. | |
| bool | missing(string $path)
Determine if a file or directory is missing. | |
| bool | fileExists(string $path)
Determine if a file exists. | |
| bool | fileMissing(string $path)
Determine if a file is missing. | |
| bool | directoryExists(string $path)
Determine if a directory exists. | |
| bool | directoryMissing(string $path)
Determine if a directory is missing. | |
| string | path(string $path)
Get the full path to the file that exists at the given relative path. | |
| string|null | get(string $path)
Get the contents of a file. | |
| array|null | json(string $path, int $flags = 0)
Get the contents of a file as decoded JSON. | |
| StreamedResponse | response(string $path, string|null $name = null, array $headers = [], string|null $disposition = 'inline')
Create a streamed response for a given file. | |
| StreamedResponse | download(string $path, string|null $name = null, array $headers = [])
Create a streamed download response for a given file. | |
| string | fallbackName(string $name)
Convert the string to ASCII characters that are equivalent to the given name. | |
| bool | put(string $path, StreamInterface|File|UploadedFile|string|resource $contents, mixed $options = [])
Write the contents of a file. | |
| string|false | putFile(File|UploadedFile|string $path, File|UploadedFile|string|array|null $file = null, mixed $options = [])
Store the uploaded file on the disk. | |
| string|false | putFileAs(File|UploadedFile|string $path, File|UploadedFile|string|array|null $file, string|array|null $name = null, mixed $options = [])
Store the uploaded file on the disk with a given name. | |
| string | getVisibility(string $path)
Get the visibility for the given path. | |
| bool | setVisibility(string $path, string $visibility)
Set the visibility for the given path. | |
| bool | prepend(string $path, string $data, string $separator = PHP_EOL)
Prepend to a file. | |
| bool | append(string $path, string $data, string $separator = PHP_EOL)
Append to a file. | |
| bool | delete(string|array $paths)
Delete the file at a given path. | |
| bool | copy(string $from, string $to)
Copy a file to a new location. | |
| bool | move(string $from, string $to)
Move a file to a new location. | |
| int | size(string $path)
Get the file size of a given file. | |
| string|false | checksum(string $path, array $options = [])
Get the checksum for a file. | |
| string|false | mimeType(string $path)
Get the mime-type of a given file. | |
| int | lastModified(string $path)
Get the file's last modification time. | |
| resource|null | readStream(string $path)
Get a resource to read the file. | |
| bool | writeStream(string $path, resource $resource, array $options = [])
Write a new file using a stream. | |
| string | url(string $path)
Get the URL for the file at the given path. | |
| string | getFtpUrl(string $path)
Get the URL for the file at the given path. | |
| string | getLocalUrl(string $path)
Get the URL for the file at the given path. | |
| bool | providesTemporaryUrls()
Determine if temporary URLs can be generated. | |
| string | temporaryUrl(string $path, DateTimeInterface $expiration, array $options = [])
Get a temporary URL for the file at the given path. | |
| array | temporaryUploadUrl(string $path, DateTimeInterface $expiration, array $options = [])
Get a temporary upload URL for the file at the given path. | |
| string | concatPathToUrl(string $url, string $path)
Concatenate a path to a URL. | |
| UriInterface | replaceBaseUrl(UriInterface $uri, string $url)
Replace the scheme, host and port of the given UriInterface with values from the given URL. | |
| array | files(string|null $directory = null, bool $recursive = false)
Get an array of all files in a directory. | |
| array | allFiles(string|null $directory = null)
Get all of the files from the given directory (recursive). | |
| array | directories(string|null $directory = null, bool $recursive = false)
Get all of the directories within a given directory. | |
| array | allDirectories(string|null $directory = null)
Get all the directories within a given directory (recursive). | |
| bool | makeDirectory(string $path)
Create a directory. | |
| bool | deleteDirectory(string $directory)
Recursively delete a directory. | |
| FilesystemOperator | getDriver()
Get the Flysystem driver. | |
| FilesystemAdapter | getAdapter()
Get the Flysystem adapter. | |
| array | getConfig()
Get the configuration values. | |
| string|null | parseVisibility(string|null $visibility)
Parse the given visibility value. | |
| void | buildTemporaryUrlsUsing(Closure $callback)
Define a custom temporary URL builder callback. | |
| bool | throwsExceptions()
Determine if Flysystem exceptions should be thrown. |
Apply the callback if the given "value" is (or resolves to) truthy.
Apply the callback if the given "value" is (or resolves to) falsy.
Register a custom macro.
Mix another object into the class.
Checks if macro is registered.
Flush the existing macros.
Dynamically handle calls to the class.
Pass dynamic methods call onto Flysystem.
Create a new filesystem adapter instance.
Assert that the given file or directory exists.
Assert that the given file or directory does not exist.
Assert that the given directory is empty.
Determine if a file or directory exists.
Determine if a file or directory is missing.
Determine if a file exists.
Determine if a file is missing.
Determine if a directory exists.
Determine if a directory is missing.
Get the full path to the file that exists at the given relative path.
Get the contents of a file.
Get the contents of a file as decoded JSON.
Create a streamed response for a given file.
Create a streamed download response for a given file.
Convert the string to ASCII characters that are equivalent to the given name.
Write the contents of a file.
Store the uploaded file on the disk.
Store the uploaded file on the disk with a given name.
Get the visibility for the given path.
Set the visibility for the given path.
Prepend to a file.
Append to a file.
Delete the file at a given path.
Copy a file to a new location.
Move a file to a new location.
Get the file size of a given file.
Get the checksum for a file.
Get the mime-type of a given file.
Get the file's last modification time.
Get a resource to read the file.
Write a new file using a stream.
Get the URL for the file at the given path.
Get the URL for the file at the given path.
Get the URL for the file at the given path.
Determine if temporary URLs can be generated.
Get a temporary URL for the file at the given path.
Get a temporary upload URL for the file at the given path.
Concatenate a path to a URL.
Replace the scheme, host and port of the given UriInterface with values from the given URL.
Get an array of all files in a directory.
Get all of the files from the given directory (recursive).
Get all of the directories within a given directory.
Get all the directories within a given directory (recursive).
Create a directory.
Recursively delete a directory.
Get the Flysystem driver.
Get the Flysystem adapter.
Get the configuration values.
Parse the given visibility value.
Define a custom temporary URL builder callback.
Determine if Flysystem exceptions should be thrown.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Filesystem/FilesystemAdapter.html