CRM_Utils_Cache_ArrayCache

class CRM_Utils_Cache_ArrayCache implements CRM_Utils_Cache_Interface

Class CRM_Utils_Cache_ArrayCache

Traits

CRM_Utils_Cache_NaiveMultipleTrait
CRM_Utils_Cache_NaiveHasTrait

Constants

DEFAULT_TIMEOUT

Properties

protected array $_cache The cache storage container, an in memory array by default
protected $_expires

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
has($key)

No description

from CRM_Utils_Cache_NaiveHasTrait
CRM_Utils_Cache_ArrayCache
__construct(array $config)

Constructor.

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

No description

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

No description

bool
delete(string $key)

No description

bool
flush()

Delete all values from the cache.

bool
clear()

Delete all values from the cache.

int|null
getExpires(string $key)

No description

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.

in CRM_Utils_Cache_NaiveHasTrait at line 40
has($key)

Parameters

$key

at line 61
CRM_Utils_Cache_ArrayCache __construct(array $config)

Constructor.

Parameters

array $config An array of configuration params.

Return Value

CRM_Utils_Cache_ArrayCache

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

Parameters

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

Return Value

bool

Exceptions

InvalidArgumentException

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

Parameters

string $key
mixed $default

Return Value

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

Exceptions

InvalidArgumentException

at line 103
bool delete(string $key)

Parameters

string $key

Return Value

bool

Exceptions

InvalidArgumentException

at line 111
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 118
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 140
int|null getExpires(string $key)

Parameters

string $key

Return Value

int|null