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

ScopedCloudFilesystemProxy

class ScopedCloudFilesystemProxy extends ScopedFilesystemProxy implements Cloud

Traits

Conditionable

Properties

protected PathNormalizer $normalizer from  ScopedFilesystemProxy

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
__construct(Filesystem|Closure $disk, Closure $prefixResolver, bool $allowRootPassthrough = false)

Create a dynamically scoped cloud filesystem.

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

Assert that the given file or directory exists.

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

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

from  ScopedFilesystemProxy
ScopedFilesystemProxy
assertMissing(array|string $path)

Assert that the given file or directory does not exist.

from  ScopedFilesystemProxy
ScopedFilesystemProxy
assertDirectoryEmpty(string $path)

Assert that the given directory is empty.

from  ScopedFilesystemProxy
ScopedFilesystemProxy
assertEmpty()

Assert that the scoped disk contains no files.

from  ScopedFilesystemProxy
string
path(string $path)

Get the full path to a scoped file.

from  ScopedFilesystemProxy
bool
has(string $location)

Determine if a scoped path exists using the Flysystem operator.

from  ScopedFilesystemProxy
string
read(string $location)

Read a scoped file using the Flysystem operator.

from  ScopedFilesystemProxy
int
fileSize(string $path)

Get a scoped file size using the Flysystem operator.

from  ScopedFilesystemProxy
string
visibility(string $path)

Get raw Flysystem visibility for a scoped path.

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

Write a scoped file using the Flysystem operator.

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

Create a scoped directory using the Flysystem operator.

from  ScopedFilesystemProxy
bool
exists(string $path)

Determine if a scoped file or directory exists.

from  ScopedFilesystemProxy
bool
missing(string $path)

Determine if a scoped file or directory is missing.

from  ScopedFilesystemProxy
bool
fileExists(string $path)

Determine if a scoped file exists.

from  ScopedFilesystemProxy
bool
fileMissing(string $path)

Determine if a scoped file is missing.

from  ScopedFilesystemProxy
bool
directoryExists(string $path)

Determine if a scoped directory exists.

from  ScopedFilesystemProxy
bool
directoryMissing(string $path)

Determine if a scoped directory is missing.

from  ScopedFilesystemProxy
string|null
get(string $path)

Get the contents of a scoped file.

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

Get the contents of a scoped file as decoded JSON.

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

Create a streamed response for a scoped file.

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

Create a streamed response for serving a scoped file.

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

Create a streamed download response for a scoped file.

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

Write the contents of a scoped file.

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

Store an uploaded file on the scoped disk.

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

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

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

Write a scoped file using a stream.

from  ScopedFilesystemProxy
string
getVisibility(string $path)

Get the visibility for a scoped path.

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

Set the visibility for a scoped path.

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

Prepend to a scoped file.

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

Append to a scoped file.

from  ScopedFilesystemProxy
bool
delete(array|string $paths)

Delete scoped files.

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

Copy a scoped file to another scoped path.

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

Move a scoped file to another scoped path.

from  ScopedFilesystemProxy
int
size(string $path)

Get the size of a scoped file.

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

Get the checksum of a scoped file.

from  ScopedFilesystemProxy
false|string
mimeType(string $path)

Get the MIME type of a scoped file.

from  ScopedFilesystemProxy
int
lastModified(string $path)

Get the last modification time of a scoped file.

from  ScopedFilesystemProxy
mixed
readStream(string $path)

Get a stream for a scoped file.

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

Get a partial stream for a scoped file.

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

Get a temporary URL for a scoped file.

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

Get a temporary upload URL for a scoped file.

from  ScopedFilesystemProxy
bool
providesTemporaryUrls()

Determine if the inner disk provides temporary URLs.

from  ScopedFilesystemProxy
bool
providesTemporaryUploadUrls()

Determine if the inner disk provides temporary upload URLs.

from  ScopedFilesystemProxy
array
getConfig()

Get the inner disk configuration.

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

Get scoped files in a directory.

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

Get all scoped files in a directory recursively.

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

Get scoped directories in a directory.

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

Get all scoped directories in a directory recursively.

from  ScopedFilesystemProxy
bool
makeDirectory(string $path)

