1. class
  2. Hypervel
  3. \
  4. Filesystem
  5. \
  6. ReadThroughFilesystem

ReadThroughFilesystem

class ReadThroughFilesystem extends FilesystemAdapter

Traits

Conditionable
TransfersFiles
Macroable

Properties

static protected array $macros

The registered string macros.

 from  Macroable
protected array $config

The filesystem configuration.

 from  FilesystemAdapter
protected PathPrefixer $prefixer

The Flysystem PathPrefixer instance.

 from  FilesystemAdapter
protected PathNormalizer $pathNormalizer

The Flysystem path normalizer 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 Closure|null $temporaryUploadUrlCallback

The temporary upload URL builder callback.

 from  FilesystemAdapter
protected PathPrefixer $readThroughPrefixer

Methods

mixed
when(mixed $value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) truthy.

from  Conditionable
mixed
unless(mixed $value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) falsy.

from  Conditionable
bool
copyToDisk(Filesystem|string|UnitEnum $disk, string $from, string|null $to = null)

Copy a file to another disk.

from  TransfersFiles
bool
moveToDisk(Filesystem|string|UnitEnum $disk, string $from, string|null $to = null)

Move a file to another disk.

from  TransfersFiles
bool
transferFile(Filesystem $source, string $from, Filesystem $destination, string $to)

Transfer a file without holding a source lease during the destination write.

from  TransfersFiles
static void
macro(string $name, callable|object $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)

Check 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, Cloud $primary, Cloud $fallback, string $prefix = '', ReadThroughFilesystemAdapter|null $readThroughAdapter = null)

Create a new read-through filesystem instance.

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

Assert that the given file or directory exists.

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

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

from  FilesystemAdapter
FilesystemAdapter
assertMissing(array|string $path)

Assert that the given file or directory does not exist.

from  FilesystemAdapter
FilesystemAdapter
assertDirectoryEmpty(string $path)

Assert that the given directory is empty.

from  FilesystemAdapter
FilesystemAdapter
assertEmpty()

Assert that the disk contains no files.

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 primary filesystem path, including both disks' prefixes.

string|null
get(string $path)

Get the contents of a file.

from  FilesystemAdapter
array|bool|float|int|string|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 $disposition = 'inline')

Create a streamed response for a given file.

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

Create a streamed response for serving 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
Image
image(string $path)

Create an image instance from a file in storage.

from  FilesystemAdapter
StreamedResponse
buildFileResponse(Request $request, string $path, string|null $name, array $headers, string $disposition)

Build a file response using the supplied request context.

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

Write the contents of a file.

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

Store the uploaded file on the disk.

