www.aleph1.co.uk Git - yaffs-website/blob - web/core/lib/Drupal/Core/Path/PathMatcherInterface.php

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