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

ClientPooledFilesystem

class ClientPooledFilesystem implements Cloud

Traits

InteractsWithPooledFilesystem
Conditionable

Properties

protected Closure|null $serveCallback from  InteractsWithPooledFilesystem
protected Closure|null $temporaryUrlCallback from  InteractsWithPooledFilesystem
protected Closure|null $temporaryUploadUrlCallback from  InteractsWithPooledFilesystem

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
InteractsWithPooledFilesystem
assertExists(array|string $path, string|null $content = null)

Assert that the given file or directory exists.

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

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

from  InteractsWithPooledFilesystem
InteractsWithPooledFilesystem
assertMissing(array|string $path)

Assert that the given file or directory does not exist.

from  InteractsWithPooledFilesystem
InteractsWithPooledFilesystem
assertDirectoryEmpty(string $path)

Assert that the given directory is empty.

from  InteractsWithPooledFilesystem
InteractsWithPooledFilesystem
assertEmpty()

Assert that the disk contains no files.

from  InteractsWithPooledFilesystem
bool
exists(string $path)

Determine if a file or directory exists.

from  InteractsWithPooledFilesystem
bool
missing(string $path)

Determine if a file or directory is missing.

from  InteractsWithPooledFilesystem
bool
fileExists(string $path)

Determine if a file exists.

from  InteractsWithPooledFilesystem
bool
fileMissing(string $path)

Determine if a file is missing.

from  InteractsWithPooledFilesystem
bool
directoryExists(string $path)

Determine if a directory exists.

from  InteractsWithPooledFilesystem
bool
directoryMissing(string $path)

Determine if a directory is missing.

from  InteractsWithPooledFilesystem
string
path(string $path)

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

from  InteractsWithPooledFilesystem
bool
has(string $location)

Determine if a file or directory exists using the Flysystem operator.

from  InteractsWithPooledFilesystem
string
read(string $location)

Read a file using the Flysystem operator.

from  InteractsWithPooledFilesystem
int
fileSize(string $path)

Get a file size using the Flysystem operator.

from  InteractsWithPooledFilesystem
string
visibility(string $path)

Get raw Flysystem visibility for a path.

from  InteractsWithPooledFilesystem
void
write(string $location, string $contents, array $config = [])

Write a file using the Flysystem operator.

from  InteractsWithPooledFilesystem
void
createDirectory(string $location, array $config = [])

Create a directory using the Flysystem operator.

from  InteractsWithPooledFilesystem
string|null
get(string $path)

Get the contents of a file.

from  InteractsWithPooledFilesystem
array|bool|float|int|string|null
json(string $path, int $flags = 0)

Get the contents of a file as decoded JSON.

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

Create a streamed response for a given file.

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

Create a streamed response for serving a given file.

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

Create a streamed download response for a given file.

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

Write the contents of a file.

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

Store the uploaded file on the disk.

from  InteractsWithPooledFilesystem
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  InteractsWithPooledFilesystem
string
getVisibility(string $path)

Get the visibility for the given path.

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

Set the visibility for the given path.

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

Prepend to a file.

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

Append to a file.

from  InteractsWithPooledFilesystem
bool
delete(array|string $paths)

Delete the file at a given path.

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

Copy a file to a new location.

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

Move a file to a new location.

from  InteractsWithPooledFilesystem
int
size(string $path)

Get the file size of a given file.

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

Get the checksum for a file.

from  InteractsWithPooledFilesystem
false|string
mimeType(string $path)

Get the mime-type of a given file.

from  InteractsWithPooledFilesystem
int
lastModified(string $path)

Get the file's last modification time.

from  InteractsWithPooledFilesystem
mixed
readStream(string $path)

Get a resource to read the file.

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

Get a resource to read the partial file.

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

Write a new file using a stream.

from  InteractsWithPooledFilesystem
string
url(string $path)

Get the URL for the file at the given path.

from  InteractsWithPooledFilesystem
bool
providesTemporaryUrls()

Determine if temporary URLs can be generated.

from  InteractsWithPooledFilesystem
bool
providesTemporaryUploadUrls()

Determine if temporary upload URLs can be generated.

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

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

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

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

from  InteractsWithPooledFilesystem
array
files(string|null $directory = null, bool $recursive = false)

Get an array of all files in a directory.

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

Get all of the files from the given directory recursively.

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

Get all of the directories within a given directory.

from  InteractsWithPooledFilesystem
array
allDirectories(string|null $directory = null)

Get all of the directories within a given directory recursively.

from  InteractsWithPooledFilesystem
bool
makeDirectory(string $path)

Create a directory.

