Methods

has()

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

Check whether a file exists.

Parameters

string $path

Returns

array|boolean|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 = '', boolean  $recursive = false) : array

List contents of a directory.

Parameters

string $directory
boolean $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, boolean  $recursive) : boolean

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

Parameters

string $dirname
boolean $recursive

Returns

boolean

setComplete()

setComplete(string  $dirname, boolean  $recursive) 

Set a directory to completely listed.

Parameters

string $dirname
boolean $recursive

storeContents()

storeContents(string  $directory, array  $contents, boolean  $recursive) 

Store the contents of a directory.

Parameters

string $directory
array $contents
boolean $recursive

flush()

flush() 

Flush the cache.

autosave()

autosave() 

Autosave trigger.

save()

save() 

Store the cache.

load()

load() 

Load the cache.

rename()

rename(string  $path, string  $newpath) 

Rename a file.

Parameters

string $path
string $newpath

copy()

copy(string  $path, string  $newpath) 

Copy a file.

Parameters

string $path
string $newpath

delete()

delete(string  $path) 

Delete an object from cache.

Parameters

string $path

object path

deleteDir()

deleteDir(string  $dirname) 

Delete all objects from from a directory.

Parameters

string $dirname

directory path

updateObject()

updateObject(string  $path, array  $object, boolean  $autosave = false) 

Update the metadata for an object.

Parameters

string $path

object path

array $object

object metadata

boolean $autosave

whether to trigger the autosave routine

storeMiss()

storeMiss(string  $path) 

Store object hit miss.

Parameters

string $path