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

FilesystemAdapter

class FilesystemAdapter implements Filesystem, Cloud mixin FilesystemInterface

Properties

protected FilesystemInterface $driver

The Flysystem filesystem implementation.

Methods

void
__construct(FilesystemInterface $driver)

Create a new filesystem adapter instance.

void
assertExists(string $path)

Assert that the given file exists.

void
assertMissing(string $path)

Assert that the given file does not exist.

bool
exists(string $path)

Determine if a file exists.

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.

bool
put(string $path, string|resource $contents, array $options = [])

Write the contents of a file.

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

Store the uploaded file on the disk.

string|false
putFileAs(string $path, File|UploadedFile $file, string $name, array $options = [])

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

string
getVisibility(string $path)

Get the visibility for the given path.

void
setVisibility(string $path, string $visibility)

Set the visibility for the given path.

int
prepend(string $path, string $data, string $separator = PHP_EOL)

Prepend to a file.

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

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

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.

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.

mixed
__call(string $method, array $parameters)

Pass dynamic methods call onto Flysystem.

Details

at line 39
void __construct(FilesystemInterface $driver)

Create a new filesystem adapter instance.

Parameters

FilesystemInterface $driver

Return Value

void

at line 50
void assertExists(string $path)

Assert that the given file exists.

Parameters

string $path

Return Value

void

at line 63
void assertMissing(string $path)

Assert that the given file does not exist.

Parameters

string $path

Return Value

void

at line 76
bool exists(string $path)

Determine if a file exists.

Parameters

string $path

Return Value

bool

at line 87
string path(string $path)

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

Parameters

string $path

Return Value

string

at line 100
string get(string $path)

Get the contents of a file.

Parameters

string $path

Return Value

string

Exceptions

FileNotFoundException

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

Write the contents of a file.

Parameters

string $path
string|resource $contents
array $options

Return Value

bool

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

Store the uploaded file on the disk.

Parameters

string $path
File|UploadedFile $file
array $options

Return Value

string|false

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

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

Parameters

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

Return Value

string|false

at line 182
string getVisibility(string $path)

Get the visibility for the given path.

Parameters

string $path

Return Value

string

at line 198
void setVisibility(string $path, string $visibility)

Set the visibility for the given path.

Parameters

string $path
string $visibility

Return Value

void

at line 211
int prepend(string $path, string $data, string $separator = PHP_EOL)

Prepend to a file.

Parameters

string $path
string $data
string $separator

Return Value

int

at line 228
int append(string $path, string $data, string $separator = PHP_EOL)

Append to a file.

Parameters

string $path
string $data
string $separator

Return Value

int

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

Delete the file at a given path.

Parameters

string|array $paths

Return Value

bool

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

Copy a file to a new location.

Parameters

string $from
string $to

Return Value

bool

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

Move a file to a new location.

Parameters

string $from
string $to

Return Value

bool

at line 292
int size(string $path)

Get the file size of a given file.

Parameters

string $path

Return Value

int

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

Get the mime-type of a given file.

Parameters

string $path

Return Value

string|false

at line 314
int lastModified(string $path)

Get the file's last modification time.

Parameters

string $path

Return Value

int

at line 325
string url(string $path)

Get the URL for the file at the given path.

Parameters

string $path

Return Value

string

at line 347
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 360
protected string getLocalUrl(string $path)

Get the URL for the file at the given path.

Parameters

string $path

Return Value

string

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

at line 420
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 433
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 445
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 458
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 469
bool makeDirectory(string $path)

Create a directory.

Parameters

string $path

Return Value

bool

at line 480
bool deleteDirectory(string $directory)

Recursively delete a directory.

Parameters

string $directory

Return Value

bool

at line 490
FilesystemInterface getDriver()

Get the Flysystem driver.

Return Value

FilesystemInterface

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

Filter directory contents by type.

Parameters

array $contents
string $type

Return Value

array

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

Parse the given visibility value.

Parameters

string|null $visibility

Return Value

string|null

Exceptions

InvalidArgumentException

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

Pass dynamic methods call onto Flysystem.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException