public function WorkspaceCacheContext::getCacheableMetadata in Drupal 10

Same name and namespace in other branches

1. 8 core/modules/workspaces/src/WorkspaceCacheContext.php \Drupal\workspaces\WorkspaceCacheContext::getCacheableMetadata()
2. 9 core/modules/workspaces/src/WorkspaceCacheContext.php \Drupal\workspaces\WorkspaceCacheContext::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/modules/workspaces/src/WorkspaceCacheContext.php, line 49

Class

WorkspaceCacheContext

Defines the WorkspaceCacheContext service, for "per workspace" caching.

Namespace

Drupal\workspaces

Code

public function getCacheableMetadata($type = NULL) {

  // The active workspace will always be stored in the user's session.
  $cacheability = new CacheableMetadata();
  $cacheability
    ->addCacheContexts([
    'session',
  ]);
  return $cacheability;
}