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

FilesystemAdapter

class FilesystemAdapter implements Cloud mixin FilesystemOperator (View source)

Traits

Conditionable
Macroable

Properties

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 $serveCallback

The file server callback.
protected Closure|null $temporaryUrlCallback

The temporary URL builder callback.

Methods

$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.

__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
assertCount(string $path, int $count, bool $recursive = false)

Assert that the number of files in path equals the expected count.

$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
serve(Request $request, string $path, string|null $name = null, array $headers = [])

Create a streamed download 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.

string[]
files(string|null $directory = null, bool $recursive = false)

Get an array of all files in a directory.

string[]
allFiles(string|null $directory = null)

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

string[]
directories(string|null $directory = null, bool $recursive = false)

Get all of the directories within a given directory.

string[]
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
serveUsing(Closure $callback)

Define a custom callback that generates file download responses.

void
buildTemporaryUrlsUsing(Closure $callback)

Define a custom temporary URL builder callback.

bool
throwsExceptions()

Determine if Flysystem exceptions should be thrown.

void
report(Throwable $exception)

No description

bool
shouldReport()

Determine if Flysystem exceptions should be reported.

Details

in Conditionable at line 21
$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.

Parameters

$value
callable|null $callback
callable|null $default

Return Value

$this|TWhenReturnType

in Conditionable at line 53
$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.

Parameters

$value
callable|null $callback
callable|null $default

Return Value

$this|TUnlessReturnType

in Macroable at line 29
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 43
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 62
static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 72
static void flushMacros()

Flush the existing macros.

Return Value

void

in Macroable at line 86
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 1087
mixed __call(string $method, array $parameters)

Pass dynamic methods call onto Flysystem.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line 101
__construct(FilesystemOperator $driver, FilesystemAdapter $adapter, array $config = [])

Create a new filesystem adapter instance.

Parameters

FilesystemOperator $driver
FilesystemAdapter $adapter
array $config

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

Assert that the given file or directory exists.

Parameters

string|array $path
string|null $content

Return Value

$this

at line 155
$this assertCount(string $path, int $count, bool $recursive = false)

Assert that the number of files in path equals the expected count.

Parameters

string $path
int $count
bool $recursive

Return Value

$this

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

Assert that the given file or directory does not exist.

Parameters

string|array $path

Return Value

$this

at line 195
$this assertDirectoryEmpty(string $path)

Assert that the given directory is empty.

Parameters

string $path

Return Value

$this

at line 210
bool exists(string $path)

Determine if a file or directory exists.

Parameters

string $path

Return Value

bool

at line 221
bool missing(string $path)

Determine if a file or directory is missing.

Parameters

string $path

Return Value

bool

at line 232
bool fileExists(string $path)

Determine if a file exists.

Parameters

string $path

Return Value

bool

at line 243
bool fileMissing(string $path)

Determine if a file is missing.

Parameters

string $path

Return Value

bool

at line 254
bool directoryExists(string $path)

Determine if a directory exists.

Parameters

string $path

Return Value

bool

at line 265
bool directoryMissing(string $path)

Determine if a directory is missing.

Parameters

string $path

Return Value

bool

at line 276
string path(string $path)

Get the full path to the file that exists at the given relative path.

Parameters

string $path

Return Value

string

at line 287
string|null get(string $path)

Get the contents of a file.

Parameters

string $path

Return Value

string|null

at line 305
array|null json(string $path, int $flags = 0)

Get the contents of a file as decoded JSON.

Parameters

string $path
int $flags

Return Value

array|null

at line 321
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 358
StreamedResponse serve(Request $request, string $path, string|null $name = null, array $headers = [])

Create a streamed download response for a given file.

Parameters

Request $request
string $path
string|null $name
array $headers

Return Value

StreamedResponse

at line 373
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 384
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 397
bool put(string $path, StreamInterface|File|UploadedFile|string|resource $contents, mixed $options = [])

Write the contents of a file.

Parameters

string $path
StreamInterface|File|UploadedFile|string|resource $contents
mixed $options

Return Value

bool

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

Store the uploaded file on the disk.

Parameters

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

Return Value

string|false

at line 460
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.

Parameters

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

Return Value

string|false

at line 488
string getVisibility(string $path)

Get the visibility for the given path.

Parameters

string $path

Return Value

string

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

Set the visibility for the given path.

Parameters

string $path
string $visibility

Return Value

bool

at line 527
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 544
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 559
bool delete(string|array $paths)

Delete the file at a given path.

Parameters

string|array $paths

Return Value

bool

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

Copy a file to a new location.

Parameters

string $from
string $to

Return Value

bool

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

Move a file to a new location.

Parameters

string $from
string $to

Return Value

bool

at line 630
int size(string $path)

Get the file size of a given file.

Parameters

string $path

Return Value

int

at line 642
string|false checksum(string $path, array $options = [])

Get the checksum for a file.

Parameters

string $path
array $options

Return Value

string|false

Exceptions

UnableToProvideChecksum

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

Get the mime-type of a given file.

Parameters

string $path

Return Value

string|false

at line 680
int lastModified(string $path)

Get the file's last modification time.

Parameters

string $path

Return Value

int

at line 688
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.

at line 702
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

at line 725
string url(string $path)

Get the URL for the file at the given path.

Parameters

string $path

Return Value

string

Exceptions

RuntimeException

at line 752
protected string getFtpUrl(string $path)

Get the URL for the file at the given path.

Parameters

string $path

Return Value

string

at line 765
protected string getLocalUrl(string $path)

Get the URL for the file at the given path.

Parameters

string $path

Return Value

string

at line 791
bool providesTemporaryUrls()

Determine if temporary URLs can be generated.

Return Value

bool

at line 806
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 831
array temporaryUploadUrl(string $path, DateTimeInterface $expiration, array $options = [])

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

Parameters

string $path
DateTimeInterface $expiration
array $options

Return Value

array

Exceptions

RuntimeException

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

Concatenate a path to a URL.

Parameters

string $url
string $path

Return Value

string

at line 859
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 876
string[] 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

string[]

at line 895
string[] allFiles(string|null $directory = null)

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

Parameters

string|null $directory

Return Value

string[]

at line 907
string[] 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

string[]

at line 925
string[] allDirectories(string|null $directory = null)

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

Parameters

string|null $directory

Return Value

string[]

at line 936
bool makeDirectory(string $path)

Create a directory.

Parameters

string $path

Return Value

bool

at line 957
bool deleteDirectory(string $directory)

Recursively delete a directory.

Parameters

string $directory

Return Value

bool

at line 977
FilesystemOperator getDriver()

Get the Flysystem driver.

Return Value

FilesystemOperator

at line 987
FilesystemAdapter getAdapter()

Get the Flysystem adapter.

Return Value

FilesystemAdapter

at line 997
array getConfig()

Get the configuration values.

Return Value

array

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

Parse the given visibility value.

Parameters

string|null $visibility

Return Value

string|null

Exceptions

InvalidArgumentException

at line 1029
void serveUsing(Closure $callback)

Define a custom callback that generates file download responses.

Parameters

Closure $callback

Return Value

void

at line 1040
void buildTemporaryUrlsUsing(Closure $callback)

Define a custom temporary URL builder callback.

Parameters

Closure $callback

Return Value

void

at line 1050
protected bool throwsExceptions()

Determine if Flysystem exceptions should be thrown.

Return Value

bool

at line 1061
protected void report(Throwable $exception)

No description

Parameters

Throwable $exception

Return Value

void

Exceptions

Throwable

at line 1073
protected bool shouldReport()

Determine if Flysystem exceptions should be reported.

Return Value

bool