class CookiesCacheContext
Same name and namespace in other branches
- 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
- class \Drupal\Core\Cache\Context\RequestStackCacheContextBase
- class \Drupal\Core\Cache\Context\CookiesCacheContext extends \Drupal\Core\Cache\Context\CalculatedCacheContextInterface implements \Drupal\Core\Cache\Context\RequestStackCacheContextBase
Expanded class hierarchy of CookiesCacheContext
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
File
-
core/
lib/ Drupal/ Core/ Cache/ Context/ CookiesCacheContext.php, line 14
Namespace
Drupal\Core\Cache\ContextView 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) {
$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();
}
}Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.