Create a scoped directory.

from  ScopedFilesystemProxy
bool
deleteDirectory(string $directory)

Delete a scoped directory recursively.

from  ScopedFilesystemProxy
never
getDriver()

Reject access to the inner Flysystem driver.

from  ScopedFilesystemProxy
never
getAdapter()

Reject access to the inner Flysystem adapter.

from  ScopedFilesystemProxy
never
getClient()

Reject access to the inner driver client.

from  ScopedFilesystemProxy
never
serveUsing(Closure|null $callback)

Reject mutation of the shared inner disk's serve callback.

from  ScopedFilesystemProxy
never
buildTemporaryUrlsUsing(Closure|null $callback)

Reject mutation of the shared inner disk's temporary URL callback.

from  ScopedFilesystemProxy
never
buildTemporaryUploadUrlsUsing(Closure|null $callback)

Reject mutation of the shared inner disk's temporary upload URL callback.

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

Reject calls that have not been explicitly mapped through the prefix boundary.

from  ScopedFilesystemProxy
string
prefix()

Resolve and validate the prefix for one public operation.

from  ScopedFilesystemProxy
string
applyPrefix(string $prefix, string $path)

Apply a validated prefix to a normalized user path.

from  ScopedFilesystemProxy
string
stripPrefix(string $prefix, string $path)

Strip a validated prefix from an inner returned path.

from  ScopedFilesystemProxy
Filesystem
resolveDisk()

Resolve the inner cloud filesystem for one public operation.

mixed
call(string $method, array $arguments)

Forward one audited method to the inner disk.

from  ScopedFilesystemProxy
RuntimeException
unsupportedMutationOrInternal(string $method)

Create the exception for every rejected internal or shared-state mutator.

from  ScopedFilesystemProxy
string
url(string $path)

Get the URL for a scoped file.

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

at line 21
__construct(Filesystem|Closure $disk, Closure $prefixResolver, bool $allowRootPassthrough = false)

Create a dynamically scoped cloud filesystem.

Parameters

Filesystem|Closure $disk
Closure $prefixResolver
bool $allowRootPassthrough

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

ScopedFilesystemProxy

in ScopedFilesystemProxy at line 68
ScopedFilesystemProxy 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

ScopedFilesystemProxy

in ScopedFilesystemProxy at line 79
ScopedFilesystemProxy assertMissing(array|string $path)

Assert that the given file or directory does not exist.

Parameters

array|string $path

Return Value

ScopedFilesystemProxy

in ScopedFilesystemProxy at line 93
ScopedFilesystemProxy assertDirectoryEmpty(string $path)

Assert that the given directory is empty.

Parameters

string $path

Return Value

ScopedFilesystemProxy

in ScopedFilesystemProxy at line 104
ScopedFilesystemProxy assertEmpty()

Assert that the scoped disk contains no files.

Return Value

ScopedFilesystemProxy

in ScopedFilesystemProxy at line 115
string path(string $path)

Get the full path to a scoped file.

Parameters

string $path

Return Value

string

in ScopedFilesystemProxy at line 125
bool has(string $location)

Determine if a scoped path exists using the Flysystem operator.

Parameters

string $location

Return Value

bool

in ScopedFilesystemProxy at line 135
string read(string $location)

Read a scoped file using the Flysystem operator.

Parameters

string $location

Return Value

string

in ScopedFilesystemProxy at line 145
int fileSize(string $path)

Get a scoped file size using the Flysystem operator.

Parameters

string $path

Return Value

int

in ScopedFilesystemProxy at line 155
string visibility(string $path)

Get raw Flysystem visibility for a scoped path.

Parameters

string $path

Return Value

string

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

Write a scoped file using the Flysystem operator.

Parameters

string $location
string $contents
array $config

Return Value

void

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

Create a scoped directory using the Flysystem operator.

Parameters

string $location
array $config

Return Value

void

in ScopedFilesystemProxy at line 183
bool exists(string $path)

Determine if a scoped file or directory exists.

Parameters

string $path

Return Value

bool

in ScopedFilesystemProxy at line 193
bool missing(string $path)

Determine if a scoped file or directory is missing.

