annotate vendor/symfony/routing/Matcher/UrlMatcherInterface.php @ 19:fa3358dc1485 tip

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