Documentation

CacheItem
in package
implements CacheItemInterface

Interfaces, Classes and Traits

CacheItemInterface
CacheItemInterface defines an interface for interacting with objects inside a cache.

Table of Contents

$expires  : DateTimeInterface|DateInterval|int
$hit  : bool
$key  : string
$value  : mixed|null
__construct()  : mixed
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.
getTTL()  : int|null
isHit()  : bool
Confirms if the cache item lookup resulted in a cache hit.
set()  : static
Sets the value represented by this cache item.

Properties

$expires

protected DateTimeInterface|DateInterval|int $expires

Methods

__construct()

public __construct(string $key[, mixed $value = null ][, bool $hit = false ]) : mixed
Parameters
$key : string
$value : mixed = null
$hit : bool = false
Return values
mixed —

expiresAfter()

Sets the expiration time for this cache item.

public expiresAfter(mixed $time) : static
Parameters
$time : mixed

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.

Return values
static —

The called object.

expiresAt()

Sets the expiration time for this cache item.

public expiresAt(mixed $expiration) : static
Parameters
$expiration : mixed

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.

Return values
static —

The called object.

get()

Retrieves the value of the item from the cache associated with this object's key.

public get() : mixed
Return values
mixed —

The value corresponding to this cache item's key, or null if not found.

getKey()

Returns the key for the current cache item.

public getKey() : string
Return values
string —

The key string for this cache item.

getTTL()

public getTTL() : int|null
Return values
int|null —

The amount of minutes this item should stay alive. Or null when no expires is given.

isHit()

Confirms if the cache item lookup resulted in a cache hit.

public isHit() : bool
Return values
bool —

True if the request resulted in a cache hit. False otherwise.

set()

Sets the value represented by this cache item.

public set(mixed $value) : static
Parameters
$value : mixed

The serializable value to be stored.

Return values
static —

The invoked object.

Search results