class FileStorage implements Storage

Cache file storage.

Constants

private internal META_HEADER_LEN

private internal META_TIME

private internal META_SERIALIZED

private internal META_EXPIRE

private internal META_DELTA

private internal META_ITEMS

private internal META_CALLBACKS

private FILE

additional cache structure

private HANDLE

additional cache structure

Properties

static $gcProbability

probability that the clean() routine is started

Methods

__construct(string $dir, Journal|null $journal = null)

No description

mixed
read(string $key)

Read from cache.

void
lock(string $key)

Prevents item reading and writing. Lock is released by write() or remove().

void
write(string $key, $data, array $dp)

Writes item into the cache.

void
remove(string $key)

Removes item from the cache.

void
clean(array $conditions)

Removes items from the cache by conditions.

array|null
readMetaAndLock(string $file, int $lock)

Reads cache data from disk.

mixed
readData(array $meta)

Reads cache data from disk and closes cache file handle.

string
getCacheFile(string $key)

Returns file name.

Details

at line 60
__construct(string $dir, Journal|null $journal = null)

No description

Parameters

string $dir
Journal|null $journal

at line 75
mixed read(string $key)

Read from cache.

Parameters

string $key

Return Value

mixed

at line 123
void lock(string $key)

Prevents item reading and writing. Lock is released by write() or remove().

Parameters

string $key

Return Value

void

at line 140
void write(string $key, $data, array $dp)

Writes item into the cache.

Parameters

string $key
$data
array $dp

Return Value

void

at line 221
void remove(string $key)

Removes item from the cache.

Parameters

string $key

Return Value

void

at line 228
void clean(array $conditions)

Removes items from the cache by conditions.

Parameters

array $conditions

Return Value

void

at line 298
protected array|null readMetaAndLock(string $file, int $lock)

Reads cache data from disk.

Parameters

string $file
int $lock

Return Value

array|null

at line 325
protected mixed readData(array $meta)

Reads cache data from disk and closes cache file handle.

Parameters

array $meta

Return Value

mixed

at line 338
protected string getCacheFile(string $key)

Returns file name.

Parameters

string $key

Return Value

string

Traits

Strict class for better experience.