You are here

Home » API reference » Zircon Profile 8.0 » RefinableCacheableDependencyTrait.php

trait RefinableCacheableDependencyTrait in Zircon Profile 8.0

Same name and namespace in other branches
  1. 8 core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php \Drupal\Core\Cache\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
Contains \Drupal\Core\Access\AccessResult.
Breadcrumb.php in core/lib/Drupal/Core/Breadcrumb/Breadcrumb.php
Contains \Drupal\Core\Breadcrumb\Breadcrumb.
ConfigBase.php in core/lib/Drupal/Core/Config/ConfigBase.php
Contains \Drupal\Core\Config\ConfigBase.
Entity.php in core/lib/Drupal/Core/Entity/Entity.php
Contains \Drupal\Core\Entity\Entity.
PageDisplayVariantSelectionEvent.php in core/lib/Drupal/Core/Render/PageDisplayVariantSelectionEvent.php
Contains \Drupal\Core\Render\PageDisplayVariantSelectionEvent.

... See full list

File

core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php, line 13
Contains \Drupal\Core\Cache\RefinableCacheableDependencyTrait.

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

Namesort descending Modifiers Type Description Overrides
RefinableCacheableDependencyTrait::$cacheContexts protected property Cache contexts.
RefinableCacheableDependencyTrait::$cacheMaxAge protected property Cache max-age.
RefinableCacheableDependencyTrait::$cacheTags protected property Cache tags.
RefinableCacheableDependencyTrait::addCacheableDependency public function 1
RefinableCacheableDependencyTrait::addCacheContexts public function
RefinableCacheableDependencyTrait::addCacheTags public function
RefinableCacheableDependencyTrait::getCacheContexts public function 4
RefinableCacheableDependencyTrait::getCacheMaxAge public function 4
RefinableCacheableDependencyTrait::getCacheTags public function 4
RefinableCacheableDependencyTrait::mergeCacheMaxAge public function