public function ConfigOverrideIntegrationTestCacheContext::getCacheableMetadata in Drupal 8

Same name and namespace in other branches

1. 9 core/modules/config/tests/config_override_integration_test/src/Cache/ConfigOverrideIntegrationTestCacheContext.php \Drupal\config_override_integration_test\Cache\ConfigOverrideIntegrationTestCacheContext::getCacheableMetadata()
2. 10 core/modules/config/tests/config_override_integration_test/src/Cache/ConfigOverrideIntegrationTestCacheContext.php \Drupal\config_override_integration_test\Cache\ConfigOverrideIntegrationTestCacheContext::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_integration_test/src/Cache/ConfigOverrideIntegrationTestCacheContext.php, line 34

Class

ConfigOverrideIntegrationTestCacheContext

A cache context service intended for the config override integration test.

Namespace

Drupal\config_override_integration_test\Cache

Code

public function getCacheableMetadata() {

  // Since this depends on State this can change at any time and is not
  // cacheable.
  $metadata = new CacheableMetadata();
  $metadata
    ->setCacheMaxAge(0);
  return $metadata;
}