1. class
  2. Google
  3. \
  4. Auth
  5. \
  6. Cache
  7. \
  8. Item

Item

class Item implements CacheItemInterface (View source)

A cache item.

This class will be used by MemoryCacheItemPool and SysVCacheItemPool on PHP 7.4 and below. It is compatible with psr/cache 1.0 and 2.0 (PSR-6).

Methods

__construct(string $key)

No description

string
getKey()

Returns the key for the current cache item.

mixed
get()

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

bool
isHit()

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

CacheItemInterface
set(mixed $value)

Sets the value represented by this cache item.

CacheItemInterface
expiresAt(DateTimeInterface|null $expiration)

Sets the expiration time for this cache item.

CacheItemInterface
expiresAfter(int|DateInterval|null $time)

Sets the expiration time for this cache item.

DateTime
currentTime()

No description

Details

at line 58
__construct(string $key)

Parameters

string $key

at line 66
string getKey()

Returns the key for the current cache item.

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

Return Value

string The key string for this cache item.

at line 74
mixed get()

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

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

Return Value

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

at line 82
bool isHit()

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

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

Return Value

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

at line 98
CacheItemInterface set(mixed $value)

Sets the value represented by this cache item.

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.

Parameters

mixed $value The serializable value to be stored.

Return Value

CacheItemInterface The invoked object.

at line 109
CacheItemInterface expiresAt(DateTimeInterface|null $expiration)

Sets the expiration time for this cache item.

Parameters

DateTimeInterface|null $expiration 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 Value

CacheItemInterface The called object.

at line 129
CacheItemInterface expiresAfter(int|DateInterval|null $time)

Sets the expiration time for this cache item.

Parameters

int|DateInterval|null $time 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 Value

CacheItemInterface The called object.

at line 170
protected DateTime currentTime()

Return Value

DateTime