You are here

interface PathMatcherInterface in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/lib/Drupal/Core/Path/PathMatcherInterface.php \Drupal\Core\Path\PathMatcherInterface

Provides an interface for URL path matchers.

Hierarchy

Expanded class hierarchy of PathMatcherInterface

All classes that implement PathMatcherInterface

3 files declare their use of PathMatcherInterface
ActiveLinkResponseFilter.php in core/lib/Drupal/Core/EventSubscriber/ActiveLinkResponseFilter.php
Contains \Drupal\Core\EventSubscriber\ActiveLinkResponseFilter.
LanguageBlock.php in core/modules/language/src/Plugin/Block/LanguageBlock.php
Contains \Drupal\language\Plugin\Block\LanguageBlock.
RequestPath.php in core/modules/system/src/Plugin/Condition/RequestPath.php
Contains \Drupal\system\Plugin\Condition\RequestPath.

File

core/lib/Drupal/Core/Path/PathMatcherInterface.php, line 13
Contains \Drupal\Core\Path\PathMatcherInterface.

Namespace

Drupal\Core\Path
View source
interface PathMatcherInterface {

  /**
   * Checks if a path matches any pattern in a set of patterns.
   *
   * @param string $path
   *   The path to match.
   * @param string $patterns
   *   A set of patterns separated by a newline.
   *
   * @return bool
   *   TRUE if the path matches a pattern, FALSE otherwise.
   */
  public function matchPath($path, $patterns);

  /**
   * Checks if the current page is the front page.
   *
   * @return bool
   *   TRUE if the current page is the front page.
   */
  public function isFrontPage();

}

Members

Namesort descending Modifiers Type Description Overrides
PathMatcherInterface::isFrontPage public function Checks if the current page is the front page. 1
PathMatcherInterface::matchPath public function Checks if a path matches any pattern in a set of patterns. 1