PathMatcherInterface.php

Same filename in other branches
  1. 9 core/lib/Drupal/Core/Path/PathMatcherInterface.php
  2. 8.9.x core/lib/Drupal/Core/Path/PathMatcherInterface.php
  3. 10 core/lib/Drupal/Core/Path/PathMatcherInterface.php

Namespace

Drupal\Core\Path

File

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

View source
<?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

Title Deprecated Summary
PathMatcherInterface Provides an interface for URL path matchers.

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