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

ReadThroughFilesystemAdapter

class ReadThroughFilesystemAdapter implements FilesystemAdapter

Methods

__construct(FilesystemOperator $primary, FilesystemOperator $fallback, bool $throwOnPromotionFailure = false, bool $copy = true)

Create a new read-through filesystem adapter instance.

bool
fileExists(string $path)

Determine if a file exists.

bool
directoryExists(string $path)

Determine if a directory exists.

void
write(string $path, string $contents, Config $config)

Write a file to the primary filesystem.

void
writeStream(string $path, mixed $contents, Config $config)

Write a file stream to the primary filesystem.

string
read(string $path)

Read a file, promoting it from the fallback filesystem when necessary.

mixed
readStream(string $path)

Read a file stream, promoting it from the fallback filesystem when necessary.

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

Open a native range when no fallback promotion is needed.

void
delete(string $path)

Delete a file from both filesystems.

void
deleteDirectory(string $path)

Delete a directory from both filesystems.

void
createDirectory(string $path, Config $config)

Create a directory on the primary filesystem.

void
setVisibility(string $path, string $visibility)

Set a file's visibility on the filesystem containing it.

FileAttributes
visibility(string $path)

Retrieve a file's visibility.

FileAttributes
mimeType(string $path)

Retrieve a file's MIME type.

FileAttributes
lastModified(string $path)

Retrieve a file's last modified time.

FileAttributes
fileSize(string $path)

Retrieve a file's size.

iterable
listContents(string $path, bool $deep)

List the contents of the primary filesystem.

void
move(string $source, string $destination, Config $config)

Move a file on the primary filesystem and remove its fallback source.

void
copy(string $source, string $destination, Config $config)

Copy a file on the primary filesystem, reading it from the fallback filesystem when necessary.

void
moveOnPrimary(string $source, string $destination, Config $config)

Move a file to its destination on the primary filesystem.

void
copyFromFallback(string $source, string $destination, Config $config)

Copy a file from the fallback filesystem to the primary filesystem.

mixed
spoolFallback(string $path)

Spool the fallback file and release its lease before borrowing the primary.

FilesystemOperator
readerFor(string $path)

Get the filesystem that contains the given path.

void
handlePromotionFailure(string $path, FilesystemException $exception)

Handle an exception encountered while promoting a file.

Details

at line 25
__construct(FilesystemOperator $primary, FilesystemOperator $fallback, bool $throwOnPromotionFailure = false, bool $copy = true)

Create a new read-through filesystem adapter instance.

Parameters

FilesystemOperator $primary
FilesystemOperator $fallback
bool $throwOnPromotionFailure
bool $copy

at line 36
bool fileExists(string $path)

Determine if a file exists.

Parameters

string $path

Return Value

bool

at line 44
bool directoryExists(string $path)

Determine if a directory exists.

Parameters

string $path

Return Value

bool

at line 52
void write(string $path, string $contents, Config $config)

Write a file to the primary filesystem.

Parameters

string $path
string $contents
Config $config

Return Value

void

at line 62
void writeStream(string $path, mixed $contents, Config $config)

Write a file stream to the primary filesystem.

Parameters

string $path
mixed $contents
Config $config

Return Value

void

at line 70
string read(string $path)

Read a file, promoting it from the fallback filesystem when necessary.

Parameters

string $path

Return Value

string

at line 100
mixed readStream(string $path)

Read a file stream, promoting it from the fallback filesystem when necessary.

Parameters

string $path

Return Value

mixed

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

Open a native range when no fallback promotion is needed.

Parameters

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

Return Value

mixed

null when the normal read-and-seek path is required

at line 165
void delete(string $path)

Delete a file from both filesystems.

Parameters

string $path

Return Value

void

at line 177
void deleteDirectory(string $path)

Delete a directory from both filesystems.

Parameters

string $path

Return Value

void

at line 189
void createDirectory(string $path, Config $config)

Create a directory on the primary filesystem.

Parameters

string $path
Config $config

Return Value

void

at line 197
void setVisibility(string $path, string $visibility)

Set a file's visibility on the filesystem containing it.

Parameters

string $path
string $visibility

Return Value

void

at line 205
FileAttributes visibility(string $path)

Retrieve a file's visibility.

Parameters

string $path

Return Value

FileAttributes

at line 213
FileAttributes mimeType(string $path)

Retrieve a file's MIME type.

Parameters

string $path

Return Value

FileAttributes

at line 221
FileAttributes lastModified(string $path)

Retrieve a file's last modified time.

Parameters

string $path

Return Value

FileAttributes

at line 229
FileAttributes fileSize(string $path)

Retrieve a file's size.

Parameters

string $path

Return Value

FileAttributes

at line 237
iterable listContents(string $path, bool $deep)

List the contents of the primary filesystem.

Parameters

string $path
bool $deep

Return Value

iterable

at line 245
void move(string $source, string $destination, Config $config)

Move a file on the primary filesystem and remove its fallback source.

Parameters

string $source
string $destination
Config $config

Return Value

void

at line 261
void copy(string $source, string $destination, Config $config)

Copy a file on the primary filesystem, reading it from the fallback filesystem when necessary.

Parameters

string $source
string $destination
Config $config

Return Value

void

at line 279
protected void moveOnPrimary(string $source, string $destination, Config $config)

Move a file to its destination on the primary filesystem.

Parameters

string $source
string $destination
Config $config

Return Value

void

at line 297
protected void copyFromFallback(string $source, string $destination, Config $config)

Copy a file from the fallback filesystem to the primary filesystem.

Parameters

string $source
string $destination
Config $config

Return Value

void

at line 315
protected mixed spoolFallback(string $path)

Spool the fallback file and release its lease before borrowing the primary.

Parameters

string $path

Return Value

mixed

at line 342
protected FilesystemOperator readerFor(string $path)

Get the filesystem that contains the given path.

Parameters

string $path

Return Value

FilesystemOperator

at line 350
protected void handlePromotionFailure(string $path, FilesystemException $exception)

Handle an exception encountered while promoting a file.

Parameters

string $path
FilesystemException $exception

Return Value

void