1. class
  2. Illuminate
  3. \
  4. Filesystem
  5. \
  6. FilesystemAdapter

FilesystemAdapter

class FilesystemAdapter implements Cloud mixin FilesystemInterface (View source)

Traits

Macroable

Properties

static protected array $macros

The registered string macros.

 from  Macroable
protected FilesystemInterface $driver

The Flysystem filesystem implementation.
protected Closure|null $temporaryUrlCallback

The temporary URL builder callback.

Methods

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(FilesystemInterface $driver)

Create a new filesystem adapter instance.

$this
assertExists(string|array $path, string|null $content = null)

Assert that the given file exists.

$this
assertMissing(string|array $path)

Assert that the given file does not exist.

bool
exists(string $path)

Determine if a file exists.

bool
missing(string $path)

Determine if a file or directory is missing.

string
path(string $path)

Get the full path for the file at the given "short" path.

string
get(string $path)

Get the contents of a file.

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, string|resource $contents, mixed $options = [])

Write the contents of a file.

string|false
putFile(string $path, File|UploadedFile|string $file, mixed $options = [])

Store the uploaded file on the disk.

string|false
putFileAs(string $path, File|UploadedFile|string $file, string $name, 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
mimeType(string $path)

Get the mime-type of a given file.

int
lastModified(string $path)

Get the file's last modification time.

string
url(string $path)

Get the URL for the file at the given path.

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
getAwsUrl(AwsS3Adapter $adapter, 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.

string
temporaryUrl(string $path, DateTimeInterface $expiration, array $options = [])

Get a temporary URL for the file at the given path.

string
getAwsTemporaryUrl(AwsS3Adapter $adapter, string $path, DateTimeInterface $expiration, array $options)

Get a temporary 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 (recursive) of the directories within a given directory.

bool
makeDirectory(string $path)

Create a directory.

bool
deleteDirectory(string $directory)

Recursively delete a directory.

void
flushCache()

Flush the Flysystem cache.

FilesystemInterface
getDriver()

Get the Flysystem driver.

array
filterContentsByType(array $contents, string $type)

Filter directory contents by type.

string|null
parseVisibility(string|null $visibility)

Parse the given visibility value.

void
buildTemporaryUrlsUsing(Closure $callback)

Define a custom temporary URL builder callback.

Details

in Macroable at line 26
static void macro(string $name, object|callable $macro)

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

in Macroable at line 40
static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

in Macroable at line 60
static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 70
static void flushMacros()

Flush the existing macros.

Return Value

void

in Macroable at line 84
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line 821
mixed __call(string $method, array $parameters)

Pass dynamic methods call onto Flysystem.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line 61
void __construct(FilesystemInterface $driver)

Create a new filesystem adapter instance.

Parameters

FilesystemInterface $driver

Return Value

void

at line 73
$this assertExists(string|array $path, string|null $content = null)

Assert that the given file exists.

Parameters

string|array $path
string|null $content

Return Value

$this

at line 104
$this assertMissing(string|array $path)

Assert that the given file does not exist.

Parameters

string|array $path

Return Value

$this

at line 125
bool exists(string $path)

Determine if a file exists.

Parameters

string $path

Return Value

bool

at line 136
bool missing(string $path)

Determine if a file or directory is missing.

Parameters

string $path

Return Value

bool

at line 147
string path(string $path)

Get the full path for the file at the given "short" path.

Parameters

string $path

Return Value

string

at line 166
string get(string $path)

Get the contents of a file.

Parameters

string $path

Return Value

string

Exceptions

FileNotFoundException

at line 184
StreamedResponse response(string $path, string|null $name = null, array $headers = [], string|null $disposition = 'inline')

Create a streamed response for a given file.

Parameters

string $path
string|null $name
array $headers
string|null $disposition

Return Value

StreamedResponse

at line 217
StreamedResponse download(string $path, string|null $name = null, array $headers = [])

Create a streamed download response for a given file.

Parameters

string $path
string|null $name
array $headers

Return Value

StreamedResponse

at line 228
protected string fallbackName(string $name)

Convert the string to ASCII characters that are equivalent to the given name.

Parameters

string $name

Return Value

string

at line 241
bool put(string $path, string|resource $contents, mixed $options = [])

Write the contents of a file.

Parameters

string $path
string|resource $contents
mixed $options

Return Value

bool

at line 272
string|false putFile(string $path, File|UploadedFile|string $file, mixed $options = [])

Store the uploaded file on the disk.

Parameters

string $path
File|UploadedFile|string $file
mixed $options

Return Value

string|false

at line 288
string|false putFileAs(string $path, File|UploadedFile|string $file, string $name, mixed $options = [])

Store the uploaded file on the disk with a given name.

Parameters

string $path
File|UploadedFile|string $file
string $name
mixed $options

Return Value

string|false

at line 312
string getVisibility(string $path)

Get the visibility for the given path.

Parameters

string $path

Return Value

string

at line 328
bool setVisibility(string $path, string $visibility)

Set the visibility for the given path.

Parameters

string $path
string $visibility

Return Value

bool

at line 341
bool prepend(string $path, string $data, string $separator = PHP_EOL)

Prepend to a file.

Parameters

string $path
string $data
string $separator

Return Value

bool

at line 358
bool append(string $path, string $data, string $separator = PHP_EOL)

Append to a file.

Parameters

string $path
string $data
string $separator

Return Value

bool

at line 373
bool delete(string|array $paths)

Delete the file at a given path.

Parameters

string|array $paths

Return Value

bool

at line 399
bool copy(string $from, string $to)

Copy a file to a new location.

Parameters

string $from
string $to

Return Value

bool

at line 411
bool move(string $from, string $to)

Move a file to a new location.

Parameters

string $from
string $to

Return Value

bool

at line 422
int size(string $path)

Get the file size of a given file.

Parameters

string $path

Return Value

int

at line 433
string|false mimeType(string $path)

Get the mime-type of a given file.

Parameters

string $path

Return Value

string|false

at line 444
int lastModified(string $path)

Get the file's last modification time.

Parameters

string $path

Return Value

int

at line 457
string url(string $path)

Get the URL for the file at the given path.

Parameters

string $path

Return Value

string

Exceptions

RuntimeException

at line 483
resource|null readStream(string $path)

Get a resource to read the file.

Parameters

string $path

Return Value

resource|null

The path resource or null on failure.

Exceptions

FileNotFoundException

at line 495
bool writeStream(string $path, resource $resource, array $options = [])

Write a new file using a stream.

Parameters

string $path
resource $resource
array $options

Return Value

bool

Exceptions

InvalidArgumentException
FileExistsException

at line 511
protected string getAwsUrl(AwsS3Adapter $adapter, string $path)

Get the URL for the file at the given path.

Parameters

AwsS3Adapter $adapter
string $path

Return Value

string

at line 531
protected string getFtpUrl(string $path)

Get the URL for the file at the given path.

Parameters

string $path

Return Value

string

at line 546
protected string getLocalUrl(string $path)

Get the URL for the file at the given path.

Parameters

string $path

Return Value

string

at line 579
string temporaryUrl(string $path, DateTimeInterface $expiration, array $options = [])

Get a temporary URL for the file at the given path.

Parameters

string $path
DateTimeInterface $expiration
array $options

Return Value

string

Exceptions

RuntimeException

at line 613
string getAwsTemporaryUrl(AwsS3Adapter $adapter, string $path, DateTimeInterface $expiration, array $options)

Get a temporary URL for the file at the given path.

Parameters

AwsS3Adapter $adapter
string $path
DateTimeInterface $expiration
array $options

Return Value

string

at line 643
protected string concatPathToUrl(string $url, string $path)

Concatenate a path to a URL.

Parameters

string $url
string $path

Return Value

string

at line 655
protected UriInterface replaceBaseUrl(UriInterface $uri, string $url)

Replace the scheme, host and port of the given UriInterface with values from the given URL.

Parameters

UriInterface $uri
string $url

Return Value

UriInterface

at line 672
array files(string|null $directory = null, bool $recursive = false)

Get an array of all files in a directory.

Parameters

string|null $directory
bool $recursive

Return Value

array

at line 685
array allFiles(string|null $directory = null)

Get all of the files from the given directory (recursive).

Parameters

string|null $directory

Return Value

array

at line 697
array directories(string|null $directory = null, bool $recursive = false)

Get all of the directories within a given directory.

Parameters

string|null $directory
bool $recursive

Return Value

array

at line 710
array allDirectories(string|null $directory = null)

Get all (recursive) of the directories within a given directory.

Parameters

string|null $directory

Return Value

array

at line 721
bool makeDirectory(string $path)

Create a directory.

Parameters

string $path

Return Value

bool

at line 732
bool deleteDirectory(string $directory)

Recursively delete a directory.

Parameters

string $directory

Return Value

bool

at line 742
void flushCache()

Flush the Flysystem cache.

Return Value

void

at line 756
FilesystemInterface getDriver()

Get the Flysystem driver.

Return Value

FilesystemInterface

at line 768
protected array filterContentsByType(array $contents, string $type)

Filter directory contents by type.

Parameters

array $contents
string $type

Return Value

array

at line 785
protected string|null parseVisibility(string|null $visibility)

Parse the given visibility value.

Parameters

string|null $visibility

Return Value

string|null

Exceptions

InvalidArgumentException

at line 807
void buildTemporaryUrlsUsing(Closure $callback)

Define a custom temporary URL builder callback.

Parameters

Closure $callback

Return Value

void

Laravel Cloud is the best place to deploy Laravel, Nuxt, Express, Hono, Node.js, Bun, Go, Flask, Python, and more, with dedicated infrastructure available on AWS through Laravel Private Cloud.