PathCacheContext.php

Same filename in other branches
  1. 9 core/lib/Drupal/Core/Cache/Context/PathCacheContext.php
  2. 8.9.x core/lib/Drupal/Core/Cache/Context/PathCacheContext.php
  3. 11.x core/lib/Drupal/Core/Cache/Context/PathCacheContext.php

Namespace

Drupal\Core\Cache\Context

File

core/lib/Drupal/Core/Cache/Context/PathCacheContext.php

View source
<?php

namespace Drupal\Core\Cache\Context;

use Drupal\Core\Cache\CacheableMetadata;

/**
 * Defines the PathCacheContext service, for "per URL path" caching.
 *
 * Cache context ID: 'url.path'.
 *
 * (This allows for caching relative URLs.)
 *
 * @see \Symfony\Component\HttpFoundation\Request::getBasePath()
 * @see \Symfony\Component\HttpFoundation\Request::getPathInfo()
 */
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();
    }

}

Classes

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

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