Methods

has()

has(string  $path) : array|bool|null

Check whether a file exists.

Parameters

string $path

Returns

array|bool|null —

read()

read(string  $path) : array|false

Read a file.

Parameters

string $path

Returns

array|false —

readStream()

readStream(string  $path) : array|false

Read a file as a stream.

Parameters

string $path

Returns

array|false —

listContents()

listContents(string  $directory = '', bool  $recursive = false) : array

List contents of a directory.

Parameters

string $directory
bool $recursive

Returns

array —

getMetadata()

getMetadata(string  $path) : array|false

Get all the meta data of a file or directory.

Parameters

string $path

Returns

array|false —

getSize()

getSize(string  $path) : array|false

Get the size of a file.

Parameters

string $path

Returns

array|false —

getMimetype()

getMimetype(string  $path) : array|false

Get the mimetype of a file.

Parameters

string $path

Returns

array|false —

getTimestamp()

getTimestamp(string  $path) : array|false

Get the last modified time of a file as a timestamp.

Parameters

string $path

Returns

array|false —

getVisibility()

getVisibility(string  $path) : array|false

Get the visibility of a file.

Parameters

string $path

Returns

array|false —

isComplete()

isComplete(string  $dirname, bool  $recursive) : bool

Check whether the directory listing of a given directory is complete.

Parameters

string $dirname
bool $recursive

Returns

bool —

setComplete()

setComplete(string  $dirname, bool  $recursive) : mixed

Set a directory to completely listed.

Parameters

string $dirname
bool $recursive

Returns

mixed —

storeContents()

storeContents(string  $directory, array  $contents, bool  $recursive) : mixed

Store the contents of a directory.

Parameters

string $directory
array $contents
bool $recursive

Returns

mixed —

flush()

flush() : mixed

Flush the cache.

Returns

mixed —

autosave()

autosave() : mixed

Autosave trigger.

Returns

mixed —

save()

save() : mixed

Store the cache.

Returns

mixed —

load()

load() : mixed

Load the cache.

Returns

mixed —

rename()

rename(string  $path, string  $newpath) : mixed

Rename a file.

Parameters

string $path
string $newpath

Returns

mixed —

copy()

copy(string  $path, string  $newpath) : mixed

Copy a file.

Parameters

string $path
string $newpath

Returns

mixed —

delete()

delete(string  $path) : mixed

Delete an object from cache.

Parameters

string $path

object path

Returns

mixed —

deleteDir()

deleteDir(string  $dirname) : mixed

Delete all objects from from a directory.

Parameters

string $dirname

directory path

Returns

mixed —

updateObject()

updateObject(string  $path, array  $object, bool  $autosave = false) : mixed

Update the metadata for an object.

Parameters

string $path

object path

array $object

object metadata

bool $autosave

whether to trigger the autosave routine

Returns

mixed —

storeMiss()

storeMiss(string  $path) : mixed

Store object hit miss.

Parameters

string $path

Returns

mixed —