You are here

public function RngEventCacheContext::getCacheableMetadata in RNG - Events and Registrations 8

Same name and namespace in other branches
  1. 8.2 src/Cache/Context/RngEventCacheContext.php \Drupal\rng\Cache\Context\RngEventCacheContext::getCacheableMetadata()
  2. 3.x src/Cache/Context/RngEventCacheContext.php \Drupal\rng\Cache\Context\RngEventCacheContext::getCacheableMetadata()

Gets the cacheability metadata for the context.

There are three valid cases for the returned CacheableMetadata object:

  • An empty object means this can be optimized away safely.
  • A max-age of 0 means that this context can never be optimized away. It will never bubble up and cache tags will not be used.
  • Any non-zero max-age and cache tags will bubble up into the cache item if this is optimized away to allow for invalidation if the context value changes.

Return value

\Drupal\Core\Cache\CacheableMetadata A cacheable metadata object.

Overrides CacheContextInterface::getCacheableMetadata

File

src/Cache/Context/RngEventCacheContext.php, line 55

Class

RngEventCacheContext
A context for the current rng_event.

Namespace

Drupal\rng\Cache\Context

Code

public function getCacheableMetadata() {
  return new CacheableMetadata();
}