interface CacheCollectorInterface (View source)

Provides a caching wrapper to be used in place of large structures.

This should be extended by systems that need to cache large amounts of data to calling functions. These structures can become very large, so this class is used to allow different strategies to be used for caching internally (lazy loading, building caches over time etc.). This can dramatically reduce the amount of data that needs to be loaded from cache backends on each request, and memory usage from static caches of that same data.

The default implementation is \Drupal\Core\Cache\CacheCollector.

Methods

mixed
get(string $key)

Gets value from the cache.

set(string $key, mixed $value)

Sets cache data.

delete(string $key)

Deletes the element.

has(string $key)

Returns whether data exists for this key.

reset()

Resets the local cache.

clear()

Clears the collected cache entry.

Details

mixed get(string $key)

Gets value from the cache.

Parameters

string $key

Key that identifies the data.

Return Value

mixed

The corresponding cache data.

set(string $key, mixed $value)

Sets cache data.

It depends on the specific case and implementation whether this has a permanent effect or if it just affects the current request.

Parameters

string $key

Key that identifies the data.

mixed $value

The data to be set.

delete(string $key)

Deletes the element.

It depends on the specific case and implementation whether this has a permanent effect or if it just affects the current request.

Parameters

string $key

Key that identifies the data.

has(string $key)

Returns whether data exists for this key.

Parameters

string $key

Key that identifies the data.

reset()

Resets the local cache.

Does not clear the persistent cache.

clear()

Clears the collected cache entry.