from  InteractsWithPooledFilesystem
bool
deleteDirectory(string $directory)

Recursively delete a directory.

from  InteractsWithPooledFilesystem
never
getDriver()

Reject access to the borrowed Flysystem driver.

from  InteractsWithPooledFilesystem
never
getAdapter()

Reject access to the borrowed Flysystem adapter.

from  InteractsWithPooledFilesystem
never
getClient()

Reject access to a borrowed client.

from  InteractsWithPooledFilesystem
mixed
withDriver(Closure $callback)

Run a callback with borrow-scoped access to the Flysystem driver.

from  InteractsWithPooledFilesystem
mixed
withAdapter(Closure $callback)

Run a callback with borrow-scoped access to the Flysystem adapter.

from  InteractsWithPooledFilesystem
mixed
withClient(Closure $callback)

Run a callback with borrow-scoped access to the driver client.

from  InteractsWithPooledFilesystem
array
getConfig()

Get the disk configuration.

from  InteractsWithPooledFilesystem
void
serveUsing(Closure|null $callback)

Define a custom callback that generates file download responses.

from  InteractsWithPooledFilesystem
void
buildTemporaryUrlsUsing(Closure|null $callback)

Define a custom temporary URL builder callback.

from  InteractsWithPooledFilesystem
void
buildTemporaryUploadUrlsUsing(Closure|null $callback)

Define a custom temporary upload URL builder callback.

from  InteractsWithPooledFilesystem
mixed
invoke(string $method, array $parameters)

Invoke a synchronous method against a per-operation stack.

mixed
leasedStream(Closure $operation)

Open a stream that owns its client lease until closure.

mixed
withBorrowedAccessor(string $accessor, Closure $callback)

Run a callback with an accessor result from a per-operation stack.

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

Build a file response using short borrows and a leased stream.

from  InteractsWithPooledFilesystem
RuntimeException
borrowedInternalsException()

Create the exception used for every rejected borrowed-internal accessor.

from  InteractsWithPooledFilesystem
never
__call(string $method, array $parameters)

Reject methods that have not been audited for deferred results.

from  InteractsWithPooledFilesystem
__construct(PoolDefinition $definition, Closure $clientFactory, Closure $stackFactory, Factory $pools, array $config, Closure|null $releaseCallback = null)

Create a client-pooled filesystem.

PoolDefinition
getDefinition()

Get the pooled client's definition.

string
getPoolName()

Get the pooled client's identity.

bool
invalidatePool()

Remove and close the current client pool.

mixed
withStack(Closure $operation)

Run an operation against a stack built around a borrowed client.

mixed
withBorrowed(Closure $operation)

Run an operation against a stack and its borrowed client.

array
leaseStack()

Borrow a client and build its per-operation adapter stack.

FilesystemAdapter
buildStack(object $client)

Build a disk stack and apply every proxy-held callback.

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 InteractsWithPooledFilesystem at line 35
InteractsWithPooledFilesystem 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

InteractsWithPooledFilesystem

in InteractsWithPooledFilesystem at line 45
InteractsWithPooledFilesystem 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

InteractsWithPooledFilesystem

in InteractsWithPooledFilesystem at line 55
InteractsWithPooledFilesystem assertMissing(array|string $path)

Assert that the given file or directory does not exist.

Parameters

array|string $path

Return Value

InteractsWithPooledFilesystem

in InteractsWithPooledFilesystem at line 65
InteractsWithPooledFilesystem assertDirectoryEmpty(string $path)

Assert that the given directory is empty.

Parameters

string $path

Return Value

InteractsWithPooledFilesystem

in InteractsWithPooledFilesystem at line 75
InteractsWithPooledFilesystem assertEmpty()

Assert that the disk contains no files.

Return Value

InteractsWithPooledFilesystem

in InteractsWithPooledFilesystem at line 85
bool exists(string $path)

Determine if a file or directory exists.

Parameters

string $path

Return Value

bool

in InteractsWithPooledFilesystem at line 93
bool missing(string $path)

Determine if a file or directory is missing.

Parameters

string $path

Return Value

bool

in InteractsWithPooledFilesystem at line 101
bool fileExists(string $path)

Determine if a file exists.

Parameters

string $path

Return Value

bool

in InteractsWithPooledFilesystem at line 109
bool fileMissing(string $path)

Determine if a file is missing.

Parameters

string $path

Return Value

bool

in InteractsWithPooledFilesystem at line 117
bool directoryExists(string $path)

Determine if a directory exists.

Parameters

string $path

Return Value

bool

in InteractsWithPooledFilesystem at line 125
bool directoryMissing(string $path)

Determine if a directory is missing.

