class CookiesCacheContext in Drupal 10

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

• class \Drupal\Core\Cache\Context\RequestStackCacheContextBase
  • class \Drupal\Core\Cache\Context\CookiesCacheContext implements CalculatedCacheContextInterface

1 file declares its use of CookiesCacheContext

CookieCacheContextTest.php in core/tests/Drupal/Tests/Core/Cache/Context/CookieCacheContextTest.php

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

class CookiesCacheContext extends RequestStackCacheContextBase implements CalculatedCacheContextInterface {

  /**
   * {@inheritdoc}
   */
  public static function getLabel() {
    return t('HTTP cookies');
  }

  /**
   * {@inheritdoc}
   */
  public function getContext($cookie = NULL) {
    if ($cookie === NULL) {
      $cookies = $this->requestStack
        ->getCurrentRequest()->cookies
        ->all();

      // Sort the cookies by names, to always set the same context if the cookies
      // are the same but in a different order.
      ksort($cookies);

      // Use http_build_query() to get a short string from the cookies array.
      return http_build_query($cookies);
    }
    else {
      return $this->requestStack
        ->getCurrentRequest()->cookies
        ->get($cookie);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheableMetadata($cookie = NULL) {
    return new CacheableMetadata();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.