You are here

public function ContextInterface::addCacheableDependency in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/lib/Drupal/Core/Plugin/Context/ContextInterface.php \Drupal\Core\Plugin\Context\ContextInterface::addCacheableDependency()

Adds a dependency on an object: merges its cacheability metadata.

E.g. when a context depends on some configuration, an entity, or an access result, we must make sure their cacheability metadata is present on the response. This method makes doing that simple.

Parameters

\Drupal\Core\Cache\CacheableDependencyInterface|mixed $dependency: The dependency. If the object implements CacheableDependencyInterface, then its cacheability metadata will be used. Otherwise, the passed in object must be assumed to be uncacheable, so max-age 0 is set.

Return value

$this

See also

\Drupal\Core\Cache\CacheableMetadata::createFromObject()

1 method overrides ContextInterface::addCacheableDependency()
Context::addCacheableDependency in core/lib/Drupal/Core/Plugin/Context/Context.php
Adds a dependency on an object: merges its cacheability metadata.

File

core/lib/Drupal/Core/Plugin/Context/ContextInterface.php, line 48
Contains \Drupal\Core\Plugin\Context\ContextInterface.

Class

ContextInterface
Interface for context.

Namespace

Drupal\Core\Plugin\Context

Code

public function addCacheableDependency($dependency);