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

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 Request    $request           The request instance
  44.      * @param string     $route             The route name to redirect to
  45.      * @param bool       $permanent         Whether the redirection is permanent
  46.      * @param bool|array $ignoreAttributes  Whether to ignore attributes or an array of attributes to ignore
  47.      * @param bool       $keepRequestMethod Whether redirect action should keep HTTP request method
  48.      *
  49.      * @throws HttpException In case the route name is empty
  50.      */
  51.     public function redirectAction(Request $requeststring $routebool $permanent false$ignoreAttributes falsebool $keepRequestMethod falsebool $keepQueryParams false): Response
  52.     {
  53.         if ('' == $route) {
  54.             throw new HttpException($permanent 410 404);
  55.         }
  56.         $attributes = [];
  57.         if (false === $ignoreAttributes || \is_array($ignoreAttributes)) {
  58.             $attributes $request->attributes->get('_route_params');
  59.             $attributes $keepQueryParams array_merge($request->query->all(), $attributes) : $attributes;
  60.             unset($attributes['route'], $attributes['permanent'], $attributes['ignoreAttributes'], $attributes['keepRequestMethod'], $attributes['keepQueryParams']);
  61.             if ($ignoreAttributes) {
  62.                 $attributes array_diff_key($attributesarray_flip($ignoreAttributes));
  63.             }
  64.         }
  65.         if ($keepRequestMethod) {
  66.             $statusCode $permanent 308 307;
  67.         } else {
  68.             $statusCode $permanent 301 302;
  69.         }
  70.         return new RedirectResponse($this->router->generate($route$attributesUrlGeneratorInterface::ABSOLUTE_URL), $statusCode);
  71.     }
  72.     /**
  73.      * Redirects to a URL.
  74.      *
  75.      * The response status code is 302 if the permanent parameter is false (default),
  76.      * and 301 if the redirection is permanent.
  77.      *
  78.      * In case the path is empty, the status code will be 404 when permanent is false
  79.      * and 410 otherwise.
  80.      *
  81.      * @param Request     $request           The request instance
  82.      * @param string      $path              The absolute path or URL to redirect to
  83.      * @param bool        $permanent         Whether the redirect is permanent or not
  84.      * @param string|null $scheme            The URL scheme (null to keep the current one)
  85.      * @param int|null    $httpPort          The HTTP port (null to keep the current one for the same scheme or the default configured port)
  86.      * @param int|null    $httpsPort         The HTTPS port (null to keep the current one for the same scheme or the default configured port)
  87.      * @param bool        $keepRequestMethod Whether redirect action should keep HTTP request method
  88.      *
  89.      * @throws HttpException In case the path is empty
  90.      */
  91.     public function urlRedirectAction(Request $requeststring $pathbool $permanent falsestring $scheme nullint $httpPort nullint $httpsPort nullbool $keepRequestMethod false): Response
  92.     {
  93.         if ('' == $path) {
  94.             throw new HttpException($permanent 410 404);
  95.         }
  96.         if ($keepRequestMethod) {
  97.             $statusCode $permanent 308 307;
  98.         } else {
  99.             $statusCode $permanent 301 302;
  100.         }
  101.         // redirect if the path is a full URL
  102.         if (parse_url($pathPHP_URL_SCHEME)) {
  103.             return new RedirectResponse($path$statusCode);
  104.         }
  105.         if (null === $scheme) {
  106.             $scheme $request->getScheme();
  107.         }
  108.         $qs $request->getQueryString();
  109.         if ($qs) {
  110.             if (false === strpos($path'?')) {
  111.                 $qs '?'.$qs;
  112.             } else {
  113.                 $qs '&'.$qs;
  114.             }
  115.         }
  116.         $port '';
  117.         if ('http' === $scheme) {
  118.             if (null === $httpPort) {
  119.                 if ('http' === $request->getScheme()) {
  120.                     $httpPort $request->getPort();
  121.                 } else {
  122.                     $httpPort $this->httpPort;
  123.                 }
  124.             }
  125.             if (null !== $httpPort && 80 != $httpPort) {
  126.                 $port ":$httpPort";
  127.             }
  128.         } elseif ('https' === $scheme) {
  129.             if (null === $httpsPort) {
  130.                 if ('https' === $request->getScheme()) {
  131.                     $httpsPort $request->getPort();
  132.                 } else {
  133.                     $httpsPort $this->httpsPort;
  134.                 }
  135.             }
  136.             if (null !== $httpsPort && 443 != $httpsPort) {
  137.                 $port ":$httpsPort";
  138.             }
  139.         }
  140.         $url $scheme.'://'.$request->getHost().$port.$request->getBaseUrl().$path.$qs;
  141.         return new RedirectResponse($url$statusCode);
  142.     }
  143. }