class DefaultRegion implements Region (View source)

The simplest cache region compatible with all doctrine-cache drivers.

Constants

REGION_KEY_SEPARATOR

Properties

protected Cache $cache
protected string $name
protected integer $lifetime

Methods

__construct(string $name, Cache $cache, integer $lifetime = 0)

No description

string
getName()

Retrieve the name of this region.

CacheProvider
getCache()

No description

boolean
contains(CacheKey $key)

Determine whether this region contains data for the given key.

CacheEntry|null
get(CacheKey $key)

Get an item from the cache.

CacheEntry[]|null
getMultiple(CollectionCacheEntry $collection)

Get all items from the cache identified by $keys.

string
getCacheEntryKey(CacheKey $key)

No description

put(CacheKey $key, CacheEntry $entry, Lock $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

__construct(string $name, Cache $cache, integer $lifetime = 0)

Parameters

string $name
Cache $cache
integer $lifetime

string getName()

Retrieve the name of this region.

Return Value

string The region name

CacheProvider getCache()

Return Value

CacheProvider

boolean contains(CacheKey $key)

Determine whether this region contains data for the given key.

Parameters

CacheKey $key The cache key

Return Value

boolean 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.

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

protected string getCacheEntryKey(CacheKey $key)

Parameters

CacheKey $key

Return Value

string

put(CacheKey $key, CacheEntry $entry, Lock $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 $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.