class FileReadOnlyStorage implements PhpStorageInterface (View source)

Reads code as regular PHP files, but won't write them.

Properties

protected string $directory

The directory where the files should be stored.

Methods

__construct(array $configuration)

Constructs this FileStorage object.

bool
exists(string $name)

Checks whether the PHP code exists in storage.

load(string $name)

Loads PHP code from storage.

bool
save(string $name, string $code)

Saves PHP code to storage.

bool
delete(string $name)

Deletes PHP code from storage.

string|false
getFullPath(string $name)

Gets the full file path.

bool
writeable()

Whether this is a writable storage.

deleteAll()

Removes all files in this bin.

array
listAll()

Lists all the files in the storage.

garbageCollection()

Performs garbage collection on the storage.

Details

__construct(array $configuration)

Constructs this FileStorage object.

Parameters

array $configuration

An associative array, containing at least two keys (the rest are ignored):

  • directory: The directory where the files should be stored.
  • bin: The storage bin. Multiple storage objects can be instantiated with the same configuration, but for different bins.

bool exists(string $name)

Checks whether the PHP code exists in storage.

Parameters

string $name

The virtual file name. Can be a relative path.

Return Value

bool

TRUE if the virtual file exists, FALSE otherwise.

load(string $name)

Loads PHP code from storage.

Depending on storage implementation, exists() checks can be expensive, so this function may be called for a file that doesn't exist, and that should not result in errors. This function does not return anything, so it is up to the caller to determine if any code was loaded (for example, check class_exists() or function_exists() for what was expected in the code).

Parameters

string $name

The virtual file name. Can be a relative path.

bool save(string $name, string $code)

Saves PHP code to storage.

Parameters

string $name

The virtual file name. Can be a relative path.

string $code

The PHP code to be saved.

Return Value

bool

TRUE if the save succeeded, FALSE if it failed.

bool delete(string $name)

Deletes PHP code from storage.

Parameters

string $name

The virtual file name. Can be a relative path.

Return Value

bool

TRUE if the delete succeeded, FALSE if it failed.

string|false getFullPath(string $name)

Gets the full file path.

Parameters

string $name

The virtual file name. Can be a relative path.

Return Value

string|false

The full file path for the provided name. Return FALSE if the implementation needs to prevent access to the file.

bool writeable()

Whether this is a writable storage.

Return Value

bool

deleteAll()

Removes all files in this bin.

array listAll()

Lists all the files in the storage.

Return Value

array

Array of filenames.

garbageCollection()

Performs garbage collection on the storage.

The storage may choose to delete expired or invalidated items.