You are here

public function PirateDayCacheContext::getCacheableMetadata in Drupal 10

Same name and namespace in other branches
  1. 8 core/modules/config/tests/config_override_test/src/Cache/PirateDayCacheContext.php \Drupal\config_override_test\Cache\PirateDayCacheContext::getCacheableMetadata()
  2. 9 core/modules/config/tests/config_override_test/src/Cache/PirateDayCacheContext.php \Drupal\config_override_test\Cache\PirateDayCacheContext::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/config/tests/config_override_test/src/Cache/PirateDayCacheContext.php, line 57

Class

PirateDayCacheContext
Defines the PirateDayCacheContext service that allows to cache the booty.

Namespace

Drupal\config_override_test\Cache

Code

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