www.aleph1.co.uk Git - yaffs-website/blob - web/core/lib/Drupal/Core/Cache/Context/HeadersCacheContext.php

   1 <?php
   2
   3 namespace Drupal\Core\Cache\Context;
   4
   5 use Drupal\Core\Cache\CacheableMetadata;
   6
   7 /**
   8  * Defines the HeadersCacheContext service, for "per header" caching.
   9  *
  10  * Cache context ID: 'headers' (to vary by all headers).
  11  * Calculated cache context ID: 'headers:%name', e.g. 'headers:X-Something' (to
  12  * vary by the 'X-Something' header).
  13  */
  14 class HeadersCacheContext extends RequestStackCacheContextBase implements CalculatedCacheContextInterface {
  15
  16   /**
  17    * {@inheritdoc}
  18    */
  19   public static function getLabel() {
  20     return t('HTTP headers');
  21   }
  22
  23   /**
  24    * {@inheritdoc}
  25    */
  26   public function getContext($header = NULL) {
  27     if ($header === NULL) {
  28       return $this->requestStack->getCurrentRequest()->headers->all();
  29     }
  30     else {
  31       return $this->requestStack->getCurrentRequest()->headers->get($header);
  32     }
  33   }
  34
  35   /**
  36    * {@inheritdoc}
  37    */
  38   public function getCacheableMetadata($header = NULL) {
  39     return new CacheableMetadata();
  40   }
  41
  42 }