Parameters

string $path

Return Value

bool

in ScopedFilesystemProxy at line 203
bool fileExists(string $path)

Determine if a scoped file exists.

Parameters

string $path

Return Value

bool

in ScopedFilesystemProxy at line 213
bool fileMissing(string $path)

Determine if a scoped file is missing.

Parameters

string $path

Return Value

bool

in ScopedFilesystemProxy at line 223
bool directoryExists(string $path)

Determine if a scoped directory exists.

Parameters

string $path

Return Value

bool

in ScopedFilesystemProxy at line 233
bool directoryMissing(string $path)

Determine if a scoped directory is missing.

Parameters

string $path

Return Value

bool

in ScopedFilesystemProxy at line 243
string|null get(string $path)

Get the contents of a scoped file.

Parameters

string $path

Return Value

string|null

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

Get the contents of a scoped file as decoded JSON.

Parameters

string $path
int $flags

Return Value

array|bool|float|int|string|null

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

Create a streamed response for a scoped file.

Parameters

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

Return Value

StreamedResponse

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

Create a streamed response for serving a scoped file.

Parameters

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

Return Value

Response

in ScopedFilesystemProxy at line 297
StreamedResponse download(string $path, string|null $name = null, array $headers = [])

Create a streamed download response for a scoped file.

Parameters

string $path
string|null $name
array $headers

Return Value

StreamedResponse

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

Write the contents of a scoped file.

Parameters

string $path
mixed $contents
mixed $options

Return Value

bool|string

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

Store an uploaded file on the scoped disk.

Parameters

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

Return Value

false|string

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

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

Parameters

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

Return Value

false|string

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

Write a scoped file using a stream.

Parameters

string $path
mixed $resource
array $options

Return Value

bool

in ScopedFilesystemProxy at line 373
string getVisibility(string $path)

Get the visibility for a scoped path.

Parameters

string $path

Return Value

string

in ScopedFilesystemProxy at line 383
bool setVisibility(string $path, string $visibility)

Set the visibility for a scoped path.

Parameters

string $path
string $visibility

Return Value

bool

in ScopedFilesystemProxy at line 393
bool prepend(string $path, string $data, string $separator = PHP_EOL)

Prepend to a scoped file.

Parameters

string $path
string $data
string $separator

Return Value

bool

in ScopedFilesystemProxy at line 403
bool append(string $path, string $data, string $separator = PHP_EOL)

Append to a scoped file.

Parameters

string $path
string $data
string $separator

Return Value

bool

in ScopedFilesystemProxy at line 413
bool delete(array|string $paths)

Delete scoped files.

Parameters

array|string $paths

Return Value

bool

in ScopedFilesystemProxy at line 426
bool copy(string $from, string $to)

Copy a scoped file to another scoped path.

Parameters

string $from
string $to

Return Value

bool

in ScopedFilesystemProxy at line 439
bool move(string $from, string $to)

Move a scoped file to another scoped path.

Parameters

string $from
string $to

Return Value

bool

in ScopedFilesystemProxy at line 452
int size(string $path)

Get the size of a scoped file.

Parameters

string $path

Return Value

int

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

Get the checksum of a scoped file.

Parameters

string $path
array $options

Return Value

false|string

in ScopedFilesystemProxy at line 472
false|string mimeType(string $path)

Get the MIME type of a scoped file.

Parameters

string $path

Return Value

false|string

in ScopedFilesystemProxy at line 482
int lastModified(string $path)

Get the last modification time of a scoped file.

Parameters

string $path

Return Value

int

in ScopedFilesystemProxy at line 494
mixed readStream(string $path)

Get a stream for a scoped file.

Parameters

string $path

Return Value

mixed

the path resource or null on failure

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

Get a partial stream for a scoped file.

Parameters

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

Return Value

mixed

the path resource or null on failure

in ScopedFilesystemProxy at line 516
string temporaryUrl(string $path, DateTimeInterface $expiration, array $options = [])

Get a temporary URL for a scoped file.

Parameters

string $path
DateTimeInterface $expiration
array $options

Return Value

string

in ScopedFilesystemProxy at line 526
array|string temporaryUploadUrl(string $path, DateTimeInterface $expiration, array $options = [])

