PathMatcherInterface.php in Drupal 9

Namespace

Drupal\Core\Path

File

core/lib/Drupal/Core/Path/PathMatcherInterface.php

<?php

namespace Drupal\Core\Path;


/**
 * Provides an interface for URL path matchers.
 */
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();

}

Interfaces

Name	Description
PathMatcherInterface	Provides an interface for URL path matchers.