CacheableMetadata
class CacheableMetadata implements RefinableCacheableDependencyInterface (View source)
Defines a generic class for passing cacheability metadata.
Traits
Trait for \Drupal\Core\Cache\RefinableCacheableDependencyInterface.
Trait for \Drupal\Core\Cache\CacheableDependencyInterface.
Properties
| protected string[] | $cacheContexts | Cache contexts. |
from CacheableDependencyTrait |
| protected string[] | $cacheTags | Cache tags. |
from CacheableDependencyTrait |
| protected int | $cacheMaxAge | Cache max-age. |
from CacheableDependencyTrait |
Methods
Sets cacheability; useful for value object constructors.
The cache tags associated with this object.
The cache contexts associated with this object.
The maximum age for which this object may be cached.
Sets cache tags.
Sets cache contexts.
Sets the maximum age (in seconds).
Merges the values of another CacheableMetadata object with this one.
Applies the values of this CacheableMetadata object to a render array.
Creates a CacheableMetadata object with values taken from a render array.
Creates a CacheableMetadata object from a depended object.
Details
protected $this
setCacheability(CacheableDependencyInterface $cacheability)
Sets cacheability; useful for value object constructors.
string[]
getCacheTags()
The cache tags associated with this object.
When this object is modified, these cache tags will be invalidated.
string[]
getCacheContexts()
The cache contexts associated with this object.
These identify a specific variation/representation of the object.
Cache contexts are tokens: placeholders that are converted to cache keys by the @cache_contexts_manager service. The replacement value depends on the request context (the current URL, language, and so on). They're converted before storing an object in cache.
int
getCacheMaxAge()
The maximum age for which this object may be cached.
addCacheableDependency($other_object)
{@inheritdoc}
addCacheContexts(array $cache_contexts)
{@inheritdoc}
addCacheTags(array $cache_tags)
{@inheritdoc}
mergeCacheMaxAge($max_age)
{@inheritdoc}
$this
setCacheTags(array $cache_tags)
Sets cache tags.
$this
setCacheContexts(array $cache_contexts)
Sets cache contexts.
$this
setCacheMaxAge(int $max_age)
Sets the maximum age (in seconds).
Defaults to Cache::PERMANENT
CacheableMetadata
merge(CacheableMetadata $other)
Merges the values of another CacheableMetadata object with this one.
applyTo(array $build)
Applies the values of this CacheableMetadata object to a render array.
static CacheableMetadata
createFromRenderArray(array $build)
Creates a CacheableMetadata object with values taken from a render array.
static CacheableMetadata
createFromObject(CacheableDependencyInterface|mixed $object)
Creates a CacheableMetadata object from a depended object.