class IsFrontPathCacheContext in Drupal 9

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

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

Hierarchy

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

1 file declares its use of IsFrontPathCacheContext

IsFrontPathCacheContextTest.php in core/tests/Drupal/Tests/Core/Cache/Context/IsFrontPathCacheContextTest.php

1 string reference to 'IsFrontPathCacheContext'

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

core/core.services.yml

1 service uses IsFrontPathCacheContext

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

Drupal\Core\Cache\Context\IsFrontPathCacheContext

File

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

Namespace

Drupal\Core\Cache\Context

class IsFrontPathCacheContext implements CacheContextInterface {

  /**
   * @var \Drupal\Core\Path\PathMatcherInterface
   */
  protected $pathMatcher;

  /**
   * Constructs an IsFrontPathCacheContext object.
   *
   * @param \Drupal\Core\Path\PathMatcherInterface $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

Name	Modifiers	Type	Description	Overrides
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.