class UrlCacheContext

Defines the UrlCacheContext service, for "per page" caching.

Cache context ID: 'url'.

Hierarchy

class \Drupal\Core\Cache\Context\RequestStackCacheContextBase
- class \Drupal\Core\Cache\Context\UrlCacheContext extends \Drupal\Core\Cache\Context\RequestStackCacheContextBase implements \Drupal\Core\Cache\Context\CacheContextInterface

Expanded class hierarchy of UrlCacheContext

File

core/lib/Drupal/Core/Cache/Context/UrlCacheContext.php, line 12

Namespace

Drupal\Core\Cache\Context

View source

class UrlCacheContext extends RequestStackCacheContextBase implements CacheContextInterface {
    
    /**
     * {@inheritdoc}
     */
    public static function getLabel() {
        return t('URL');
    }
    
    /**
     * {@inheritdoc}
     */
    public function getContext() {
        return $this->requestStack
            ->getCurrentRequest()
            ->getUri();
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCacheableMetadata() {
        return new CacheableMetadata();
    }

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overriden Title
RequestStackCacheContextBase::$requestStack	protected	property	The request stack.
RequestStackCacheContextBase::__construct	public	function	Constructs a new RequestStackCacheContextBase class.
UrlCacheContext::getCacheableMetadata	public	function	Gets the cacheability metadata for the context.	Overrides CacheContextInterface::getCacheableMetadata
UrlCacheContext::getContext	public	function	Returns the string representation of the cache context.	Overrides CacheContextInterface::getContext
UrlCacheContext::getLabel	public static	function	Returns the label of the cache context.	Overrides CacheContextInterface::getLabel