vendor/symfony/routing/Symfony/Component/Routing/Matcher/RedirectableUrlMatcherInterface.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 /**
  15  * RedirectableUrlMatcherInterface knows how to redirect the user.
  16  *
  17  * @author Fabien Potencier <fabien@symfony.com>
  18  *
  19  * @api
  20  */
  21 interface RedirectableUrlMatcherInterface
  22 {
  23     /**
  24      * Redirects the user to another URL.
  25      *
  26      * @param string      $path   The path info to redirect to.
  27      * @param string      $route  The route name that matched
  28      * @param string|null $scheme The URL scheme (null to keep the current one)
  29      *
  30      * @return array An array of parameters
  31      *
  32      * @api
  33      */
  34     public function redirect($path, $route, $scheme = null);
  35 }