Parameters

string $path

Return Value

bool

in InteractsWithPooledFilesystem at line 133
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 InteractsWithPooledFilesystem at line 141
bool has(string $location)

Determine if a file or directory exists using the Flysystem operator.

Parameters

string $location

Return Value

bool

in InteractsWithPooledFilesystem at line 149
string read(string $location)

Read a file using the Flysystem operator.

Parameters

string $location

Return Value

string

in InteractsWithPooledFilesystem at line 157
int fileSize(string $path)

Get a file size using the Flysystem operator.

Parameters

string $path

Return Value

int

in InteractsWithPooledFilesystem at line 165
string visibility(string $path)

Get raw Flysystem visibility for a path.

Parameters

string $path

Return Value

string

in InteractsWithPooledFilesystem at line 173
void write(string $location, string $contents, array $config = [])

Write a file using the Flysystem operator.

Parameters

string $location
string $contents
array $config

Return Value

void

in InteractsWithPooledFilesystem at line 181
void createDirectory(string $location, array $config = [])

Create a directory using the Flysystem operator.

Parameters

string $location
array $config

Return Value

void

in InteractsWithPooledFilesystem at line 189
string|null get(string $path)

Get the contents of a file.

Parameters

string $path

Return Value

string|null

in InteractsWithPooledFilesystem at line 197
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 InteractsWithPooledFilesystem at line 205
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

in InteractsWithPooledFilesystem at line 223
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

in InteractsWithPooledFilesystem at line 233
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 InteractsWithPooledFilesystem at line 243
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 InteractsWithPooledFilesystem at line 251
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 InteractsWithPooledFilesystem at line 262
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 InteractsWithPooledFilesystem at line 274
string getVisibility(string $path)

Get the visibility for the given path.

Parameters

string $path

Return Value

string

in InteractsWithPooledFilesystem at line 282
bool setVisibility(string $path, string $visibility)

Set the visibility for the given path.

Parameters

string $path
string $visibility

Return Value

bool

in InteractsWithPooledFilesystem at line 290
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 InteractsWithPooledFilesystem at line 298
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 InteractsWithPooledFilesystem at line 306
bool delete(array|string $paths)

Delete the file at a given path.

Parameters

array|string $paths

Return Value

bool

in InteractsWithPooledFilesystem at line 314
bool copy(string $from, string $to)

Copy a file to a new location.

Parameters

string $from
string $to

Return Value

bool

in InteractsWithPooledFilesystem at line 322
bool move(string $from, string $to)

Move a file to a new location.

Parameters

string $from
string $to

Return Value

bool

in InteractsWithPooledFilesystem at line 330
int size(string $path)

Get the file size of a given file.

Parameters

string $path

Return Value

int

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

Get the checksum for a file.

Parameters

string $path
array $options

Return Value

false|string

in InteractsWithPooledFilesystem at line 346
false|string mimeType(string $path)

Get the mime-type of a given file.

Parameters

string $path

Return Value

false|string

in InteractsWithPooledFilesystem at line 354
int lastModified(string $path)

Get the file's last modification time.

Parameters

string $path

Return Value

int

in InteractsWithPooledFilesystem at line 364
mixed readStream(string $path)

Get a resource to read the file.

Parameters

string $path

Return Value

mixed

the leased resource or null on failure

in InteractsWithPooledFilesystem at line 376
mixed readStreamRange(string $path, int|null $start, int|null $end)

Get a resource to read the partial file.

Parameters

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

Return Value

mixed

the leased resource or null on failure

in InteractsWithPooledFilesystem at line 388
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

in InteractsWithPooledFilesystem at line 396
string url(string $path)

Get the URL for the file at the given path.

Parameters

string $path

Return Value

string

in InteractsWithPooledFilesystem at line 404
bool providesTemporaryUrls()

Determine if temporary URLs can be generated.

Return Value

bool

in InteractsWithPooledFilesystem at line 412
bool providesTemporaryUploadUrls()

Determine if temporary upload URLs can be generated.

Return Value

bool

in InteractsWithPooledFilesystem at line 420
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 InteractsWithPooledFilesystem at line 428
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 InteractsWithPooledFilesystem at line 439
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 InteractsWithPooledFilesystem at line 447
array allFiles(string|null $directory = null)

Get all of the files from the given directory recursively.

Parameters

string|null $directory

Return Value

array

in InteractsWithPooledFilesystem at line 455
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 InteractsWithPooledFilesystem at line 463
array allDirectories(string|null $directory = null)

Get all of the directories within a given directory recursively.

Parameters

string|null $directory

Return Value

array

