1. class
  2. mako
  3. \
  4. cache
  5. \
  6. stores
  7. \
  8. File

File

class File extends Store

File store.

Properties

protected string|null $prefix Prefix. from Store
protected FileSystem $fileSystem File system instance.
protected string $cachePath Cache path.
protected bool|array $classWhitelist Class whitelist.

Methods

$this
setPrefix(string $prefix)

Sets the cache key prefix.

from Store
string|null
getPrefix()

Returns the cache key prefix.

from Store
string
getPrefixedKey(string $key)

Returns a prefixed key.

from Store
bool
putIfNotExists(string $key, mixed $data, int $ttl = 0)

Store data in the cache if it doesn't already exist.

from Store
mixed
getAndPut(string $key, mixed $data, int $ttl = 0)

Fetch data from the cache and replace it. NULL will be returned if the item does not exist.

from Store
mixed
getAndRemove(string $key)

Fetch data from the cache and remove it. NULL will be returned if the item does not exist.

from Store
mixed
getOrElse(string $key, callable $data, int $ttl = 0)

Fetch data from the cache or store it if it doesn't already exist.

from Store
__construct(FileSystem $fileSystem, string $cachePath, bool|array $classWhitelist = false)

Constructor.

string
cacheFile(string $key)

Returns the path to the cache file.

bool
put(string $key, mixed $data, int $ttl = 0)

Store data in the cache.

bool
has(string $key)

Returns TRUE if the cache key exists and FALSE if not.

mixed
get(string $key)

Fetch data from the cache. NULL will be returned if the item does not exist.

bool
remove(string $key)

Delete data from the cache.

bool
clear()

Clears the cache.

Details

in Store at line 30
$this setPrefix(string $prefix)

Sets the cache key prefix.

Parameters

string $prefix Prefix

Return Value

$this

in Store at line 42
string|null getPrefix()

Returns the cache key prefix.

Return Value

string|null

in Store at line 53
protected string getPrefixedKey(string $key)

Returns a prefixed key.

Parameters

string $key Key

Return Value

string

in Store at line 61
bool putIfNotExists(string $key, mixed $data, int $ttl = 0)

Store data in the cache if it doesn't already exist.

Parameters

string $key Cache key
mixed $data The data to store
int $ttl Time to live

Return Value

bool

in Store at line 79
mixed getAndPut(string $key, mixed $data, int $ttl = 0)

Fetch data from the cache and replace it. NULL will be returned if the item does not exist.

Parameters

string $key Cache key
mixed $data The data to store
int $ttl Time to live

Return Value

mixed

in Store at line 94
mixed getAndRemove(string $key)

Fetch data from the cache and remove it. NULL will be returned if the item does not exist.

Parameters

string $key Cache key

Return Value

mixed

in Store at line 109
mixed getOrElse(string $key, callable $data, int $ttl = 0)

Fetch data from the cache or store it if it doesn't already exist.

Parameters

string $key Cache key
callable $data
int $ttl Time to live

Return Value

mixed

at line 55
__construct(FileSystem $fileSystem, string $cachePath, bool|array $classWhitelist = false)

Constructor.

Parameters

FileSystem $fileSystem File system instance
string $cachePath Cache path
bool|array $classWhitelist Class whitelist

at line 70
protected string cacheFile(string $key)

Returns the path to the cache file.

Parameters

string $key Cache key

Return Value

string

at line 78
bool put(string $key, mixed $data, int $ttl = 0)

Store data in the cache.

Parameters

string $key Cache key
mixed $data The data to store
int $ttl Time to live

Return Value

bool

at line 90
bool has(string $key)

Returns TRUE if the cache key exists and FALSE if not.

Parameters

string $key Cache key

Return Value

bool

at line 109
mixed get(string $key)

Fetch data from the cache. NULL will be returned if the item does not exist.

Parameters

string $key Cache key

Return Value

mixed

at line 148
bool remove(string $key)

Delete data from the cache.

Parameters

string $key Cache key

Return Value

bool

at line 161
bool clear()

Clears the cache.

Return Value

bool