Get a temporary upload URL for a scoped file.

Parameters

string $path
DateTimeInterface $expiration
array $options

Return Value

array|string

in ScopedFilesystemProxy at line 539
bool providesTemporaryUrls()

Determine if the inner disk provides temporary URLs.

Return Value

bool

in ScopedFilesystemProxy at line 547
bool providesTemporaryUploadUrls()

Determine if the inner disk provides temporary upload URLs.

Return Value

bool

in ScopedFilesystemProxy at line 555
array getConfig()

Get the inner disk configuration.

Return Value

array

in ScopedFilesystemProxy at line 563
array files(string|null $directory = null, bool $recursive = false)

Get scoped files in a directory.

Parameters

string|null $directory
bool $recursive

Return Value

array

in ScopedFilesystemProxy at line 577
array allFiles(string|null $directory = null)

Get all scoped files in a directory recursively.

Parameters

string|null $directory

Return Value

array

in ScopedFilesystemProxy at line 588
array directories(string|null $directory = null, bool $recursive = false)

Get scoped directories in a directory.

Parameters

string|null $directory
bool $recursive

Return Value

array

in ScopedFilesystemProxy at line 602
array allDirectories(string|null $directory = null)

Get all scoped directories in a directory recursively.

Parameters

string|null $directory

Return Value

array

in ScopedFilesystemProxy at line 613
bool makeDirectory(string $path)

Create a scoped directory.

Parameters

string $path

Return Value

bool

in ScopedFilesystemProxy at line 623
bool deleteDirectory(string $directory)

Delete a scoped directory recursively.

Parameters

string $directory

Return Value

bool

in ScopedFilesystemProxy at line 633
never getDriver()

Reject access to the inner Flysystem driver.

Return Value

never

in ScopedFilesystemProxy at line 641
never getAdapter()

Reject access to the inner Flysystem adapter.

Return Value

never

in ScopedFilesystemProxy at line 649
never getClient()

Reject access to the inner driver client.

Return Value

never

in ScopedFilesystemProxy at line 657
never serveUsing(Closure|null $callback)

Reject mutation of the shared inner disk's serve callback.

Parameters

Closure|null $callback

Return Value

never

in ScopedFilesystemProxy at line 665
never buildTemporaryUrlsUsing(Closure|null $callback)

Reject mutation of the shared inner disk's temporary URL callback.

Parameters

Closure|null $callback

Return Value

never

in ScopedFilesystemProxy at line 673
never buildTemporaryUploadUrlsUsing(Closure|null $callback)

Reject mutation of the shared inner disk's temporary upload URL callback.

Parameters

Closure|null $callback

Return Value

never

in ScopedFilesystemProxy at line 681
never __call(string $method, array $parameters)

Reject calls that have not been explicitly mapped through the prefix boundary.

Parameters

string $method
array $parameters

Return Value

never

in ScopedFilesystemProxy at line 691
protected string prefix()

Resolve and validate the prefix for one public operation.

Return Value

string

in ScopedFilesystemProxy at line 708
protected string applyPrefix(string $prefix, string $path)

Apply a validated prefix to a normalized user path.

Parameters

string $prefix
string $path

Return Value

string

in ScopedFilesystemProxy at line 718
protected string stripPrefix(string $prefix, string $path)

Strip a validated prefix from an inner returned path.

Parameters

string $prefix
string $path

Return Value

string

at line 44
protected Filesystem resolveDisk()

Resolve the inner cloud filesystem for one public operation.

The narrowed return type enforces the Cloud contract for dynamically resolved disks.

Return Value

Filesystem

in ScopedFilesystemProxy at line 750
protected mixed call(string $method, array $arguments)

Forward one audited method to the inner disk.

Parameters

string $method
array $arguments

Return Value

mixed

in ScopedFilesystemProxy at line 776
protected RuntimeException unsupportedMutationOrInternal(string $method)

Create the exception for every rejected internal or shared-state mutator.

Parameters

string $method

Return Value

RuntimeException

at line 32
string url(string $path)

Get the URL for a scoped file.

Parameters

string $path

Return Value

string