RequestMatcherInterface.php

Namespace

Symfony\Component\Routing\Matcher

File

drupal/core/vendor/symfony/routing/Symfony/Component/Routing/Matcher/RequestMatcherInterface.php
View source
<?php

/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <fabien@symfony.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace Symfony\Component\Routing\Matcher;

use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Routing\Exception\ResourceNotFoundException;
use Symfony\Component\Routing\Exception\MethodNotAllowedException;

/**
 * RequestMatcherInterface is the interface that all request matcher classes must implement.
 *
 * @author Fabien Potencier <fabien@symfony.com>
 */
interface RequestMatcherInterface {

  /**
   * Tries to match a request with a set of routes.
   *
   * If the matcher can not find information, it must throw one of the exceptions documented
   * below.
   *
   * @param Request $request The request to match
   *
   * @return array An array of parameters
   *
   * @throws ResourceNotFoundException If no matching resource could be found
   * @throws MethodNotAllowedException If a matching resource was found but the request method is not allowed
   */
  public function matchRequest(Request $request);

}

Interfaces

Namesort descending Description
RequestMatcherInterface RequestMatcherInterface is the interface that all request matcher classes must implement.