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

LocalFilesystemAdapter

class LocalFilesystemAdapter extends FilesystemAdapter (View source)

Traits

Conditionable
Conditionable
Macroable

Properties

static protected array $macros

The registered string macros.

 from  Macroable
protected FilesystemOperator $driver

The Flysystem filesystem implementation.

 from  FilesystemAdapter
protected FilesystemAdapter $adapter

The Flysystem adapter implementation.

 from  FilesystemAdapter
protected array $config

The filesystem configuration.

 from  FilesystemAdapter
protected PathPrefixer $prefixer

The Flysystem PathPrefixer instance.

 from  FilesystemAdapter
protected Closure|null $serveCallback

The file server callback.

 from  FilesystemAdapter
protected Closure|null $temporaryUrlCallback

The temporary URL builder callback.

 from  FilesystemAdapter
protected string $disk

The name of the filesystem disk.
protected bool $shouldServeSignedUrls

Indicates if signed URLs should serve corresponding files.
protected Closure $urlGeneratorResolver

The Closure that should be used to resolve the URL generator.

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)

Dynamically handle calls to the class.

from  Macroable
__construct(FilesystemOperator $driver, FilesystemAdapter $adapter, array $config = [])

Create a new filesystem adapter instance.

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

Assert that the given file or directory exists.

from  FilesystemAdapter
$this
assertCount(string $path, int $count, bool $recursive = false)

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

from  FilesystemAdapter
$this
assertMissing(string|array $path)

Assert that the given file or directory does not exist.

from  FilesystemAdapter
$this
assertDirectoryEmpty(string $path)

Assert that the given directory is empty.

from  FilesystemAdapter
bool
exists(string $path)

Determine if a file or directory exists.

from  FilesystemAdapter
bool
missing(string $path)

Determine if a file or directory is missing.

from  FilesystemAdapter
bool
fileExists(string $path)

Determine if a file exists.

from  FilesystemAdapter
bool
fileMissing(string $path)

Determine if a file is missing.

from  FilesystemAdapter
bool
directoryExists(string $path)

Determine if a directory exists.

from  FilesystemAdapter
bool
directoryMissing(string $path)

Determine if a directory is missing.

from  FilesystemAdapter
string
path(string $path)

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

from  FilesystemAdapter
string|null
get(string $path)

Get the contents of a file.

from  FilesystemAdapter
array|null
json(string $path, int $flags = 0)

Get the contents of a file as decoded JSON.

from  FilesystemAdapter
StreamedResponse
response(string $path, string|null $name = null, array $headers = [], string|null $disposition = 'inline')

Create a streamed response for a given file.

from  FilesystemAdapter
StreamedResponse
serve(Request $request, string $path, string|null $name = null, array $headers = [])

Create a streamed download response for a given file.

from  FilesystemAdapter
StreamedResponse
download(string $path, string|null $name = null, array $headers = [])

Create a streamed download response for a given file.

from  FilesystemAdapter
string
fallbackName(string $name)

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

from  FilesystemAdapter
bool
put(string $path, StreamInterface|File|UploadedFile|string|resource $contents, mixed $options = [])

Write the contents of a file.

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

Store the uploaded file on the disk.

from  FilesystemAdapter
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.

from  FilesystemAdapter
string
getVisibility(string $path)

Get the visibility for the given path.

from  FilesystemAdapter
bool
setVisibility(string $path, string $visibility)

Set the visibility for the given path.

from  FilesystemAdapter
bool
prepend(string $path, string $data, string $separator = PHP_EOL)

Prepend to a file.

from  FilesystemAdapter
bool
append(string $path, string $data, string $separator = PHP_EOL)

Append to a file.

from  FilesystemAdapter
bool
delete(string|array $paths)

Delete the file at a given path.

from  FilesystemAdapter
bool
copy(string $from, string $to)

Copy a file to a new location.

from  FilesystemAdapter
bool
move(string $from, string $to)

Move a file to a new location.

