SimpleCache
in package
implements
CacheInterface, CounterInterface
Tags
Table of Contents
Interfaces
Methods
- __construct() : mixed
- clear() : bool
- Wipes clean the entire cache's keys.
- decrement() : int|bool
- Decrement a value atomically in the cache by its step value, which defaults to 1
- delete() : bool
- Delete an item from the cache by its unique key.
- deleteMultiple() : bool
- Deletes multiple cache items in a single operation.
- exists() : mixed
- {@inheritdoc}
- get() : mixed
- Fetches a value from the cache.
- getMultiple() : iterable<string|int, mixed>
- Obtains multiple cache items by their unique keys.
- increment() : int|bool
- Increment a value atomically in the cache by its step value, which defaults to 1
- set() : bool
- Persists data in the cache, uniquely referenced by a key with an optional expiration TTL time.
- setMultiple() : bool
- Persists a set of key => value pairs in the cache, with an optional TTL.
Methods
__construct()
public
__construct(KeyValueStore $store) : mixed
Parameters
- $store : KeyValueStore
clear()
Wipes clean the entire cache's keys.
public
clear() : bool
Return values
bool —True on success and false on failure.
decrement()
Decrement a value atomically in the cache by its step value, which defaults to 1
public
decrement(mixed $key[, mixed $step = 1 ]) : int|bool
Parameters
- $key : mixed
-
The cache item key
- $step : mixed = 1
-
The value to decrement by, defaulting to 1
Return values
int|bool —The new value on success and false on failure
delete()
Delete an item from the cache by its unique key.
public
delete(mixed $key) : bool
Parameters
- $key : mixed
-
The unique cache key of the item to delete.
Return values
bool —True if the item was successfully removed. False if there was an error.
deleteMultiple()
Deletes multiple cache items in a single operation.
public
deleteMultiple(mixed $keys) : bool
Parameters
- $keys : mixed
-
A list of string-based keys to be deleted.
Return values
bool —True if the items were successfully removed. False if there was an error.
exists()
{@inheritdoc}
public
exists(mixed $key) : mixed
Parameters
- $key : mixed
get()
Fetches a value from the cache.
public
get(mixed $key) : mixed
Parameters
- $key : mixed
-
The unique key of this item in the cache.
Return values
mixed —The value of the item from the cache, or $default in case of cache miss.
getMultiple()
Obtains multiple cache items by their unique keys.
public
getMultiple(mixed $keys) : iterable<string|int, mixed>
Parameters
- $keys : mixed
-
A list of keys that can obtained in a single operation.
Return values
iterable<string|int, mixed> —A list of key => value pairs. Cache keys that do not exist or are stale will have $default as value.
increment()
Increment a value atomically in the cache by its step value, which defaults to 1
public
increment(mixed $key[, mixed $step = 1 ]) : int|bool
Parameters
- $key : mixed
-
The cache item key
- $step : mixed = 1
-
The value to increment by, defaulting to 1
Return values
int|bool —The new value on success and false on failure
set()
Persists data in the cache, uniquely referenced by a key with an optional expiration TTL time.
public
set(mixed $key, mixed $value[, mixed $ttl = null ]) : bool
Parameters
- $key : mixed
-
The key of the item to store.
- $value : mixed
-
The value of the item to store, must be serializable.
- $ttl : mixed = null
-
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 values
bool —True on success and false on failure.
setMultiple()
Persists a set of key => value pairs in the cache, with an optional TTL.
public
setMultiple(mixed $items[, mixed $ttl = null ]) : bool
Parameters
- $items : mixed
- $ttl : mixed = null
-
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 values
bool —True on success and false on failure.