in InteractsWithPooledFilesystem at line 471
bool makeDirectory(string $path)

Create a directory.

Parameters

string $path

Return Value

bool

in InteractsWithPooledFilesystem at line 479
bool deleteDirectory(string $directory)

Recursively delete a directory.

Parameters

string $directory

Return Value

bool

in InteractsWithPooledFilesystem at line 487
never getDriver()

Reject access to the borrowed Flysystem driver.

Return Value

never

in InteractsWithPooledFilesystem at line 495
never getAdapter()

Reject access to the borrowed Flysystem adapter.

Return Value

never

in InteractsWithPooledFilesystem at line 503
never getClient()

Reject access to a borrowed client.

Return Value

never

in InteractsWithPooledFilesystem at line 511
mixed withDriver(Closure $callback)

Run a callback with borrow-scoped access to the Flysystem driver.

Parameters

Closure $callback

Return Value

mixed

in InteractsWithPooledFilesystem at line 519
mixed withAdapter(Closure $callback)

Run a callback with borrow-scoped access to the Flysystem adapter.

Parameters

Closure $callback

Return Value

mixed

in InteractsWithPooledFilesystem at line 527
mixed withClient(Closure $callback)

Run a callback with borrow-scoped access to the driver client.

Parameters

Closure $callback

Return Value

mixed

in InteractsWithPooledFilesystem at line 537
array getConfig()

Get the disk configuration.

Nested objects remain shared references; the configuration is not deep-copied.

Return Value

array

in InteractsWithPooledFilesystem at line 548
void serveUsing(Closure|null $callback)

Define a custom callback that generates file download responses.

Boot-only. The callback persists on the manager-cached disk for the worker lifetime and is written to every borrowed adapter.

Parameters

Closure|null $callback

Return Value

void

in InteractsWithPooledFilesystem at line 559
void buildTemporaryUrlsUsing(Closure|null $callback)

Define a custom temporary URL builder callback.

Boot-only. The callback persists on the manager-cached disk for the worker lifetime and is written to every borrowed adapter.

Parameters

Closure|null $callback

Return Value

void

in InteractsWithPooledFilesystem at line 570
void buildTemporaryUploadUrlsUsing(Closure|null $callback)

Define a custom temporary upload URL builder callback.

Boot-only. The callback persists on the manager-cached disk for the worker lifetime and is written to every borrowed adapter.

Parameters

Closure|null $callback

Return Value

void

at line 65
protected mixed invoke(string $method, array $parameters)

Invoke a synchronous method against a per-operation stack.

Parameters

string $method
array $parameters

Return Value

mixed

at line 167
protected mixed leasedStream(Closure $operation)

Open a stream that owns its client lease until closure.

Parameters

Closure $operation

Return Value

mixed

at line 195
protected mixed withBorrowedAccessor(string $accessor, Closure $callback)

Run a callback with an accessor result from a per-operation stack.

Parameters

string $accessor
Closure $callback

Return Value

mixed

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

Build a file response using short borrows and a leased stream.

Parameters

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

Return Value

StreamedResponse

in InteractsWithPooledFilesystem at line 621
protected RuntimeException borrowedInternalsException()

Create the exception used for every rejected borrowed-internal accessor.

Return Value

RuntimeException

in InteractsWithPooledFilesystem at line 632
never __call(string $method, array $parameters)

Reject methods that have not been audited for deferred results.

Parameters

string $method
array $parameters

Return Value

never

at line 28
__construct(PoolDefinition $definition, Closure $clientFactory, Closure $stackFactory, Factory $pools, array $config, Closure|null $releaseCallback = null)

Create a client-pooled filesystem.

Parameters

PoolDefinition $definition
Closure $clientFactory
Closure $stackFactory
Factory $pools
array $config
Closure|null $releaseCallback

at line 41
PoolDefinition getDefinition()

Get the pooled client's definition.

Return Value

PoolDefinition

at line 49
string getPoolName()

Get the pooled client's identity.

Return Value

string

at line 57
bool invalidatePool()

Remove and close the current client pool.

Return Value

bool

at line 77
protected mixed withStack(Closure $operation)

Run an operation against a stack built around a borrowed client.

Parameters

Closure $operation

Return Value

mixed

at line 89
protected mixed withBorrowed(Closure $operation)

Run an operation against a stack and its borrowed client.

Parameters

Closure $operation

Return Value

mixed

at line 115
protected array leaseStack()

Borrow a client and build its per-operation adapter stack.

Return Value

array

at line 136
protected FilesystemAdapter buildStack(object $client)

Build a disk stack and apply every proxy-held callback.

Parameters

object $client

Return Value

FilesystemAdapter