from  FilesystemAdapter
int
size(string $path)

Get the file size of a given file.

from  FilesystemAdapter
string|false
checksum(string $path, array $options = [])

Get the checksum for a file.

from  FilesystemAdapter
string|false
mimeType(string $path)

Get the mime-type of a given file.

from  FilesystemAdapter
int
lastModified(string $path)

Get the file's last modification time.

from  FilesystemAdapter
resource|null
readStream(string $path)

Get a resource to read the file.

from  FilesystemAdapter
bool
writeStream(string $path, resource $resource, array $options = [])

Write a new file using a stream.

from  FilesystemAdapter
string
url(string $path)

Get the URL for the file at the given path.

from  FilesystemAdapter
string
getFtpUrl(string $path)

Get the URL for the file at the given path.

from  FilesystemAdapter
string
getLocalUrl(string $path)

Get the URL for the file at the given path.

from  FilesystemAdapter
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.

from  FilesystemAdapter
string
concatPathToUrl(string $url, string $path)

Concatenate a path to a URL.

from  FilesystemAdapter
UriInterface
replaceBaseUrl(UriInterface $uri, string $url)

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

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

Get an array of all files in a directory.

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

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

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

Get all of the directories within a given directory.

from  FilesystemAdapter
string[]
allDirectories(string|null $directory = null)

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

from  FilesystemAdapter
bool
makeDirectory(string $path)

Create a directory.

from  FilesystemAdapter
bool
deleteDirectory(string $directory)

Recursively delete a directory.

from  FilesystemAdapter
FilesystemOperator
getDriver()

Get the Flysystem driver.

from  FilesystemAdapter
FilesystemAdapter
getAdapter()

Get the Flysystem adapter.

from  FilesystemAdapter
array
getConfig()

Get the configuration values.

from  FilesystemAdapter
string|null
parseVisibility(string|null $visibility)

Parse the given visibility value.

from  FilesystemAdapter
void
serveUsing(Closure $callback)

Define a custom callback that generates file download responses.

from  FilesystemAdapter
void
buildTemporaryUrlsUsing(Closure $callback)

Define a custom temporary URL builder callback.

from  FilesystemAdapter
bool
throwsExceptions()

Determine if Flysystem exceptions should be thrown.

from  FilesystemAdapter
void
report(Throwable $exception)

No description

from  FilesystemAdapter
bool
shouldReport()

Determine if Flysystem exceptions should be reported.

from  FilesystemAdapter
$this
diskName(string $disk)

Specify the name of the disk the adapter is managing.

$this
shouldServeSignedUrls(bool $serve = true, Closure|null $urlGeneratorResolver = null)

Indicate that signed URLs should serve the corresponding files.

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

in Macroable at line 112
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

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

Create a new filesystem adapter instance.

Parameters

FilesystemOperator $driver
FilesystemAdapter $adapter
array $config

in FilesystemAdapter 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

in FilesystemAdapter 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

in FilesystemAdapter 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

in FilesystemAdapter at line 195
$this assertDirectoryEmpty(string $path)

Assert that the given directory is empty.

Parameters

string $path

Return Value

$this

in FilesystemAdapter at line 210
bool exists(string $path)

Determine if a file or directory exists.

Parameters

string $path

Return Value

bool

in FilesystemAdapter at line 221
bool missing(string $path)

Determine if a file or directory is missing.

Parameters

string $path

Return Value

bool

in FilesystemAdapter at line 232
bool fileExists(string $path)

Determine if a file exists.

Parameters

string $path

Return Value

bool

in FilesystemAdapter at line 243
bool fileMissing(string $path)

Determine if a file is missing.

Parameters

string $path

Return Value

bool

in FilesystemAdapter at line 254
bool directoryExists(string $path)

Determine if a directory exists.

Parameters

string $path

Return Value

bool

in FilesystemAdapter at line 265
bool directoryMissing(string $path)

Determine if a directory is missing.

Parameters

string $path

Return Value

bool

