1. class
  2. Nette
  3. \
  4. Caching
  5. \
  6. Cache

Cache

class Cache

Implements the cache for a application.

Constants

Priority

dependency
Expire

dependency
Sliding

dependency
Tags

dependency
Files

dependency
Items

dependency
Constants

dependency
Callbacks

dependency
Namespaces

dependency
All

dependency
deprecated PRIORITY

deprecated EXPIRATION

deprecated EXPIRE

deprecated SLIDING

deprecated TAGS

deprecated FILES

deprecated ITEMS

deprecated CONSTS

deprecated CALLBACKS

deprecated NAMESPACES

deprecated ALL

internal NamespaceSeparator

internal NAMESPACE_SEPARATOR

Methods

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

No description

Storage
getStorage()

Returns cache storage.

string
getNamespace()

Returns cache namespace.

Cache
derive(string $namespace)

Returns new nested cache object.

mixed
load(mixed $key, callable|null $generator = null, array|null $dependencies = null)

Reads the specified item from the cache or generate it.

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

Reads multiple items from the cache.

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

Writes item into the cache.

void
bulkSave(array $items, array|null $dependencies = null)

Writes multiple items into cache

void
remove(mixed $key)

Removes item from the cache.

void
clean(array|null $conditions = null)

Removes items from the cache by conditions.

mixed
call(callable $function)

Caches results of function/method calls.

Closure
wrap(callable $function, array|null $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 75
__construct(Storage $storage, string|null $namespace = null)

No description

Parameters

Storage $storage
string|null $namespace

at line 85
final Storage getStorage()

Returns cache storage.

Return Value

Storage

at line 94
final string getNamespace()

Returns cache namespace.

Return Value

string

at line 103
Cache derive(string $namespace)

Returns new nested cache object.

Parameters

string $namespace

Return Value

Cache

at line 112
mixed load(mixed $key, callable|null $generator = null, array|null $dependencies = null)

Reads the specified item from the cache or generate it.

Parameters

mixed $key
callable|null $generator
array|null $dependencies

Return Value

mixed

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

Reads multiple items from the cache.

Parameters

array $keys
callable|null $generator

Return Value

array

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

Writes item into the cache.

Dependencies are:

  • Cache::Priority => (int) priority
  • Cache::Expire => (timestamp) expiration, infinite if null
  • Cache::Sliding => (bool) use sliding expiration?
  • Cache::Tags => (array) tags
  • Cache::Files => (array|string) file names
  • Cache::Items => (array|string) cache items
  • Cache::Constants => (array|string) cache items

Parameters

mixed $key
mixed $data
array|null $dependencies

Return Value

mixed

value itself

Exceptions

InvalidArgumentException

at line 224
void bulkSave(array $items, array|null $dependencies = null)

Writes multiple items into cache

Parameters

array $items
array|null $dependencies

Return Value

void

at line 311
void remove(mixed $key)

Removes item from the cache.

Parameters

mixed $key

Return Value

void

at line 324
void clean(array|null $conditions = null)

Removes items from the cache by conditions.

Conditions are:

  • Cache::Priority => (int) priority
  • Cache::Tags => (array) tags
  • Cache::All => true

Parameters

array|null $conditions

Return Value

void

at line 338
mixed call(callable $function)

Caches results of function/method calls.

Parameters

callable $function

Return Value

mixed

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

Caches results of function/method calls.

Parameters

callable $function
array|null $dependencies

Return Value

Closure

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

Starts the output cache.

Parameters

mixed $key

Return Value

OutputHelper|null

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

deprecated use capture()

No description

Parameters

$key

Return Value

OutputHelper|null

at line 395
protected string generateKey($key)

Generates internal cache key.

Parameters

$key

Return Value

string

at line 407
static bool checkCallbacks(array $callbacks)

Checks CALLBACKS dependencies.

Parameters

array $callbacks

Return Value

bool