1. 8.3.x core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php RefinableCacheableDependencyTrait
  2. 8.0.x core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php RefinableCacheableDependencyTrait
  3. 8.1.x core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php RefinableCacheableDependencyTrait
  4. 8.2.x core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php RefinableCacheableDependencyTrait
  5. 8.4.x core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php RefinableCacheableDependencyTrait

Trait for \Drupal\Core\Cache\RefinableCacheableDependencyInterface.

Hierarchy

7 files declare their use of RefinableCacheableDependencyTrait
AccessResult.php in core/lib/Drupal/Core/Access/AccessResult.php
Breadcrumb.php in core/lib/Drupal/Core/Breadcrumb/Breadcrumb.php
ConfigBase.php in core/lib/Drupal/Core/Config/ConfigBase.php
Entity.php in core/lib/Drupal/Core/Entity/Entity.php
PageDisplayVariantSelectionEvent.php in core/lib/Drupal/Core/Render/PageDisplayVariantSelectionEvent.php

... See full list

File

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

Namespace

Drupal\Core\Cache
View source
trait RefinableCacheableDependencyTrait {

  /**
   * Cache contexts.
   *
   * @var string[]
   */
  protected $cacheContexts = [];

  /**
   * Cache tags.
   *
   * @var string[]
   */
  protected $cacheTags = [];

  /**
   * Cache max-age.
   *
   * @var int
   */
  protected $cacheMaxAge = Cache::PERMANENT;

  /**
   * {@inheritdoc}
   */
  public function getCacheTags() {
    return $this->cacheTags;
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheContexts() {
    return $this->cacheContexts;
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheMaxAge() {
    return $this->cacheMaxAge;
  }

  /**
   * {@inheritdoc}
   */
  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;
  }

  /**
   * {@inheritdoc}
   */
  public function addCacheContexts(array $cache_contexts) {
    if ($cache_contexts) {
      $this->cacheContexts = Cache::mergeContexts($this->cacheContexts, $cache_contexts);
    }
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function addCacheTags(array $cache_tags) {
    if ($cache_tags) {
      $this->cacheTags = Cache::mergeTags($this->cacheTags, $cache_tags);
    }
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function mergeCacheMaxAge($max_age) {
    $this->cacheMaxAge = Cache::mergeMaxAges($this->cacheMaxAge, $max_age);
    return $this;
  }

}

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description
RefinableCacheableDependencyTrait::$cacheContexts protected property Cache contexts.
RefinableCacheableDependencyTrait::$cacheMaxAge protected property Cache max-age.
RefinableCacheableDependencyTrait::$cacheTags protected property Cache tags.
RefinableCacheableDependencyTrait::addCacheableDependency public function Adds a dependency on an object: merges its cacheability metadata. Overrides RefinableCacheableDependencyInterface::addCacheableDependency
RefinableCacheableDependencyTrait::addCacheContexts public function Adds cache contexts. Overrides RefinableCacheableDependencyInterface::addCacheContexts
RefinableCacheableDependencyTrait::addCacheTags public function Adds cache tags. Overrides RefinableCacheableDependencyInterface::addCacheTags
RefinableCacheableDependencyTrait::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts
RefinableCacheableDependencyTrait::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
RefinableCacheableDependencyTrait::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags
RefinableCacheableDependencyTrait::mergeCacheMaxAge public function Merges the maximum age (in seconds) with the existing maximum age. Overrides RefinableCacheableDependencyInterface::mergeCacheMaxAge