vendor/symfony/framework-bundle/Controller/RedirectController.php line 99

Open in your IDE?
  1. <?php
  2. /*
  3.  * This file is part of the Symfony package.
  4.  *
  5.  * (c) Fabien Potencier <fabien@symfony.com>
  6.  *
  7.  * For the full copyright and license information, please view the LICENSE
  8.  * file that was distributed with this source code.
  9.  */
  10. namespace Symfony\Bundle\FrameworkBundle\Controller;
  11. use Symfony\Component\HttpFoundation\RedirectResponse;
  12. use Symfony\Component\HttpFoundation\Request;
  13. use Symfony\Component\HttpFoundation\Response;
  14. use Symfony\Component\HttpKernel\Exception\HttpException;
  15. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  16. /**
  17.  * Redirects a request to another URL.
  18.  *
  19.  * @author Fabien Potencier <fabien@symfony.com>
  20.  *
  21.  * @final
  22.  */
  23. class RedirectController
  24. {
  25.     private $router;
  26.     private $httpPort;
  27.     private $httpsPort;
  28.     public function __construct(UrlGeneratorInterface $router nullint $httpPort nullint $httpsPort null)
  29.     {
  30.         $this->router $router;
  31.         $this->httpPort $httpPort;
  32.         $this->httpsPort $httpsPort;
  33.     }
  34.     /**
  35.      * Redirects to another route with the given name.
  36.      *
  37.      * The response status code is 302 if the permanent parameter is false (default),
  38.      * and 301 if the redirection is permanent.
  39.      *
  40.      * In case the route name is empty, the status code will be 404 when permanent is false
  41.      * and 410 otherwise.
  42.      *
  43.      * @param string     $route             The route name to redirect to
  44.      * @param bool       $permanent         Whether the redirection is permanent
  45.      * @param bool|array $ignoreAttributes  Whether to ignore attributes or an array of attributes to ignore
  46.      * @param bool       $keepRequestMethod Whether redirect action should keep HTTP request method
  47.      *
  48.      * @throws HttpException In case the route name is empty
  49.      */
  50.     public function redirectAction(Request $requeststring $routebool $permanent false$ignoreAttributes falsebool $keepRequestMethod falsebool $keepQueryParams false): Response
  51.     {
  52.         if ('' == $route) {
  53.             throw new HttpException($permanent 410 404);
  54.         }
  55.         $attributes = [];
  56.         if (false === $ignoreAttributes || \is_array($ignoreAttributes)) {
  57.             $attributes $request->attributes->get('_route_params');
  58.             $attributes $keepQueryParams array_merge($request->query->all(), $attributes) : $attributes;
  59.             unset($attributes['route'], $attributes['permanent'], $attributes['ignoreAttributes'], $attributes['keepRequestMethod'], $attributes['keepQueryParams']);
  60.             if ($ignoreAttributes) {
  61.                 $attributes array_diff_key($attributesarray_flip($ignoreAttributes));
  62.             }
  63.         }
  64.         if ($keepRequestMethod) {
  65.             $statusCode $permanent 308 307;
  66.         } else {
  67.             $statusCode $permanent 301 302;
  68.         }
  69.         return new RedirectResponse($this->router->generate($route$attributesUrlGeneratorInterface::ABSOLUTE_URL), $statusCode);
  70.     }
  71.     /**
  72.      * Redirects to a URL.
  73.      *
  74.      * The response status code is 302 if the permanent parameter is false (default),
  75.      * and 301 if the redirection is permanent.
  76.      *
  77.      * In case the path is empty, the status code will be 404 when permanent is false
  78.      * and 410 otherwise.
  79.      *
  80.      * @param string      $path              The absolute path or URL to redirect to
  81.      * @param bool        $permanent         Whether the redirect is permanent or not
  82.      * @param string|null $scheme            The URL scheme (null to keep the current one)
  83.      * @param int|null    $httpPort          The HTTP port (null to keep the current one for the same scheme or the default configured port)
  84.      * @param int|null    $httpsPort         The HTTPS port (null to keep the current one for the same scheme or the default configured port)
  85.      * @param bool        $keepRequestMethod Whether redirect action should keep HTTP request method
  86.      *
  87.      * @throws HttpException In case the path is empty
  88.      */
  89.     public function urlRedirectAction(Request $requeststring $pathbool $permanent falsestring $scheme nullint $httpPort nullint $httpsPort nullbool $keepRequestMethod false): Response
  90.     {
  91.         if ('' == $path) {
  92.             throw new HttpException($permanent 410 404);
  93.         }
  94.         if ($keepRequestMethod) {
  95.             $statusCode $permanent 308 307;
  96.         } else {
  97.             $statusCode $permanent 301 302;
  98.         }
  99.         // redirect if the path is a full URL
  100.         if (parse_url($pathPHP_URL_SCHEME)) {
  101.             return new RedirectResponse($path$statusCode);
  102.         }
  103.         if (null === $scheme) {
  104.             $scheme $request->getScheme();
  105.         }
  106.         $qs $request->getQueryString();
  107.         if ($qs) {
  108.             if (false === strpos($path'?')) {
  109.                 $qs '?'.$qs;
  110.             } else {
  111.                 $qs '&'.$qs;
  112.             }
  113.         }
  114.         $port '';
  115.         if ('http' === $scheme) {
  116.             if (null === $httpPort) {
  117.                 if ('http' === $request->getScheme()) {
  118.                     $httpPort $request->getPort();
  119.                 } else {
  120.                     $httpPort $this->httpPort;
  121.                 }
  122.             }
  123.             if (null !== $httpPort && 80 != $httpPort) {
  124.                 $port ":$httpPort";
  125.             }
  126.         } elseif ('https' === $scheme) {
  127.             if (null === $httpsPort) {
  128.                 if ('https' === $request->getScheme()) {
  129.                     $httpsPort $request->getPort();
  130.                 } else {
  131.                     $httpsPort $this->httpsPort;
  132.                 }
  133.             }
  134.             if (null !== $httpsPort && 443 != $httpsPort) {
  135.                 $port ":$httpsPort";
  136.             }
  137.         }
  138.         $url $scheme.'://'.$request->getHost().$port.$request->getBaseUrl().$path.$qs;
  139.         return new RedirectResponse($url$statusCode);
  140.     }
  141.     public function __invoke(Request $request): Response
  142.     {
  143.         $p $request->attributes->get('_route_params', []);
  144.         if (\array_key_exists('route'$p)) {
  145.             if (\array_key_exists('path'$p)) {
  146.                 throw new \RuntimeException(sprintf('Ambiguous redirection settings, use the "path" or "route" parameter, not both: "%s" and "%s" found respectively in "%s" routing configuration.'$p['path'], $p['route'], $request->attributes->get('_route')));
  147.             }
  148.             return $this->redirectAction($request$p['route'], $p['permanent'] ?? false$p['ignoreAttributes'] ?? false$p['keepRequestMethod'] ?? false$p['keepQueryParams'] ?? false);
  149.         }
  150.         if (\array_key_exists('path'$p)) {
  151.             return $this->urlRedirectAction($request$p['path'], $p['permanent'] ?? false$p['scheme'] ?? null$p['httpPort'] ?? null$p['httpsPort'] ?? null$p['keepRequestMethod'] ?? false);
  152.         }
  153.         throw new \RuntimeException(sprintf('The parameter "path" or "route" is required to configure the redirect action in "%s" routing configuration.'$request->attributes->get('_route')));
  154.     }
  155. }