class RouteCacheContext in Drupal 8

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

Cache context ID: 'route'.

Hierarchy

• class \Drupal\Core\Cache\Context\RouteCacheContext implements CacheContextInterface

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

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

Namespace

Drupal\Core\Cache\Context

class RouteCacheContext implements CacheContextInterface {

  /**
   * The route match.
   *
   * @var \Drupal\Core\Routing\RouteMatchInterface
   */
  protected $routeMatch;

  /**
   * Constructs a new RouteCacheContext class.
   *
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   The route match.
   */
  public function __construct(RouteMatchInterface $route_match) {
    $this->routeMatch = $route_match;
  }

  /**
   * {@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

Name	Modifiers	Type	Description	Overrides
RouteCacheContext::$routeMatch	protected	property	The route match.
RouteCacheContext::getCacheableMetadata	public	function	Gets the cacheability metadata for the context. Overrides CacheContextInterface::getCacheableMetadata
RouteCacheContext::getContext	public	function	Returns the string representation of the cache context. Overrides CacheContextInterface::getContext	1
RouteCacheContext::getLabel	public static	function	Returns the label of the cache context. Overrides CacheContextInterface::getLabel	1
RouteCacheContext::__construct	public	function	Constructs a new RouteCacheContext class.