public function IsFrontPathCacheContext::getCacheableMetadata in Drupal 8

Same name and namespace in other branches

1. 9 core/lib/Drupal/Core/Cache/Context/IsFrontPathCacheContext.php \Drupal\Core\Cache\Context\IsFrontPathCacheContext::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

core/lib/Drupal/Core/Cache/Context/IsFrontPathCacheContext.php, line 46

Class

IsFrontPathCacheContext

Defines a cache context for whether the URL is the front page of the site.

Namespace

Drupal\Core\Cache\Context

Code

public function getCacheableMetadata() {
  $metadata = new CacheableMetadata();
  $metadata
    ->addCacheTags([
    'config:system.site',
  ]);
  return $metadata;
}