Interface CacheItemInterface

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

Direct known implementers

Kotchasan\Cache\CacheItem

Namespace: Psr\Cache
Located at Kotchasan/Psr/Cache/CacheItemInterface.php

Methods summary
`public string`	# `getKey( )` Returns the key for the current cache item. 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. The key string for this cache item. Returns string
`public mixed`	# `get( )` Retrieves the value of the item from the cache associated with this object's key. 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." The value corresponding to this cache item's key, or null if not found. Returns mixed
`public boolean`	# `isHit( )` Confirms if the cache item lookup resulted in a cache 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(). True if the request resulted in a cache hit. False otherwise. Returns boolean
`public static`	# `set( mixed $value )` Sets the value represented by this cache item. 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. The serializable value to be stored. The invoked object. Parameters `$value` Returns static
`public static`	# `expiresAt( DateTimeInterface $expiration )` Sets the expiration time for this cache item. Sets the expiration time for this cache item. 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` Returns static
`public static`	# `expiresAfter( integer\|DateInterval $time )` Sets the expiration time for this cache item. Sets the expiration time for this cache item. 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` Returns static