public function CacheableResponseInterface::addCacheableDependency in Drupal 8

Same name and namespace in other branches

1. 9 core/lib/Drupal/Core/Cache/CacheableResponseInterface.php \Drupal\Core\Cache\CacheableResponseInterface::addCacheableDependency()
2. 10 core/lib/Drupal/Core/Cache/CacheableResponseInterface.php \Drupal\Core\Cache\CacheableResponseInterface::addCacheableDependency()

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

For instance, when a response 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()

File

core/lib/Drupal/Core/Cache/CacheableResponseInterface.php, line 28

Class

CacheableResponseInterface

Defines an interface for responses that can expose cacheability metadata.

Namespace

Drupal\Core\Cache

Code

public function addCacheableDependency($dependency);