Basicis - Core
As the name says, it is made to be basic and direct.
Basicis\Cache\CacheItem
CacheItem class, defines an interface for interacting with objects inside a cache.
Each Item object MUST be associated with a specific key, which can be set according to the implementing system and is typically passed by the Cache\CacheItemPoolInterface object. The Cache\CacheItemInterface object encapsulates the storage and retrieval of cache items. Each Cache\CacheItemInterface is generated by a Cache\CacheItemPoolInterface object, which is responsible for any required setup as well as associating the object with a unique Key. Cache\CacheItemInterface objects MUST be able to store and retrieve any type of PHP value defined in the Data section of the specification. Calling Libraries MUST NOT instantiate Item objects themselves. They may only be requested from a Pool object via the getItem() method. Calling Libraries SHOULD NOT assume that an Item created by one Implementing Library is compatible with a Pool from another Implementing Library.
Implements:
Psr\Cache\CacheItemInterface
Methods
| Name | Description |
|---|---|
| __construct | __construct function |
| expiresAfter | Function expiresAfter |
| Sets the expiration time for this cache item. | |
| expiresAt | Function expiresAt |
| Sets the expiration time for this cache item. | |
| get | Function get |
| Retrieves the value of the item from the cache associated with this object’s key. | |
| getExpiration | Function getExpiration |
| Get cache itme expiration | |
| getKey | Function getKey |
| Returns the key for the current cache item. | |
| getTime | Function getTime |
| Get cache itme time | |
| isHit | Function isHit |
| Confirms if the cache item lookup resulted in a cache hit. | |
| set | Function set |
| Sets the value represented by this cache item. | |
| setKey | Function setKey |
| Set a key for the current cache item |
CacheItem::__construct
Description
public __construct (string $key, mixed $value, \DateTimeInterface|null $expiration, int|string|\DateIntervalInterface|null $time)
__construct function
Parameters
(string) $key(mixed) $value(\DateTimeInterface|null) $expiration(int|string|\DateIntervalInterface|null) $time
Return Values
void
CacheItem::expiresAfter
Description
public expiresAfter (int|string|\DateInterval|null $time)
Function expiresAfter Sets the expiration time for this cache item.
Parameters
-
(int|string|\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.
CacheItem::expiresAt
Description
public expiresAt (\DateTimeInterface|null $expiration)
Function expiresAt 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 Values
static
The called object.
CacheItem::get
Description
public get (void)
Function 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.”
Parameters
This function has no parameters.
Return Values
mixed
The value corresponding to this cache item’s key, or null if not found.
CacheItem::getExpiration
Description
public getExpiration (void)
Function getExpiration Get cache itme expiration
Parameters
This function has no parameters.
Return Values
\DateTimeInterface
CacheItem::getKey
Description
public getKey (void)
Function 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.
Parameters
This function has no parameters.
Return Values
string
The key string for this cache item.
CacheItem::getTime
Description
public getTime (void)
Function getTime Get cache itme time
Parameters
This function has no parameters.
Return Values
\DateInterval
CacheItem::isHit
Description
public isHit (void)
Function 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().
Parameters
This function has no parameters.
Return Values
bool
True if the request resulted in a cache hit. False otherwise.
CacheItem::set
Description
public set (mixed $value)
Function set 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.
CacheItem::setKey
Description
public setKey (string $key)
Function setKey Set a key for the current cache item
Parameters
(string) $key
Return Values
void