function CookiesCacheContext::getContext

Same name in other branches
  1. 8.9.x core/lib/Drupal/Core/Cache/Context/CookiesCacheContext.php \Drupal\Core\Cache\Context\CookiesCacheContext::getContext()
  2. 10 core/lib/Drupal/Core/Cache/Context/CookiesCacheContext.php \Drupal\Core\Cache\Context\CookiesCacheContext::getContext()
  3. 11.x core/lib/Drupal/Core/Cache/Context/CookiesCacheContext.php \Drupal\Core\Cache\Context\CookiesCacheContext::getContext()

Overrides CalculatedCacheContextInterface::getContext

File

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

Class

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

Namespace

Drupal\Core\Cache\Context

Code

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);
    }
}

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