[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  /*
   4   * This file is part of the Symfony package.
   5   *
   6   * (c) Fabien Potencier <fabien@symfony.com>
   7   *
   8   * For the full copyright and license information, please view the LICENSE
   9   * file that was distributed with this source code.
  10   */
  11  
  12  namespace Symfony\Component\Routing\Matcher;
  13  
  14  use Symfony\Component\Routing\Exception\MethodNotAllowedException;
  15  use Symfony\Component\Routing\Exception\NoConfigurationException;
  16  use Symfony\Component\Routing\Exception\ResourceNotFoundException;
  17  use Symfony\Component\Routing\RequestContextAwareInterface;
  18  
  19  /**
  20   * UrlMatcherInterface is the interface that all URL matcher classes must implement.
  21   *
  22   * @author Fabien Potencier <fabien@symfony.com>
  23   */
  24  interface UrlMatcherInterface extends RequestContextAwareInterface
  25  {
  26      /**
  27       * Tries to match a URL path with a set of routes.
  28       *
  29       * If the matcher can not find information, it must throw one of the exceptions documented
  30       * below.
  31       *
  32       * @param string $pathinfo The path info to be parsed (raw format, i.e. not urldecoded)
  33       *
  34       * @return array An array of parameters
  35       *
  36       * @throws NoConfigurationException  If no routing configuration could be found
  37       * @throws ResourceNotFoundException If the resource could not be found
  38       * @throws MethodNotAllowedException If the resource was found but the request method is not allowed
  39       */
  40      public function match($pathinfo);
  41  }