get(string $key, mixed $default = null) : mixed
Fetches a value from the cache.
| string | $key | The unique key of this item in the cache. |
| mixed | $default | Default value to return if the key does not exist. |
MUST be thrown if the $key string is not a legal value.
The value of the item from the cache, or $default in case of cache miss.
set(string $key, mixed $value, null|int|\DateInterval $ttl = null) : bool
Persists data in the cache, uniquely referenced by a key with an optional expiration TTL time.
| string | $key | The key of the item to store. |
| mixed | $value | The value of the item to store, must be serializable. |
| 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. |
MUST be thrown if the $key string is not a legal value.
True on success and false on failure.
delete(string $key) : bool
Delete an item from the cache by its unique key.
| string | $key | The unique cache key of the item to delete. |
MUST be thrown if the $key string is not a legal value.
True if the item was successfully removed. False if there was an error.
getMultiple(iterable $keys, mixed $default = null) : iterable
Obtains multiple cache items by their unique keys.
| 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. |
MUST be thrown if $keys is neither an array nor a Traversable, or if any of the $keys are not a legal value.
A list of key => value pairs. Cache keys that do not exist or are stale will have $default as value.
setMultiple(iterable $values, null|int|\DateInterval $ttl = null) : bool
Persists a set of key => value pairs in the cache, with an optional TTL.
| 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. |
MUST be thrown if $values is neither an array nor a Traversable, or if any of the $values are not a legal value.
True on success and false on failure.
deleteMultiple(iterable $keys) : bool
Deletes multiple cache items in a single operation.
| iterable | $keys | A list of string-based keys to be deleted. |
MUST be thrown if $keys is neither an array nor a Traversable, or if any of the $keys are not a legal value.
True if the items were successfully removed. False if there was an error.
has(string $key) : bool
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.
| string | $key | The cache item key. |
MUST be thrown if the $key string is not a legal value.