public function BackgroundImageBaseCacheContext::getCacheableMetadata in Background Image 2.x

Same name and namespace in other branches

1. 8 src/Cache/Context/BackgroundImageBaseCacheContext.php \Drupal\background_image\Cache\Context\BackgroundImageBaseCacheContext::getCacheableMetadata()
2. 2.0.x src/Cache/Context/BackgroundImageBaseCacheContext.php \Drupal\background_image\Cache\Context\BackgroundImageBaseCacheContext::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/BackgroundImageBaseCacheContext.php, line 37

Class

BackgroundImageBaseCacheContext

Provides a base for Background Image based contexts.

Namespace

Drupal\background_image\Cache\Context

Code

public function getCacheableMetadata() {
  $metadata = new CacheableMetadata();
  if ($this->backgroundImage) {
    $metadata
      ->addCacheTags($this->backgroundImage
      ->getCacheTags());
  }
  return $metadata;
}