RefinableCacheableDependencyTrait::addCacheableDependency

public RefinableCacheableDependencyTrait::addCacheableDependency($other_object)

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

Parameters

\Drupal\Core\Cache\CacheableDependencyInterface|object $other_object: 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

Overrides RefinableCacheableDependencyInterface::addCacheableDependency

File

core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php, line 55

Class

RefinableCacheableDependencyTrait: Trait for \Drupal\Core\Cache\RefinableCacheableDependencyInterface.

Namespace

Drupal\Core\Cache

Code

public function addCacheableDependency($other_object) {
  if ($other_object instanceof CacheableDependencyInterface) {
    $this->addCacheContexts($other_object->getCacheContexts());
    $this->addCacheTags($other_object->getCacheTags());
    $this->mergeCacheMaxAge($other_object->getCacheMaxAge());
  }
  else {
    // Not a cacheable dependency, this can not be cached.
    $this->cacheMaxAge = 0;
  }
  return $this;
}

Links:

https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Cache%21RefinableCacheableDependencyTrait.php/function/RefinableCacheableDependencyTrait%3A%3AaddCacheableDependency/8.2.x

doc_Drupal

2025-01-10 15:47:30

Comments