Psr16Cache
in package
implements
CacheInterface, PruneableInterface, ResettableInterface
Uses
ProxyTrait
Turns a PSR-6 cache into a PSR-16 one.
Tags
Interfaces, Classes, Traits and Enums
- CacheInterface
- PruneableInterface
- Interface extends psr-6 and psr-16 caches to allow for pruning (deletion) of all expired cache items.
- ResettableInterface
- Resets a pool's local state.
Table of Contents
- METADATA_EXPIRY_OFFSET = 1527506807
- $cacheItemPrototype : mixed
- $createCacheItem : mixed
- __construct() : mixed
- clear() : bool
- Wipes clean the entire cache's keys.
- delete() : bool
- Delete an item from the cache by its unique key.
- deleteMultiple() : bool
- Deletes multiple cache items in a single operation.
- get() : mixed
- Fetches a value from the cache.
- getMultiple() : iteratable<string|int, mixed>
- Obtains multiple cache items by their unique keys.
- has() : bool
- Determines whether an item is present in the cache.
- 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.
Constants
METADATA_EXPIRY_OFFSET
private
mixed
METADATA_EXPIRY_OFFSET
= 1527506807
Properties
$cacheItemPrototype
private
mixed
$cacheItemPrototype
$createCacheItem
private
mixed
$createCacheItem
Methods
__construct()
public
__construct(CacheItemPoolInterface $pool) : mixed
Parameters
- $pool : CacheItemPoolInterface
Return values
mixed —clear()
Wipes clean the entire cache's keys.
public
clear() : bool
Return values
bool —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 —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 —get()
Fetches a value from the cache.
public
get(mixed $key[, mixed $default = null ]) : mixed
Parameters
- $key : mixed
-
The unique key of this item in the cache.
- $default : mixed = null
-
Default value to return if the key does not exist.
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[, mixed $default = null ]) : iteratable<string|int, mixed>
Parameters
- $keys : mixed
-
A list of keys that can obtained in a single operation.
- $default : mixed = null
-
Default value to return for keys that do not exist.
Return values
iteratable<string|int, mixed> —has()
Determines whether an item is present in the cache.
public
has(mixed $key) : bool
Parameters
- $key : mixed
-
The cache item key.
Return values
bool —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 —setMultiple()
Persists a set of key => value pairs in the cache, with an optional TTL.
public
setMultiple(mixed $values[, mixed $ttl = null ]) : bool
Parameters
- $values : mixed
-
A list of key => value pairs for a multiple-set operation.
- $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.