function ContextInterface::addCacheableDependency
Same name in other branches
- 9 core/lib/Drupal/Core/Plugin/Context/ContextInterface.php \Drupal\Core\Plugin\Context\ContextInterface::addCacheableDependency()
- 8.9.x core/lib/Drupal/Core/Plugin/Context/ContextInterface.php \Drupal\Core\Plugin\Context\ContextInterface::addCacheableDependency()
- 11.x core/lib/Drupal/Core/Plugin/Context/ContextInterface.php \Drupal\Core\Plugin\Context\ContextInterface::addCacheableDependency()
Adds a dependency on an object: merges its cacheability metadata.
For example, 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 46
Class
- ContextInterface
- Context data and definitions for plugins supporting caching and return docs.
Namespace
Drupal\Core\Plugin\ContextCode
public function addCacheableDependency($dependency);
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.