UpdateTimestampCache
extends DefaultRegion
in package
implements
TimestampRegion
Tracks the timestamps of the most recent updates to particular keys.
Table of Contents
Interfaces
- TimestampRegion
- Defines the contract for a cache region which will specifically be used to store entity "update timestamps".
Constants
- REGION_PREFIX = 'DC2_REGION_'
Properties
Methods
- __construct() : mixed
- contains() : bool
- Determine whether this region contains data for the given key.
- evict() : bool
- Remove an item from the cache.
- evictAll() : bool
- Remove all contents of this particular cache region.
- get() : CacheEntry|null
- Get an item from the cache.
- getCache() : CacheProvider
- getMultiple() : mixed
- {@inheritDoc}
- getName() : string
- Retrieve the name of this region.
- put() : bool
- Put an item into the cache.
- update() : void
- Update a specific key into the cache region.
Constants
REGION_PREFIX
private
mixed
REGION_PREFIX
= 'DC2_REGION_'
Properties
$cache
protected
Cache
$cache
Tags
$cacheItemPool
private
CacheItemPoolInterface
$cacheItemPool
Methods
__construct()
public
__construct(string $name, CacheItemPoolInterface $cacheItemPool[, int $lifetime = 0 ]) : mixed
Parameters
- $name : string
- $cacheItemPool : CacheItemPoolInterface
- $lifetime : int = 0
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) : bool
Parameters
- $key : CacheKey
-
The key under which to cache the item.
Return values
boolevictAll()
Remove all contents of this particular cache region.
public
evictAll() : bool
Return values
boolget()
Get an item from the cache.
public
get(CacheKey $key) : CacheEntry|null
Parameters
- $key : CacheKey
-
The key of the item to be retrieved.
Return values
CacheEntry|null —The cached entry or NULL
getCache()
public
getCache() : CacheProvider
Tags
Return values
CacheProvidergetMultiple()
{@inheritDoc}
public
getMultiple(CollectionCacheEntry $collection) : mixed
Parameters
- $collection : CollectionCacheEntry
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 ]) : bool
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.
Return values
boolupdate()
Update a specific key into the cache region.
public
update(CacheKey $key) : void
Parameters
- $key : CacheKey