class CookiesCacheContext

Same name in other branches
  1. 9 core/lib/Drupal/Core/Cache/Context/CookiesCacheContext.php \Drupal\Core\Cache\Context\CookiesCacheContext
  2. 10 core/lib/Drupal/Core/Cache/Context/CookiesCacheContext.php \Drupal\Core\Cache\Context\CookiesCacheContext
  3. 11.x core/lib/Drupal/Core/Cache/Context/CookiesCacheContext.php \Drupal\Core\Cache\Context\CookiesCacheContext

Defines the CookiesCacheContext service, for "per cookie" caching.

Cache context ID: 'cookies' (to vary by all cookies). Calculated cache context ID: 'cookies:%name', e.g. 'cookies:device_type' (to vary by the 'device_type' cookie).

Hierarchy

Expanded class hierarchy of CookiesCacheContext

1 string reference to 'CookiesCacheContext'
core.services.yml in core/core.services.yml
core/core.services.yml
1 service uses CookiesCacheContext
cache_context.cookies in core/core.services.yml
Drupal\Core\Cache\Context\CookiesCacheContext

File

core/lib/Drupal/Core/Cache/Context/CookiesCacheContext.php, line 14

Namespace

Drupal\Core\Cache\Context
View source 
class CookiesCacheContext extends RequestStackCacheContextBase implements CalculatedCacheContextInterface {
    
    /**
     * {@inheritdoc}
     */
    public static function getLabel() {
        return t('HTTP cookies');
    }
    
    /**
     * {@inheritdoc}
     */
    public function getContext($cookie = NULL) {
        if ($cookie === NULL) {
            return $this->requestStack
                ->getCurrentRequest()->cookies
                ->all();
        }
        else {
            return $this->requestStack
                ->getCurrentRequest()->cookies
                ->get($cookie);
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCacheableMetadata($cookie = NULL) {
        return new CacheableMetadata();
    }

}

Members

Title Modifiers Object type Summary Overriden Title
CookiesCacheContext::getCacheableMetadata public function Gets the cacheability metadata for the context based on the parameter value. Overrides CalculatedCacheContextInterface::getCacheableMetadata
CookiesCacheContext::getContext public function Returns the string representation of the cache context. Overrides CalculatedCacheContextInterface::getContext
CookiesCacheContext::getLabel public static function Returns the label of the cache context. Overrides CalculatedCacheContextInterface::getLabel
RequestStackCacheContextBase::$requestStack protected property The request stack.
RequestStackCacheContextBase::__construct public function Constructs a new RequestStackCacheContextBase class.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.