You are here

public function PreviewLinkCacheContext::getCacheableMetadata in Preview Link 8

Same name and namespace in other branches
  1. 2.x src/PreviewLinkCacheContext.php \Drupal\preview_link\PreviewLinkCacheContext::getCacheableMetadata()
  2. 2.0.x src/PreviewLinkCacheContext.php \Drupal\preview_link\PreviewLinkCacheContext::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/PreviewLinkCacheContext.php, line 48

Class

PreviewLinkCacheContext
Defines a class for a preview link cache context.

Namespace

Drupal\preview_link

Code

public function getCacheableMetadata() {
  return (new CacheableMetadata())
    ->addCacheTags([
    'routes',
  ]);
}