from  FilesystemAdapter
false|string
putFileAs(string|File|UploadedFile $path, array|string|File|UploadedFile|null $file, array|string|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(array|string $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
false|string
checksum(string $path, array $options = [])

Get the checksum for a file.

from  FilesystemAdapter
false|string
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
mixed
readStream(string $path)

Get a resource to read the file.

from  FilesystemAdapter
mixed
readStreamRange(string $path, int|null $start, int|null $end)

Read a byte range using native cloud requests when promotion is unnecessary.

array
normalizeStreamRange(int|null $start, int|null $end)

Normalize and validate byte-range stream arguments.

from  FilesystemAdapter
bool
writeStream(string $path, mixed $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.

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.

bool
providesTemporaryUploadUrls()

Determine if temporary upload URLs can be generated.

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

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

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

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

string
encodeUrlPath(string $path)

Encode a path for use in a URL.

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

Encode and 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
array
files(string|null $directory = null, bool $recursive = false)

Get an array of all files in a directory.

from  FilesystemAdapter
array
allFiles(string|null $directory = null)

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

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

Get all of the directories within a given directory.

from  FilesystemAdapter
array
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|null $callback)

Define a custom callback that generates file download responses.

from  FilesystemAdapter
void
buildTemporaryUrlsUsing(Closure|null $callback)

Define a custom temporary URL builder callback.

from  FilesystemAdapter
void
buildTemporaryUploadUrlsUsing(Closure|null $callback)

Define a custom temporary upload URL builder callback.

from  FilesystemAdapter
Closure|null
prepareTemporaryUrlCallback(Closure|null $callback)

Prepare a temporary URL callback for direct invocation.

from  FilesystemAdapter
bool
throwsExceptions()

Determine if Flysystem exceptions should be thrown.

from  FilesystemAdapter
void
report(Throwable $exception)

Report the exception.

from  FilesystemAdapter
bool
shouldReport()

Determine if Flysystem exceptions should be reported.

from  FilesystemAdapter
static void
flushState()

Flush all static state.

from  FilesystemAdapter
Cloud
readerFor(string $path)

Get the filesystem that contains the given path.

Details

in Conditionable at line 23
mixed when(mixed $value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) truthy.

Parameters

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

Return Value

mixed

in Conditionable at line 56
mixed unless(mixed $value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) falsy.

Parameters

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

Return Value

mixed

in TransfersFiles at line 21
bool copyToDisk(Filesystem|string|UnitEnum $disk, string $from, string|null $to = null)

Copy a file to another disk.

Parameters

Filesystem|string|UnitEnum $disk
string $from
string|null $to

Return Value

bool

in TransfersFiles at line 33
bool moveToDisk(Filesystem|string|UnitEnum $disk, string $from, string|null $to = null)

Move a file to another disk.

Parameters

Filesystem|string|UnitEnum $disk
string $from
string|null $to

Return Value

bool

in TransfersFiles at line 41
protected bool transferFile(Filesystem $source, string $from, Filesystem $destination, string $to)

Transfer a file without holding a source lease during the destination write.

Parameters

Filesystem $source
string $from
Filesystem $destination
string $to

Return Value

bool

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

Register a custom macro.

Boot-only. Macros persist in a static property for the worker lifetime and apply to every subsequent call on the macroable class.

Parameters

string $name
callable|object $macro

Return Value

void

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

Mix another object into the class.

Boot-only. Delegates to macro() for each method; registered macros persist in a static property for the worker lifetime.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

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

Check if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 68
static void flushMacros()

Flush the existing macros.

Boot or tests only. Clears worker-wide macros; concurrent coroutines may resolve different methods depending on timing.

Return Value

void

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

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line 23
__construct(FilesystemOperator $driver, FilesystemAdapter $adapter, array $config, Cloud $primary, Cloud $fallback, string $prefix = '', ReadThroughFilesystemAdapter|null $readThroughAdapter = null)

Create a new read-through filesystem instance.

Pooled disk decorators forward adapter methods that are not on the Cloud contract.

Parameters

FilesystemOperator $driver
FilesystemAdapter $adapter
array $config
Cloud $primary
Cloud $fallback
string $prefix
ReadThroughFilesystemAdapter|null $readThroughAdapter

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

Assert that the given file or directory exists.

Parameters

array|string $path
string|null $content

Return Value

FilesystemAdapter

in FilesystemAdapter at line 151
FilesystemAdapter 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

FilesystemAdapter

in FilesystemAdapter at line 169
FilesystemAdapter assertMissing(array|string $path)

Assert that the given file or directory does not exist.

Parameters

array|string $path

Return Value

FilesystemAdapter

in FilesystemAdapter at line 188
FilesystemAdapter assertDirectoryEmpty(string $path)

Assert that the given directory is empty.

Parameters

string $path

Return Value

FilesystemAdapter

in FilesystemAdapter at line 201
FilesystemAdapter assertEmpty()

Assert that the disk contains no files.

Return Value

FilesystemAdapter

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

Determine if a file or directory exists.

Parameters

string $path

Return Value

bool

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

Determine if a file or directory is missing.

Parameters

string $path

Return Value

bool

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

Determine if a file exists.

Parameters

string $path

Return Value

bool

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

Determine if a file is missing.

Parameters

string $path

Return Value

bool

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

Determine if a directory exists.

Parameters

string $path

Return Value

bool

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

Determine if a directory is missing.

Parameters

string $path

Return Value

bool

at line 40
string path(string $path)

Get the primary filesystem path, including both disks' prefixes.

Parameters

string $path

Return Value

string

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

Get the contents of a file.

Parameters

string $path

Return Value

string|null

in FilesystemAdapter at line 285
array|bool|float|int|string|null json(string $path, int $flags = 0)

Get the contents of a file as decoded JSON.

Parameters

string $path
int $flags

Return Value

array|bool|float|int|string|null

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

Create a streamed response for a given file.

Parameters

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

Return Value

StreamedResponse

Exceptions

UnableToRetrieveMetadata

in FilesystemAdapter at line 317
Response serve(Request $request, string $path, string|null $name = null, array $headers = [])

Create a streamed response for serving a given file.

Parameters

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

Return Value

Response

Exceptions

UnableToRetrieveMetadata

in FilesystemAdapter at line 329
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

Exceptions

UnableToRetrieveMetadata

in FilesystemAdapter at line 337
Image image(string $path)

Create an image instance from a file in storage.

Parameters

string $path

Return Value

Image

in FilesystemAdapter at line 348
protected StreamedResponse buildFileResponse(Request $request, string $path, string|null $name, array $headers, string $disposition)

Build a file response using the supplied request context.

Parameters

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

Return Value

StreamedResponse

in FilesystemAdapter at line 376
bool|string put(string $path, mixed $contents, mixed $options = [])

Write the contents of a file.

Parameters

string $path
mixed $contents
mixed $options

Return Value

bool|string

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

Store the uploaded file on the disk.

Parameters

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

Return Value

false|string

in FilesystemAdapter at line 430
false|string putFileAs(string|File|UploadedFile $path, array|string|File|UploadedFile|null $file, array|string|null $name = null, mixed $options = [])

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

Parameters

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

Return Value

false|string

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

Get the visibility for the given path.

Parameters

string $path

Return Value

string

in FilesystemAdapter at line 479
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 499
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 517
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 535
bool delete(array|string $paths)

Delete the file at a given path.

Parameters

array|string $paths

Return Value

bool

in FilesystemAdapter at line 561
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 581
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 601
int size(string $path)

Get the file size of a given file.

Parameters

string $path

Return Value

int

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

Get the checksum for a file.

Parameters

string $path
array $options

Return Value

false|string

Exceptions

UnableToProvideChecksum

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

Get the mime-type of a given file.

Parameters

string $path

Return Value

false|string

Exceptions

UnableToRetrieveMetadata

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

Get the file's last modification time.

Parameters

string $path

Return Value

int

in FilesystemAdapter at line 659
mixed readStream(string $path)

Get a resource to read the file.

Parameters

string $path

Return Value

mixed

the path resource or null on failure

at line 96
mixed readStreamRange(string $path, int|null $start, int|null $end)

Read a byte range using native cloud requests when promotion is unnecessary.

Parameters

string $path
int|null $start
int|null $end

Return Value

mixed

the path resource or null on failure

in FilesystemAdapter at line 766
protected array normalizeStreamRange(int|null $start, int|null $end)

Normalize and validate byte-range stream arguments.

Parameters

int|null $start
int|null $end

Return Value

array

in FilesystemAdapter at line 788
bool writeStream(string $path, mixed $resource, array $options = [])

Write a new file using a stream.

Parameters

string $path
mixed $resource
array $options

Return Value

bool

at line 48
string url(string $path)

Get the URL for the file at the given path.

Parameters

string $path

Return Value

string

in FilesystemAdapter at line 836
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 846
protected string getLocalUrl(string $path)

Get the URL for the file at the given path.

Parameters

string $path

Return Value

string

at line 84
bool providesTemporaryUrls()

Determine if temporary URLs can be generated.

Return Value

bool

at line 66
bool providesTemporaryUploadUrls()

Determine if temporary upload URLs can be generated.

Return Value

bool

at line 56
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 74
array|string 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|string

in FilesystemAdapter at line 930
protected string encodeUrlPath(string $path)

Encode a path for use in a URL.

Parameters

string $path

Return Value

string

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

Encode and concatenate a path to a URL.

Parameters

string $url
string $path

Return Value

string

in FilesystemAdapter at line 946
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 961
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

in FilesystemAdapter at line 979
array allFiles(string|null $directory = null)

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

Parameters

string|null $directory

Return Value

array

in FilesystemAdapter at line 989
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

in FilesystemAdapter at line 1006
array allDirectories(string|null $directory = null)

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

Parameters

string|null $directory

Return Value

array

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

Create a directory.

Parameters

string $path

Return Value

bool

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

Recursively delete a directory.

Parameters

string $directory

Return Value

bool

in FilesystemAdapter at line 1054
FilesystemOperator getDriver()

Get the Flysystem driver.

Return Value

FilesystemOperator

in FilesystemAdapter at line 1062
FilesystemAdapter getAdapter()

Get the Flysystem adapter.

Return Value

FilesystemAdapter

in FilesystemAdapter at line 1070
array getConfig()

Get the configuration values.

Return Value

array

in FilesystemAdapter at line 1080
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 1099
void serveUsing(Closure|null $callback)

Define a custom callback that generates file download responses.

Boot-only. The callback persists on the cached disk adapter for the worker lifetime and runs on every subsequent serve() call for that disk.

Parameters

Closure|null $callback

Return Value

void

in FilesystemAdapter at line 1111
void buildTemporaryUrlsUsing(Closure|null $callback)

Define a custom temporary URL builder callback.

Boot-only. The callback persists on the cached disk adapter for the worker lifetime and runs on every subsequent temporary URL generation for that disk.

Parameters

Closure|null $callback

Return Value

void

in FilesystemAdapter at line 1123
void buildTemporaryUploadUrlsUsing(Closure|null $callback)

Define a custom temporary upload URL builder callback.

Boot-only. The callback persists on the cached disk adapter for the worker lifetime and runs on every subsequent temporary upload URL generation for that disk.

Parameters

Closure|null $callback

Return Value

void

in FilesystemAdapter at line 1131
protected Closure|null prepareTemporaryUrlCallback(Closure|null $callback)

Prepare a temporary URL callback for direct invocation.

Parameters

Closure|null $callback

Return Value

Closure|null

in FilesystemAdapter at line 1150
protected bool throwsExceptions()

Determine if Flysystem exceptions should be thrown.

Return Value

bool

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

Report the exception.

Parameters

Throwable $exception

Return Value

void

Exceptions

Throwable

in FilesystemAdapter at line 1170
protected bool shouldReport()

Determine if Flysystem exceptions should be reported.

Return Value

bool

in FilesystemAdapter at line 1178
static void flushState()

Flush all static state.

Return Value

void

at line 123
protected Cloud readerFor(string $path)

Get the filesystem that contains the given path.

Parameters

string $path

Return Value

Cloud