annotate core/lib/Drupal/Core/Cache/CacheableDependencyTrait.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 1fec387a4317
children
rev   line source
Chris@14 1 <?php
Chris@14 2
Chris@14 3 namespace Drupal\Core\Cache;
Chris@14 4
Chris@14 5 /**
Chris@14 6 * Trait for \Drupal\Core\Cache\CacheableDependencyInterface.
Chris@14 7 */
Chris@14 8 trait CacheableDependencyTrait {
Chris@14 9
Chris@14 10 /**
Chris@14 11 * Cache contexts.
Chris@14 12 *
Chris@14 13 * @var string[]
Chris@14 14 */
Chris@14 15 protected $cacheContexts = [];
Chris@14 16
Chris@14 17 /**
Chris@14 18 * Cache tags.
Chris@14 19 *
Chris@14 20 * @var string[]
Chris@14 21 */
Chris@14 22 protected $cacheTags = [];
Chris@14 23
Chris@14 24 /**
Chris@14 25 * Cache max-age.
Chris@14 26 *
Chris@14 27 * @var int
Chris@14 28 */
Chris@14 29 protected $cacheMaxAge = Cache::PERMANENT;
Chris@14 30
Chris@14 31 /**
Chris@14 32 * Sets cacheability; useful for value object constructors.
Chris@14 33 *
Chris@14 34 * @param \Drupal\Core\Cache\CacheableDependencyInterface $cacheability
Chris@14 35 * The cacheability to set.
Chris@14 36 *
Chris@14 37 * @return $this
Chris@14 38 */
Chris@14 39 protected function setCacheability(CacheableDependencyInterface $cacheability) {
Chris@14 40 $this->cacheContexts = $cacheability->getCacheContexts();
Chris@14 41 $this->cacheTags = $cacheability->getCacheTags();
Chris@14 42 $this->cacheMaxAge = $cacheability->getCacheMaxAge();
Chris@14 43 return $this;
Chris@14 44 }
Chris@14 45
Chris@14 46 /**
Chris@14 47 * {@inheritdoc}
Chris@14 48 */
Chris@14 49 public function getCacheTags() {
Chris@14 50 return $this->cacheTags;
Chris@14 51 }
Chris@14 52
Chris@14 53 /**
Chris@14 54 * {@inheritdoc}
Chris@14 55 */
Chris@14 56 public function getCacheContexts() {
Chris@14 57 return $this->cacheContexts;
Chris@14 58 }
Chris@14 59
Chris@14 60 /**
Chris@14 61 * {@inheritdoc}
Chris@14 62 */
Chris@14 63 public function getCacheMaxAge() {
Chris@14 64 return $this->cacheMaxAge;
Chris@14 65 }
Chris@14 66
Chris@14 67 }