1. class
  2. Drupal
  3. \
  4. Core
  5. \
  6. Cache
  7. \
  8. MemoryCounterBackend

MemoryCounterBackend

class MemoryCounterBackend extends MemoryBackend (View source)

Defines a memory cache implementation that counts set and get calls.

This can be used to mock a cache backend where one needs to know how many times a cache entry was set or requested.

On the longrun this backend should be replaced by phpunit mock objects.

Properties

protected $cache

Array to store cache objects.

 from  MemoryBackend
protected array $counter

Stores a list of cache cid calls keyed by function name.

Methods

object|false
get(string $cid, bool $allow_invalid = FALSE)

Returns data from the persistent cache.

array
getMultiple(array $cids, bool $allow_invalid = FALSE)

Returns data from the persistent cache when given an array of cache IDs.

from  MemoryBackend
mixed
prepareItem(object $cache, bool $allow_invalid)

Prepares a cached item.

from  MemoryBackend
set(string $cid, mixed $data, int $expire = Cache::PERMANENT, array $tags = [])

Stores data in the persistent cache.

setMultiple(array $items = [])

Store multiple items in the persistent cache.

from  MemoryBackend
delete(string $cid)

Deletes an item from the cache.

deleteMultiple(array $cids)

Deletes multiple items from the cache.

from  MemoryBackend
deleteAll()

Deletes all cache items in a bin.

from  MemoryBackend
invalidate(string $cid)

Marks a cache item as invalid.

from  MemoryBackend
invalidateMultiple(array $cids)

Marks cache items as invalid.

from  MemoryBackend
invalidateTags(array $tags)

Marks cache items with any of the specified tags as invalid.

from  MemoryBackend
invalidateAll()

Marks all cache items as invalid.

from  MemoryBackend
garbageCollection()

Performs garbage collection on a cache bin.

from  MemoryBackend
removeBin()

Remove a cache bin.

from  MemoryBackend
int
getRequestTime()

Wrapper method for REQUEST_TIME constant.

from  MemoryBackend
__sleep()

Prevents data stored in memory backends from being serialized.

from  MemoryBackend
reset()

Reset statically cached variables.

from  MemoryBackend
increaseCounter(string $function, string $cid)

Increase the counter for a function with a certain cid.

int|array
getCounter(string $method = NULL, string $cid = NULL)

Returns the call counter for the get, set and delete methods.

resetCounter()

Resets the call counter.

Details

at line 25
object|false get(string $cid, bool $allow_invalid = FALSE)

Returns data from the persistent cache.

Parameters

string $cid

The cache ID of the data to retrieve.
bool $allow_invalid

(optional) If TRUE, a cache item may be returned even if it is expired or has been invalidated. Such items may sometimes be preferred, if the alternative is recalculating the value stored in the cache, especially if another concurrent request is already recalculating the same value. The "valid" property of the returned object indicates whether the item is valid or not. Defaults to FALSE.

Return Value

object|false

The cache item or FALSE on failure.

in MemoryBackend at line 44
array getMultiple(array $cids, bool $allow_invalid = FALSE)

Returns data from the persistent cache when given an array of cache IDs.

Parameters

array $cids

An array of cache IDs for the data to retrieve. This is passed by reference, and will have the IDs successfully returned from cache removed.
bool $allow_invalid

(optional) If TRUE, cache items may be returned even if they have expired or been invalidated. Such items may sometimes be preferred, if the alternative is recalculating the value stored in the cache, especially if another concurrent thread is already recalculating the same value. The "valid" property of the returned objects indicates whether the items are valid or not. Defaults to FALSE.

Return Value

array

An array of cache item objects indexed by cache ID.

in MemoryBackend at line 77
protected mixed prepareItem(object $cache, bool $allow_invalid)

Prepares a cached item.

Checks that items are either permanent or did not expire, and returns data as appropriate.

Parameters

object $cache

An item loaded from self::get() or self::getMultiple().
bool $allow_invalid

(optional) If TRUE, cache items may be returned even if they have expired or been invalidated.

Return Value

mixed

The item with data as appropriate or FALSE if there is no valid item to load.

at line 33
set(string $cid, mixed $data, int $expire = Cache::PERMANENT, array $tags = [])

Stores data in the persistent cache.

