core\local\guzzle\cache_item Class Reference

Public Member Functions
	__construct (string $key, string $module, ?int $ttl=null)
	Constructor for the cache_item to get the key and module to retrieve or set the cache item.
	expires_after ($time)
	Sets the relative expiration time for this cache item.
	expires_at ($expiration)
	Sets the absolute expiration time for this cache item.
	get ()
	Retrieves the value of the item from the cache associated with this object's key.
	get_key ()
	Returns the key for the current cache item.
	is_hit ()
	Confirms if the cache item lookup resulted in a cache hit.
	set ($value)
	Sets the value represented by this cache item.

Constructor & Destructor Documentation

__construct()

core\local\guzzle\cache_item::__construct	(	string	$key,
		string	$module,
		?int	$ttl = null )

Constructor for the cache_item to get the key and module to retrieve or set the cache item.

Parameters

string	$key	The key for the current cache item.
string	$module	determines the location of the cache item.
int | null	$ttl	Time to live for the cache item.

Member Function Documentation

expires_after()

core\local\guzzle\cache_item::expires_after

(

$time

)

Sets the relative 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 values

static

The called object.

expires_at()

core\local\guzzle\cache_item::expires_at

(

$expiration

)

Sets the absolute 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 values

static

The called object.

get()

core\local\guzzle\cache_item::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 cache value, so the isHit() method SHOULD be used to differentiate between "null value was found" and "no value was found."

Return values

mixed

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

get_key()

core\local\guzzle\cache_item::get_key

(

)

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 values

string

The key string for this cache item.

is_hit()

core\local\guzzle\cache_item::is_hit

(

)

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 values

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

set()

core\local\guzzle\cache_item::set

(

$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 values

static

The invoked object.

---

The documentation for this class was generated from the following file:

• lib/classes/local/guzzle/cache_item.php