ASCMVC
Back to top  

DoctrineCacheItem

Implements \Psr\Cache\CacheItemInterface

Class DoctrineCacheItem

package

Ascmvc\Session\Cache

Methods

DoctrineCacheItem constructor.

__construct( $key,  $data)

Arguments

$key

$data

Sets the expiration time for this cache item.

expiresAfter(integer|\DateInterval|null $time) : static

Arguments

$time

integer|\DateInterval|null

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.

Response

static

The called object.

Sets the expiration time for this cache item.

expiresAt(\DateTimeInterface|null $expiration) : static

Arguments

$expiration

\DateTimeInterface|null

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.

Response

static

The called object.

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

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."

Response

mixed

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

Gets the expiration time for this cache item.

getExpiration() : integer

Response

integer

Returns the key for the current cache item.

getKey() : string

The key is loaded by the Implementing Library, but should be available to the higher level callers when needed.

Response

string

The key string for this cache item.

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

isHit() : boolean

Note: This method MUST NOT have a race condition between calling isHit() and calling get().

Response

boolean

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

Sets the value represented by this cache item.

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.

Arguments

$value

mixed

The serializable value to be stored.

Response

static

The invoked object.

Properties

Contains the result of the cache item lookup.

hit : boolean
var

Type(s)

boolean

Contains the item's key.

key : string
var

Type(s)

string

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

data : array
var

Type(s)

array

Contains the item expiration time in seconds.

expiration : integer
var

Type(s)

integer