vendor/symfony/routing/Symfony/Component/Routing/Matcher/UrlMatcherInterface.php

   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\RequestContextAwareInterface;
  15 use Symfony\Component\Routing\Exception\ResourceNotFoundException;
  16 use Symfony\Component\Routing\Exception\MethodNotAllowedException;
  17
  18 /**
  19  * UrlMatcherInterface is the interface that all URL matcher classes must implement.
  20  *
  21  * @author Fabien Potencier <fabien@symfony.com>
  22  *
  23  * @api
  24  */
  25 interface UrlMatcherInterface extends RequestContextAwareInterface
  26 {
  27     /**
  28      * Tries to match a URL path with a set of routes.
  29      *
  30      * If the matcher can not find information, it must throw one of the exceptions documented
  31      * below.
  32      *
  33      * @param string $pathinfo The path info to be parsed (raw format, i.e. not urldecoded)
  34      *
  35      * @return array An array of parameters
  36      *
  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      * @api
  41      */
  42     public function match($pathinfo);
  43 }