CacheItemInterface
in
CacheItemInterface defines an interface for interacting with objects inside a cache.
Table of Contents
- expiresAfter() : static
- Sets the expiration time for this cache item.
- expiresAt() : static
- Sets the expiration time for this cache item.
- get() : mixed
- Retrieves the value of the item from the cache associated with this object's key.
- getKey() : string
- Returns the key for the current cache item.
- isHit() : bool
- Confirms if the cache item lookup resulted in a cache hit.
- set() : static
- Sets the value represented by this cache item.
Methods
expiresAfter()
Sets the expiration time for this cache item.
public
expiresAfter(int|DateInterval $time) : static
The period of time from the present after which the item MUST be considered expired. An integer parameter is understood to be the time in seconds until expiration. If null is passed explicitly, a default value MAY be used. If none is set, the value should be stored permanently or for as long as the implementation allows. The called object.
Parameters
- $time : int|DateInterval
Return values
static —expiresAt()
Sets the expiration time for this cache item.
public
expiresAt(DateTimeInterface $expiration) : static
The point in time after which the item MUST be considered expired. If null is passed explicitly, a default value MAY be used. If none is set, the value should be stored permanently or for as long as the implementation allows. The called object.
Parameters
- $expiration : DateTimeInterface
Return values
static —get()
Retrieves the value of the item from the cache associated with this object's key.
public
get() : mixed
The value returned must be identical to the value originally stored by set().
If isHit() returns false, this method MUST return null. Note that null is a legitimate cached value, so the isHit() method SHOULD be used to differentiate between "null value was found" and "no value was found."
The value corresponding to this cache item's key, or null if not found.
Return values
mixed —getKey()
Returns the key for the current cache item.
public
getKey() : string
The key is loaded by the Implementing Library, but should be available to the higher level callers when needed.
The key string for this cache item.
Return values
string —isHit()
Confirms if the cache item lookup resulted in a cache hit.
public
isHit() : bool
Note: This method MUST NOT have a race condition between calling isHit() and calling get().
True if the request resulted in a cache hit. False otherwise.
Return values
bool —set()
Sets the value represented by this cache item.
public
set(mixed $value) : static
The $value argument may be any item that can be serialized by PHP, although the method of serialization is left up to the Implementing Library.
The serializable value to be stored. The invoked object.
Parameters
- $value : mixed