You are here

public function StoreCacheContext::getCacheableMetadata in Commerce Core 8.2

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

modules/store/src/Cache/Context/StoreCacheContext.php, line 51

Class

StoreCacheContext
Defines the StoreCacheContext service, for "per store" caching.

Namespace

Drupal\commerce_store\Cache\Context

Code

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