CRM_Utils_Cache_ArrayDecorator

class CRM_Utils_Cache_ArrayDecorator implements CRM_Utils_Cache_Interface

Class CRM_Utils_Cache_ArrayDecorator

This creates a two-tier cache-hierarchy: a thread-local, array-based cache combined with some third-party cache driver.

Ex: $cache = new CRM_Utils_Cache_ArrayDecorator(new CRM_Utils_Cache_Redis(...));

Traits

CRM_Utils_Cache_NaiveMultipleTrait

Properties

protected int $defaultTimeout

Methods

iterable
getMultiple(iterable $keys, mixed $default = NULL)

Obtains multiple cache items by their unique keys.

from CRM_Utils_Cache_NaiveMultipleTrait
bool
setMultiple(iterable $values, null|int|DateInterval $ttl = NULL)

Persists a set of key => value pairs in the cache, with an optional TTL.

from CRM_Utils_Cache_NaiveMultipleTrait
bool
deleteMultiple(iterable $keys)

Deletes multiple cache items in a single operation.

from CRM_Utils_Cache_NaiveMultipleTrait
__construct(CRM_Utils_Cache_Interface $delegate, int $defaultTimeout = 3600)

CRM_Utils_Cache_ArrayDecorator constructor.

bool
set(string $key, mixed $value, null|int|DateInterval $ttl = NULL)

Set the value in the cache.

mixed
get(string $key, mixed $default = NULL)

Get a value from the cache.

bool
delete(string $key)

Delete a value from the cache.

bool
flush()

Delete all values from the cache.

bool
clear()

Delete all values from the cache.

bool
has(string $key)

Determines whether an item is present in the cache.

Details

in CRM_Utils_Cache_NaiveMultipleTrait at line 53
iterable getMultiple(iterable $keys, mixed $default = NULL)

Obtains multiple cache items by their unique keys.

Parameters

iterable $keys A list of keys that can obtained in a single operation.
mixed $default Default value to return for keys that do not exist.

Return Value

iterable A list of key => value pairs. Cache keys that do not exist or are stale will have $default as value.

Exceptions

InvalidArgumentException MUST be thrown if $keys is neither an array nor a Traversable, or if any of the $keys are not a legal value.

in CRM_Utils_Cache_NaiveMultipleTrait at line 77
bool setMultiple(iterable $values, null|int|DateInterval $ttl = NULL)

Persists a set of key => value pairs in the cache, with an optional TTL.

Parameters

iterable $values A list of key => value pairs for a multiple-set operation.
null|int|DateInterval $ttl Optional. The TTL value of this item. If no value is sent and the driver supports TTL then the library may set a default value for it or let the driver take care of that.

Return Value

bool True on success and false on failure.

Exceptions

InvalidArgumentException MUST be thrown if $values is neither an array nor a Traversable, or if any of the $values are not a legal value.

in CRM_Utils_Cache_NaiveMultipleTrait at line 101
bool deleteMultiple(iterable $keys)

Deletes multiple cache items in a single operation.

Parameters

iterable $keys A list of string-based keys to be deleted.

Return Value

bool True if the items were successfully removed. False if there was an error.

Exceptions

InvalidArgumentException MUST be thrown if $keys is neither an array nor a Traversable, or if any of the $keys are not a legal value.

at line 76
__construct(CRM_Utils_Cache_Interface $delegate, int $defaultTimeout = 3600)

CRM_Utils_Cache_ArrayDecorator constructor.

Parameters

CRM_Utils_Cache_Interface $delegate
int $defaultTimeout Default number of seconds each cache-item should endure.

at line 81
bool set(string $key, mixed $value, null|int|DateInterval $ttl = NULL)

Set the value in the cache.

Parameters

string $key
mixed $value
null|int|DateInterval $ttl

Return Value

bool

at line 97
mixed get(string $key, mixed $default = NULL)

Get a value from the cache.

Parameters

string $key
mixed $default

Return Value

mixed The previously set value value, or $default (NULL).

at line 114
bool delete(string $key)

Delete a value from the cache.

Parameters

string $key

Return Value

bool

at line 121
bool flush()

Delete all values from the cache.

NOTE: flush() and clear() should be aliases. flush() is specified by Civi's traditional interface, and clear() is specified by PSR-16.

Return Value

bool

at line 125
bool clear()

Delete all values from the cache.

NOTE: flush() and clear() should be aliases. flush() is specified by Civi's traditional interface, and clear() is specified by PSR-16.

Return Value

bool

at line 131
bool has(string $key)

Determines whether an item is present in the cache.

NOTE: It is recommended that has() is only to be used for cache warming type purposes and not to be used within your live applications operations for get/set, as this method is subject to a race condition where your has() will return true and immediately after, another script can remove it making the state of your app out of date.

Parameters

string $key The cache item key.

Return Value

bool