in FilesystemAdapter 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

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

Get the contents of a file.

Parameters

string $path

Return Value

string|null

in FilesystemAdapter 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

in FilesystemAdapter 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

in FilesystemAdapter 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

in FilesystemAdapter 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

in FilesystemAdapter 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

in FilesystemAdapter 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

in FilesystemAdapter 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

in FilesystemAdapter 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

in FilesystemAdapter at line 488
string getVisibility(string $path)

Get the visibility for the given path.

Parameters

string $path

Return Value

string

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

Set the visibility for the given path.

Parameters

string $path
string $visibility

Return Value

bool

in FilesystemAdapter 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

in FilesystemAdapter 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

in FilesystemAdapter at line 559
bool delete(string|array $paths)

Delete the file at a given path.

Parameters

string|array $paths

Return Value

bool

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

Copy a file to a new location.

Parameters

string $from
string $to

Return Value

bool

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

Move a file to a new location.

Parameters

string $from
string $to

Return Value

bool

in FilesystemAdapter at line 630
int size(string $path)

Get the file size of a given file.

Parameters

string $path

Return Value

int

in FilesystemAdapter 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

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

Get the mime-type of a given file.

Parameters

string $path

Return Value

string|false

in FilesystemAdapter at line 680
int lastModified(string $path)

Get the file's last modification time.

Parameters

string $path

Return Value

int

in FilesystemAdapter 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.

in FilesystemAdapter 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

in FilesystemAdapter 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

in FilesystemAdapter at line 752
protected string getFtpUrl(string $path)

Get the URL for the file at the given path.

Parameters

string $path

Return Value

string

in FilesystemAdapter 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 39
bool providesTemporaryUrls()

Determine if temporary URLs can be generated.

Return Value

bool

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

in FilesystemAdapter 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

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

Concatenate a path to a URL.

Parameters

string $url
string $path

Return Value

string

in FilesystemAdapter 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

in FilesystemAdapter 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[]

in FilesystemAdapter 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[]

in FilesystemAdapter 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[]

in FilesystemAdapter 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[]

in FilesystemAdapter at line 936
bool makeDirectory(string $path)

Create a directory.

Parameters

string $path

Return Value

bool

in FilesystemAdapter at line 957
bool deleteDirectory(string $directory)

Recursively delete a directory.

Parameters

string $directory

Return Value

bool

in FilesystemAdapter at line 977
FilesystemOperator getDriver()

Get the Flysystem driver.

Return Value

FilesystemOperator

in FilesystemAdapter at line 987
FilesystemAdapter getAdapter()

Get the Flysystem adapter.

Return Value

FilesystemAdapter

in FilesystemAdapter at line 997
array getConfig()

Get the configuration values.

Return Value

array

in FilesystemAdapter 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

in FilesystemAdapter at line 1029
void serveUsing(Closure $callback)

Define a custom callback that generates file download responses.

Parameters

Closure $callback

Return Value

void

in FilesystemAdapter at line 1040
void buildTemporaryUrlsUsing(Closure $callback)

Define a custom temporary URL builder callback.

Parameters

Closure $callback

Return Value

void

in FilesystemAdapter at line 1050
protected bool throwsExceptions()

Determine if Flysystem exceptions should be thrown.

Return Value

bool

in FilesystemAdapter at line 1061
protected void report(Throwable $exception)

No description

Parameters

Throwable $exception

Return Value

void

Exceptions

Throwable

in FilesystemAdapter at line 1073
protected bool shouldReport()

Determine if Flysystem exceptions should be reported.

Return Value

bool

at line 82
$this diskName(string $disk)

Specify the name of the disk the adapter is managing.

Parameters

string $disk

Return Value

$this

at line 96
$this shouldServeSignedUrls(bool $serve = true, Closure|null $urlGeneratorResolver = null)

Indicate that signed URLs should serve the corresponding files.

Parameters

bool $serve
Closure|null $urlGeneratorResolver

Return Value

$this