class PathCacheContext in Drupal 9

Defines the PathCacheContext service, for "per URL path" caching.

Cache context ID: 'url.path'.

(This allows for caching relative URLs.)

Hierarchy

• class \Drupal\Core\Cache\Context\RequestStackCacheContextBase
  • class \Drupal\Core\Cache\Context\PathCacheContext implements CacheContextInterface

See also

\Symfony\Component\HttpFoundation\Request::getBasePath()

\Symfony\Component\HttpFoundation\Request::getPathInfo()

1 string reference to 'PathCacheContext'

core.services.yml in core/core.services.yml

core/core.services.yml

1 service uses PathCacheContext

cache_context.url.path in core/core.services.yml

Drupal\Core\Cache\Context\PathCacheContext

File

core/lib/Drupal/Core/Cache/Context/PathCacheContext.php, line 17

Namespace

Drupal\Core\Cache\Context

class PathCacheContext extends RequestStackCacheContextBase implements CacheContextInterface {

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

  /**
   * {@inheritdoc}
   */
  public function getContext() {
    $request = $this->requestStack
      ->getCurrentRequest();
    return $request
      ->getBasePath() . $request
      ->getPathInfo();
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheableMetadata() {
    return new CacheableMetadata();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PathCacheContext::getCacheableMetadata	public	function	Gets the cacheability metadata for the context. Overrides CacheContextInterface::getCacheableMetadata
PathCacheContext::getContext	public	function	Returns the string representation of the cache context. Overrides CacheContextInterface::getContext
PathCacheContext::getLabel	public static	function	Returns the label of the cache context. Overrides CacheContextInterface::getLabel
RequestStackCacheContextBase::$requestStack	protected	property	The request stack.
RequestStackCacheContextBase::__construct	public	function	Constructs a new RequestStackCacheContextBase class.