Core cache implementations set the created time on cache item with microtime(TRUE) rather than REQUEST_TIME_FLOAT, because the created time of cache items should match when they are created, not when the request started. Apart from being more accurate, this increases the chance an item will legitimately be considered valid.

Parameters

string $cid

The cache ID of the data to store.
mixed $data

The data to store in the cache. Some storage engines only allow objects up to a maximum of 1MB in size to be stored by default. When caching large arrays or similar, take care to ensure $data does not exceed this size.
int $expire

One of the following values:

  • CacheBackendInterface::CACHE_PERMANENT: Indicates that the item should not be removed unless it is deleted explicitly.
  • A Unix timestamp: Indicates that the item will be considered invalid after this time, i.e. it will not be returned by get() unless $allow_invalid has been set to TRUE. When the item has expired, it may be permanently deleted by the garbage collector at any time.
array $tags

An array of tags to be stored with the cache item. These should normally identify objects used to build the cache item, which should trigger cache invalidation when updated. For example if a cached item represents a node, both the node ID and the author's user ID might be passed in as tags. For example ['node:123', 'node:456', 'user:789'].

in MemoryBackend at line 119
setMultiple(array $items = [])

Store multiple items in the persistent cache.

Parameters

array $items

An array of cache items, keyed by cid. In the form: @code $items = array( $cid => array( // Required, will be automatically serialized if not a string. 'data' => $data, // Optional, defaults to CacheBackendInterface::CACHE_PERMANENT. 'expire' => CacheBackendInterface::CACHE_PERMANENT, // (optional) The cache tags for this item, see CacheBackendInterface::set(). 'tags' => array(), ), ); @endcode

at line 41
delete(string $cid)

Deletes an item from the cache.

If the cache item is being deleted because it is no longer "fresh", you may consider using invalidate() instead. This allows callers to retrieve the invalid item by calling get() with $allow_invalid set to TRUE. In some cases an invalid item may be acceptable rather than having to rebuild the cache.

Parameters

string $cid

The cache ID to delete.

in MemoryBackend at line 135
deleteMultiple(array $cids)

Deletes multiple items from the cache.

If the cache items are being deleted because they are no longer "fresh", you may consider using invalidateMultiple() instead. This allows callers to retrieve the invalid items by calling get() with $allow_invalid set to TRUE. In some cases an invalid item may be acceptable rather than having to rebuild the cache.

Parameters

array $cids

An array of cache IDs to delete.

in MemoryBackend at line 142
deleteAll()

Deletes all cache items in a bin.

in MemoryBackend at line 149
invalidate(string $cid)

Marks a cache item as invalid.

Invalid items may be returned in later calls to get(), if the $allow_invalid argument is TRUE.

Parameters

string $cid

The cache ID to invalidate.

in MemoryBackend at line 158
invalidateMultiple(array $cids)

Marks cache items as invalid.

Invalid items may be returned in later calls to get(), if the $allow_invalid argument is TRUE.

Parameters

array $cids

An array of cache IDs to invalidate.

in MemoryBackend at line 168
invalidateTags(array $tags)

Marks cache items with any of the specified tags as invalid.

Parameters

array $tags

The list of tags for which to invalidate cache items.

in MemoryBackend at line 179
invalidateAll()

Marks all cache items as invalid.

Invalid items may be returned in later calls to get(), if the $allow_invalid argument is TRUE.

in MemoryBackend at line 188
garbageCollection()

Performs garbage collection on a cache bin.

The backend may choose to delete expired or invalidated items.

in MemoryBackend at line 194
removeBin()

Remove a cache bin.

in MemoryBackend at line 203
protected int getRequestTime()

Wrapper method for REQUEST_TIME constant.

Return Value

int

in MemoryBackend at line 210
__sleep()

Prevents data stored in memory backends from being serialized.

in MemoryBackend at line 219
reset()

Reset statically cached variables.

This is only used by tests.

at line 54
protected increaseCounter(string $function, string $cid)

Increase the counter for a function with a certain cid.

Parameters

string $function

The called function.
string $cid

The cache ID of the cache entry to increase the counter.

at line 74
int|array getCounter(string $method = NULL, string $cid = NULL)

Returns the call counter for the get, set and delete methods.

Parameters

string $method

(optional) The name of the method to return the call counter for.
string $cid

(optional) The name of the cache id to return the call counter for.

Return Value

int|array

An integer if both method and cid is given, an array otherwise.

at line 89
resetCounter()

Resets the call counter.