annotate core/lib/Drupal/Core/Path/PathMatcherInterface.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 4c8ae668cc8c
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\Core\Path;
Chris@0 4
Chris@0 5 /**
Chris@0 6 * Provides an interface for URL path matchers.
Chris@0 7 */
Chris@0 8 interface PathMatcherInterface {
Chris@0 9
Chris@0 10 /**
Chris@0 11 * Checks if a path matches any pattern in a set of patterns.
Chris@0 12 *
Chris@0 13 * @param string $path
Chris@0 14 * The path to match.
Chris@0 15 * @param string $patterns
Chris@0 16 * A set of patterns separated by a newline.
Chris@0 17 *
Chris@0 18 * @return bool
Chris@0 19 * TRUE if the path matches a pattern, FALSE otherwise.
Chris@0 20 */
Chris@0 21 public function matchPath($path, $patterns);
Chris@0 22
Chris@0 23 /**
Chris@0 24 * Checks if the current page is the front page.
Chris@0 25 *
Chris@0 26 * @return bool
Chris@0 27 * TRUE if the current page is the front page.
Chris@0 28 */
Chris@0 29 public function isFrontPage();
Chris@0 30
Chris@0 31 }