interface Region implements MultiGetRegion (View source)

Defines a contract for accessing a particular named region.

Methods

CacheEntry[]|null
getMultiple(CollectionCacheEntry $collection)

Get all items from the cache identified by $keys.

string
getName()

Retrieve the name of this region.

bool
contains(CacheKey $key)

Determine whether this region contains data for the given key.

CacheEntry|null
get(CacheKey $key)

Get an item from the cache.

put(CacheKey $key, CacheEntry $entry, Lock|null $lock = null)

Put an item into the cache.

evict(CacheKey $key)

Remove an item from the cache.

evictAll()

Remove all contents of this particular cache region.

Details

CacheEntry[]|null getMultiple(CollectionCacheEntry $collection)

Get all items from the cache identified by $keys.

It returns NULL if some elements can not be found.

Parameters

CollectionCacheEntry $collection The collection of the items to be retrieved.

Return Value

CacheEntry[]|null The cached entries or NULL if one or more entries can not be found

string getName()

Retrieve the name of this region.

Return Value

string The region name

bool contains(CacheKey $key)

Determine whether this region contains data for the given key.

Parameters

CacheKey $key The cache key

Return Value

bool TRUE if the underlying cache contains corresponding data; FALSE otherwise.

CacheEntry|null get(CacheKey $key)

Get an item from the cache.

Parameters

CacheKey $key The key of the item to be retrieved.

Return Value

CacheEntry|null The cached entry or NULL

Exceptions

CacheException Indicates a problem accessing the item or region.

put(CacheKey $key, CacheEntry $entry, Lock|null $lock = null)

Put an item into the cache.

Parameters

CacheKey $key The key under which to cache the item.
CacheEntry $entry The entry to cache.
Lock|null $lock The lock previously obtained.

Exceptions

CacheException Indicates a problem accessing the region.

evict(CacheKey $key)

Remove an item from the cache.

Parameters

CacheKey $key The key under which to cache the item.

Exceptions

CacheException Indicates a problem accessing the region.

evictAll()

Remove all contents of this particular cache region.

Exceptions

CacheException Indicates problem accessing the region.