class RouteCacheContext

Same name and namespace in other branches
  1. 11.x core/lib/Drupal/Core/Cache/Context/RouteCacheContext.php \Drupal\Core\Cache\Context\RouteCacheContext
  2. 10 core/lib/Drupal/Core/Cache/Context/RouteCacheContext.php \Drupal\Core\Cache\Context\RouteCacheContext
  3. 9 core/lib/Drupal/Core/Cache/Context/RouteCacheContext.php \Drupal\Core\Cache\Context\RouteCacheContext
  4. 8.9.x core/lib/Drupal/Core/Cache/Context/RouteCacheContext.php \Drupal\Core\Cache\Context\RouteCacheContext

Defines the RouteCacheContext service, for "per route" caching.

Cache context ID: 'route'.

Hierarchy

Expanded class hierarchy of RouteCacheContext

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

File

View on git.drupalcode.org

core/lib/Drupal/Core/Cache/Context/RouteCacheContext.php, line 13

Namespace

Drupal\Core\Cache\Context
View source 
class RouteCacheContext implements CacheContextInterface {
  
  /**
   * Constructs a new RouteCacheContext class.
   *
   * @param \Drupal\Core\Routing\RouteMatchInterface $routeMatch
   *   The route match.
   */
  public function __construct(protected RouteMatchInterface $routeMatch) {
  }
  
  /**
   * {@inheritdoc}
   */
  public static function getLabel() {
    return t('Route');
  }
  
  /**
   * {@inheritdoc}
   */
  public function getContext() {
    return $this->routeMatch
      ->getRouteName() . hash('sha256', serialize($this->routeMatch
      ->getRawParameters()
      ->all()));
  }
  
  /**
   * {@inheritdoc}
   */
  public function getCacheableMetadata() {
    return new CacheableMetadata();
  }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
RouteCacheContext::getCacheableMetadata public function Overrides CacheContextInterface::getCacheableMetadata
RouteCacheContext::getContext public function Overrides CacheContextInterface::getContext 1
RouteCacheContext::getLabel public static function Overrides CacheContextInterface::getLabel 1
RouteCacheContext::__construct public function Constructs a new RouteCacheContext class.

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