Drupal\Core\Cache\UseCacheBackendTrait | Drupal Core API Explorer

trait UseCacheBackendTrait (View source)

Provides methods to use a cache backend while respecting a 'use caches' flag.

Properties

protected CacheBackendInterface	$cacheBackend	Cache backend instance.
protected bool	$useCaches	Flag whether caches should be used or skipped.

object|false

cacheGet(string $cid)

Fetches from the cache backend, respecting the use caches flag.

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

Stores data in the persistent cache, respecting the use caches flag.

Fetches from the cache backend, respecting the use caches flag.

string

$cid

The cache ID of the data to retrieve.

object|false

The cache item or FALSE on failure.

Stores data in the persistent cache, respecting the use caches flag.

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 array('node' => array(123), 'user' => array(92)).