class IsFrontPathCacheContext

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

Defines a cache context for whether the URL is the front page of the site.

Cache context ID: 'url.path.is_front'.

Hierarchy

Expanded class hierarchy of IsFrontPathCacheContext

1 file declares its use of IsFrontPathCacheContext
IsFrontPathCacheContextTest.php in core/tests/Drupal/Tests/Core/Cache/Context/IsFrontPathCacheContextTest.php

File

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

Namespace

Drupal\Core\Cache\Context
View source 
class IsFrontPathCacheContext implements CacheContextInterface {
    
    /**
     * @var \Drupal\Core\Path\PathMatcherInterface
     */
    protected $pathMatcher;
    
    /**
     * Constructs an IsFrontPathCacheContext object.
     *
     * @param \Drupal\Core\Path\PathMatcherInterface $path_matcher
     *   The path matcher.
     */
    public function __construct(PathMatcherInterface $path_matcher) {
        $this->pathMatcher = $path_matcher;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function getLabel() {
        return t('Is front page');
    }
    
    /**
     * {@inheritdoc}
     */
    public function getContext() {
        return 'is_front.' . (int) $this->pathMatcher
            ->isFrontPage();
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCacheableMetadata() {
        $metadata = new CacheableMetadata();
        $metadata->addCacheTags([
            'config:system.site',
        ]);
        return $metadata;
    }

}

Members

Title Modifiers Object type Summary Overriden Title
IsFrontPathCacheContext::$pathMatcher protected property
IsFrontPathCacheContext::getCacheableMetadata public function Gets the cacheability metadata for the context. Overrides CacheContextInterface::getCacheableMetadata
IsFrontPathCacheContext::getContext public function Returns the string representation of the cache context. Overrides CacheContextInterface::getContext
IsFrontPathCacheContext::getLabel public static function Returns the label of the cache context. Overrides CacheContextInterface::getLabel
IsFrontPathCacheContext::__construct public function Constructs an IsFrontPathCacheContext object.

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