class Cache

Implements the cache for a application.

Constants

PRIORITY

dependency

EXPIRATION

dependency

EXPIRE

dependency

SLIDING

dependency

TAGS

dependency

FILES

dependency

ITEMS

dependency

CONSTS

dependency

CALLBACKS

dependency

NAMESPACES

dependency

ALL

dependency

internal NAMESPACE_SEPARATOR

Methods

__construct(Storage $storage, string $namespace = null)

No description

getStorage()

Returns cache storage.

string
getNamespace()

Returns cache namespace.

derive(string $namespace)

Returns new nested cache object.

mixed
load(mixed $key, callable $generator = null)

Reads the specified item from the cache or generate it.

array
bulkLoad(array $keys, callable $generator = null)

Reads multiple items from the cache.

mixed
save(mixed $key, mixed $data, array $dependencies = null)

Writes item into the cache.

void
remove(mixed $key)

Removes item from the cache.

void
clean(array $conditions = null)

Removes items from the cache by conditions.

mixed
call(callable $function)

Caches results of function/method calls.

wrap(callable $function, array $dependencies = null)

Caches results of function/method calls.

OutputHelper|null
capture(mixed $key)

Starts the output cache.

OutputHelper|null
start($key) deprecated

No description

string
generateKey($key)

Generates internal cache key.

static bool
checkCallbacks(array $callbacks)

Checks CALLBACKS dependencies.

Details

at line 46
__construct(Storage $storage, string $namespace = null)

No description

Parameters

Storage $storage
string $namespace

at line 56
final Storage getStorage()

Returns cache storage.

Return Value

Storage

at line 65
final string getNamespace()

Returns cache namespace.

Return Value

string

at line 75
Cache derive(string $namespace)

Returns new nested cache object.

Parameters

string $namespace

Return Value

Cache

at line 86
mixed load(mixed $key, callable $generator = null)

Reads the specified item from the cache or generate it.

Parameters

mixed $key
callable $generator

Return Value

mixed

at line 107
array bulkLoad(array $keys, callable $generator = null)

Reads multiple items from the cache.

Parameters

array $keys
callable $generator

Return Value

array

at line 167
mixed save(mixed $key, mixed $data, array $dependencies = null)

Writes item into the cache.

Dependencies are:

  • Cache::PRIORITY => (int) priority
  • Cache::EXPIRATION => (timestamp) expiration
  • Cache::SLIDING => (bool) use sliding expiration?
  • Cache::TAGS => (array) tags
  • Cache::FILES => (array|string) file names
  • Cache::ITEMS => (array|string) cache items
  • Cache::CONSTS => (array|string) cache items

Parameters

mixed $key
mixed $data
array $dependencies

Return Value

mixed

value itself

Exceptions

InvalidArgumentException

at line 244
void remove(mixed $key)

Removes item from the cache.

Parameters

mixed $key

Return Value

void

at line 257
void clean(array $conditions = null)

Removes items from the cache by conditions.

Conditions are:

  • Cache::PRIORITY => (int) priority
  • Cache::TAGS => (array) tags
  • Cache::ALL => true

Parameters

array $conditions

Return Value

void

at line 271
mixed call(callable $function)

Caches results of function/method calls.

Parameters

callable $function

Return Value

mixed

at line 286
Closure wrap(callable $function, array $dependencies = null)

Caches results of function/method calls.

Parameters

callable $function
array $dependencies

Return Value

Closure

at line 305
OutputHelper|null capture(mixed $key)

Starts the output cache.

Parameters

mixed $key

Return Value

OutputHelper|null

at line 319
OutputHelper|null start($key) deprecated

deprecated use capture()

No description

Parameters

$key

Return Value

OutputHelper|null

at line 328
protected string generateKey($key)

Generates internal cache key.

Parameters

$key

Return Value

string

at line 340
static bool checkCallbacks(array $callbacks)

Checks CALLBACKS dependencies.

Parameters

array $callbacks

Return Value

bool

Traits

SmartObject