FilesystemPoolProxy
class FilesystemPoolProxy extends PoolProxy implements Cloud
Traits
Properties
| protected Closure|null | $serveCallback | from InteractsWithPooledFilesystem | |
| protected Closure|null | $temporaryUrlCallback | from InteractsWithPooledFilesystem | |
| protected Closure|null | $temporaryUploadUrlCallback | from InteractsWithPooledFilesystem |
Methods
Create a whole-driver pooled filesystem proxy.
Invoke a synchronous method within one borrow.
Apply every proxy-held callback slot to a borrowed adapter.
Apply the callback if the given "value" is (or resolves to) truthy.
Apply the callback if the given "value" is (or resolves to) falsy.
Copy a file to another disk.
Move a file to another disk.
Transfer a file without holding a source lease during the destination write.
Assert that the given file or directory exists.
Assert that the number of files in path equals the expected count.
Assert that the given file or directory does not exist.
Assert that the given directory is empty.
Assert that the disk contains no files.
Determine if a file or directory exists.
Determine if a file or directory is missing.
Determine if a directory exists.
Determine if a directory is missing.
Get the full path to the file that exists at the given relative path.
Determine if a file or directory exists using the Flysystem operator.
Read a file using the Flysystem operator.
Get a file size using the Flysystem operator.
Get raw Flysystem visibility for a path.
Write a file using the Flysystem operator.
Create a directory using the Flysystem operator.
Get the contents of a file as decoded JSON.
Create a streamed response for a given file.
Create a streamed download response for a given file.
Create an image instance from a file in storage.
Write the contents of a file.
Store the uploaded file on the disk.
Store the uploaded file on the disk with a given name.
Get the visibility for the given path.
Set the visibility for the given path.
Prepend to a file.
Append to a file.
Delete the file at a given path.
Copy a file to a new location.
Move a file to a new location.
Get the checksum for a file.
Get the mime-type of a given file.
Get the file's last modification time.
Get a resource to read the partial file.
Write a new file using a stream.
Get the URL for the file at the given path.
Determine if temporary URLs can be generated.
Determine if temporary upload URLs can be generated.
Get a temporary URL for the file at the given path.
Get a temporary upload URL for the file at the given path.
Get an array of all files in a directory.
Get all of the files from the given directory recursively.
Get all of the directories within a given directory.
Get all of the directories within a given directory recursively.
Recursively delete a directory.
Reject access to the borrowed Flysystem driver.
Reject access to the borrowed Flysystem adapter.
Get an operator that owns each operation's borrow and each stream's lease.
Define a custom temporary upload URL builder callback.
Run a callback with an accessor result from a borrowed driver.
Build a file response using short borrows and a leased stream.
Create the exception used for every rejected borrowed-internal accessor.
Reject methods that have not been audited for deferred results.
Details
at line 24
__construct(PoolDefinition $definition, Closure $createCallback, Factory $pools, array $config, Closure|null $releaseCallback = null)
Create a whole-driver pooled filesystem proxy.
in
PoolProxy at line 29
protected ObjectPool
pool()
Resolve the current pool for this proxy's definition.
in
InteractsWithPooledFilesystem at line 624
abstract protected mixed
invoke(string $method, array $parameters)
Invoke a synchronous method within one borrow.
at line 37
protected void
configureBorrowed(object $object)
Apply every proxy-held callback slot to a borrowed adapter.
in
PoolProxy at line 80
PoolDefinition
getDefinition()
Get this proxy's immutable pool definition.
in
PoolProxy at line 88
string
getPoolName()
Return the pool's fully qualified registry name.
in
PoolProxy at line 96
bool
invalidatePool()
Remove and close this proxy's current shared pool.
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.
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.
in
TransfersFiles at line 21
bool
copyToDisk(Filesystem|string|UnitEnum $disk, string $from, string|null $to = null)
Copy a file to another disk.
in
TransfersFiles at line 33
bool
moveToDisk(Filesystem|string|UnitEnum $disk, string $from, string|null $to = null)
Move a file to another disk.
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.
in
InteractsWithPooledFilesystem at line 42
InteractsWithPooledFilesystem
assertExists(array|string $path, string|null $content = null)
Assert that the given file or directory exists.
in
InteractsWithPooledFilesystem at line 52
InteractsWithPooledFilesystem
assertCount(string $path, int $count, bool $recursive = false)
Assert that the number of files in path equals the expected count.
in
InteractsWithPooledFilesystem at line 62
InteractsWithPooledFilesystem
assertMissing(array|string $path)
Assert that the given file or directory does not exist.
in
InteractsWithPooledFilesystem at line 72
InteractsWithPooledFilesystem
assertDirectoryEmpty(string $path)
Assert that the given directory is empty.
in
InteractsWithPooledFilesystem at line 82
InteractsWithPooledFilesystem
assertEmpty()
Assert that the disk contains no files.
in
InteractsWithPooledFilesystem at line 92
bool
exists(string $path)
Determine if a file or directory exists.
in
InteractsWithPooledFilesystem at line 100
bool
missing(string $path)
Determine if a file or directory is missing.
in
InteractsWithPooledFilesystem at line 108
bool
fileExists(string $path)
Determine if a file exists.
in
InteractsWithPooledFilesystem at line 116
bool
fileMissing(string $path)
Determine if a file is missing.
in
InteractsWithPooledFilesystem at line 124
bool
directoryExists(string $path)
Determine if a directory exists.
in
InteractsWithPooledFilesystem at line 132
bool
directoryMissing(string $path)
Determine if a directory is missing.
in
InteractsWithPooledFilesystem at line 140
string
path(string $path)
Get the full path to the file that exists at the given relative path.
in
InteractsWithPooledFilesystem at line 148
bool
has(string $location)
Determine if a file or directory exists using the Flysystem operator.
in
InteractsWithPooledFilesystem at line 156
string
read(string $location)
Read a file using the Flysystem operator.
in
InteractsWithPooledFilesystem at line 164
int
fileSize(string $path)
Get a file size using the Flysystem operator.
in
InteractsWithPooledFilesystem at line 172
string
visibility(string $path)
Get raw Flysystem visibility for a path.
in
InteractsWithPooledFilesystem at line 180
void
write(string $location, string $contents, array $config = [])
Write a file using the Flysystem operator.
in
InteractsWithPooledFilesystem at line 188
void
createDirectory(string $location, array $config = [])
Create a directory using the Flysystem operator.
in
InteractsWithPooledFilesystem at line 196
string|null
get(string $path)
Get the contents of a file.
in
InteractsWithPooledFilesystem at line 204
array|bool|float|int|string|null
json(string $path, int $flags = 0)
Get the contents of a file as decoded JSON.
in
InteractsWithPooledFilesystem at line 212
StreamedResponse
response(string $path, string|null $name = null, array $headers = [], string $disposition = 'inline')
Create a streamed response for a given file.
in
InteractsWithPooledFilesystem at line 230
Response
serve(Request $request, string $path, string|null $name = null, array $headers = [])
Create a streamed response for serving a given file.
in
InteractsWithPooledFilesystem at line 240
StreamedResponse
download(string $path, string|null $name = null, array $headers = [])
Create a streamed download response for a given file.
in
InteractsWithPooledFilesystem at line 248
Image
image(string $path)
Create an image instance from a file in storage.
in
InteractsWithPooledFilesystem at line 261
bool|string
put(string $path, mixed $contents, mixed $options = [])
Write the contents of a file.
in
InteractsWithPooledFilesystem at line 269
false|string
putFile(string|File|UploadedFile $path, array|string|File|UploadedFile|null $file = null, mixed $options = [])
Store the uploaded file on the disk.
in
InteractsWithPooledFilesystem at line 280
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.
in
InteractsWithPooledFilesystem at line 292
string
getVisibility(string $path)
Get the visibility for the given path.
in
InteractsWithPooledFilesystem at line 300
bool
setVisibility(string $path, string $visibility)
Set the visibility for the given path.
in
InteractsWithPooledFilesystem at line 308
bool
prepend(string $path, string $data, string $separator = PHP_EOL)
Prepend to a file.
in
InteractsWithPooledFilesystem at line 316
bool
append(string $path, string $data, string $separator = PHP_EOL)
Append to a file.
in
InteractsWithPooledFilesystem at line 324
bool
delete(array|string $paths)
Delete the file at a given path.
in
InteractsWithPooledFilesystem at line 332
bool
copy(string $from, string $to)
Copy a file to a new location.
in
InteractsWithPooledFilesystem at line 340
bool
move(string $from, string $to)
Move a file to a new location.
in
InteractsWithPooledFilesystem at line 348
int
size(string $path)
Get the file size of a given file.
in
InteractsWithPooledFilesystem at line 356
false|string
checksum(string $path, array $options = [])
Get the checksum for a file.
in
InteractsWithPooledFilesystem at line 364
false|string
mimeType(string $path)
Get the mime-type of a given file.
in
InteractsWithPooledFilesystem at line 372
int
lastModified(string $path)
Get the file's last modification time.
in
InteractsWithPooledFilesystem at line 382
mixed
readStream(string $path)
Get a resource to read the file.
in
InteractsWithPooledFilesystem at line 394
mixed
readStreamRange(string $path, int|null $start, int|null $end)
Get a resource to read the partial file.
in
InteractsWithPooledFilesystem at line 406
bool
writeStream(string $path, mixed $resource, array $options = [])
Write a new file using a stream.
in
InteractsWithPooledFilesystem at line 414
string
url(string $path)
Get the URL for the file at the given path.
in
InteractsWithPooledFilesystem at line 422
bool
providesTemporaryUrls()
Determine if temporary URLs can be generated.
in
InteractsWithPooledFilesystem at line 430
bool
providesTemporaryUploadUrls()
Determine if temporary upload URLs can be generated.
in
InteractsWithPooledFilesystem at line 438
string
temporaryUrl(string $path, DateTimeInterface $expiration, array $options = [])
Get a temporary URL for the file at the given path.
in
InteractsWithPooledFilesystem at line 446
array|string
temporaryUploadUrl(string $path, DateTimeInterface $expiration, array $options = [])
Get a temporary upload URL for the file at the given path.
in
InteractsWithPooledFilesystem at line 457
array
files(string|null $directory = null, bool $recursive = false)
Get an array of all files in a directory.
in
InteractsWithPooledFilesystem at line 465
array
allFiles(string|null $directory = null)
Get all of the files from the given directory recursively.
in
InteractsWithPooledFilesystem at line 473
array
directories(string|null $directory = null, bool $recursive = false)
Get all of the directories within a given directory.
in
InteractsWithPooledFilesystem at line 481
array
allDirectories(string|null $directory = null)
Get all of the directories within a given directory recursively.
in
InteractsWithPooledFilesystem at line 489
bool
makeDirectory(string $path)
Create a directory.
in
InteractsWithPooledFilesystem at line 497
bool
deleteDirectory(string $directory)
Recursively delete a directory.
in
InteractsWithPooledFilesystem at line 505
never
getDriver()
Reject access to the borrowed Flysystem driver.
in
InteractsWithPooledFilesystem at line 513
never
getAdapter()
Reject access to the borrowed Flysystem adapter.
in
InteractsWithPooledFilesystem at line 521
never
getClient()
Reject access to a borrowed client.
in
InteractsWithPooledFilesystem at line 529
mixed
withDriver(Closure $callback)
Run a callback with borrow-scoped access to the Flysystem driver.
in
InteractsWithPooledFilesystem at line 537
FilesystemOperator
getOperator()
Get an operator that owns each operation's borrow and each stream's lease.
in
InteractsWithPooledFilesystem at line 565
mixed
withAdapter(Closure $callback)
Run a callback with borrow-scoped access to the Flysystem adapter.
in
InteractsWithPooledFilesystem at line 573
mixed
withClient(Closure $callback)
Run a callback with borrow-scoped access to the driver client.
in
InteractsWithPooledFilesystem at line 583
array
getConfig()
Get the disk configuration.
Nested objects remain shared references; the configuration is not deep-copied.
in
InteractsWithPooledFilesystem at line 594
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.
in
InteractsWithPooledFilesystem at line 605
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.
in
InteractsWithPooledFilesystem at line 616
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.
at line 70
protected mixed
leasedStream(Closure $operation)
Open a stream that owns its whole-driver lease until closure.
at line 93
protected mixed
withBorrowedAccessor(string $accessor, Closure $callback)
Run a callback with an accessor result from a borrowed driver.
in
InteractsWithPooledFilesystem at line 641
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.
in
InteractsWithPooledFilesystem at line 667
protected RuntimeException
borrowedInternalsException()
Create the exception used for every rejected borrowed-internal accessor.
in
InteractsWithPooledFilesystem at line 678
never
__call(string $method, array $parameters)
Reject methods that have not been audited for deferred results.