TimestampRegion
extends
Region
in
Defines the contract for a cache region which will specifically be used to store entity "update timestamps".
Table of Contents
- contains() : bool
- Determine whether this region contains data for the given key.
- evict() : mixed
- Remove an item from the cache.
- evictAll() : mixed
- Remove all contents of this particular cache region.
- get() : CacheEntry|null
- Get an item from the cache.
- getMultiple() : array<string|int, CacheEntry>|null
- Get all items from the cache identified by $keys.
- getName() : string
- Retrieve the name of this region.
- put() : mixed
- Put an item into the cache.
- update() : mixed
- Update an specific key into the cache region.
Methods
contains()
Determine whether this region contains data for the given key.
public
contains(CacheKey $key) : bool
Parameters
- $key : CacheKey
-
The cache key
Return values
bool —TRUE if the underlying cache contains corresponding data; FALSE otherwise.
evict()
Remove an item from the cache.
public
evict(CacheKey $key) : mixed
Parameters
- $key : CacheKey
-
The key under which to cache the item.
Tags
Return values
mixed —evictAll()
Remove all contents of this particular cache region.
public
evictAll() : mixed
Tags
Return values
mixed —get()
Get an item from the cache.
public
get(CacheKey $key) : CacheEntry|null
Parameters
- $key : CacheKey
-
The key of the item to be retrieved.
Tags
Return values
CacheEntry|null —The cached entry or NULL
getMultiple()
Get all items from the cache identified by $keys.
public
getMultiple(CollectionCacheEntry $collection) : array<string|int, CacheEntry>|null
It returns NULL if some elements can not be found.
Parameters
- $collection : CollectionCacheEntry
-
The collection of the items to be retrieved.
Return values
array<string|int, CacheEntry>|null —The cached entries or NULL if one or more entries can not be found
getName()
Retrieve the name of this region.
public
getName() : string
Return values
string —The region name
put()
Put an item into the cache.
public
put(CacheKey $key, CacheEntry $entry[, Lock|null $lock = null ]) : mixed
Parameters
- $key : CacheKey
-
The key under which to cache the item.
- $entry : CacheEntry
-
The entry to cache.
- $lock : Lock|null = null
-
The lock previously obtained.
Tags
Return values
mixed —update()
Update an specific key into the cache region.
public
update(CacheKey $key) : mixed
Parameters
- $key : CacheKey
-
The key of the item to update the timestamp.