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

Open in your IDE?
  1. <?php
  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.  */
  12. namespace Symfony\Bundle\FrameworkBundle\Controller;
  14. use Symfony\Component\HttpFoundation\RedirectResponse;
  15. use Symfony\Component\HttpFoundation\Request;
  16. use Symfony\Component\HttpFoundation\Response;
  17. use Symfony\Component\HttpKernel\Exception\HttpException;
  18. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  20. /**
  21.  * Redirects a request to another URL.
  22.  *
  23.  * @author Fabien Potencier <fabien@symfony.com>
  24.  *
  25.  * @final
  26.  */
  27. class RedirectController {
  29.     private $router;
  30.     private $httpPort;
  31.     private $httpsPort;
  33.     public function __construct(UrlGeneratorInterface $router = null, int $httpPort = null, int $httpsPort = null) {
  34.         $this->router = $router;
  35.         $this->httpPort = $httpPort;
  36.         $this->httpsPort = $httpsPort;
  37.     }
  39.     /**
  40.      * Redirects to another route with the given name.
  41.      *
  42.      * The response status code is 302 if the permanent parameter is false (default),
  43.      * and 301 if the redirection is permanent.
  44.      *
  45.      * In case the route name is empty, the status code will be 404 when permanent is false
  46.      * and 410 otherwise.
  47.      *
  48.      * @param Request    $request           The request instance
  49.      * @param string     $route             The route name to redirect to
  50.      * @param bool       $permanent         Whether the redirection is permanent
  51.      * @param bool|array $ignoreAttributes  Whether to ignore attributes or an array of attributes to ignore
  52.      * @param bool       $keepRequestMethod Whether redirect action should keep HTTP request method
  53.      *
  54.      * @throws HttpException In case the route name is empty
  55.      */
  56.     public function redirectAction(Request $request, string $route, bool $permanent = false, $ignoreAttributes = false, bool $keepRequestMethod = false, bool $keepQueryParams = false): Response {
  57.         if ('' == $route) {
  58.             throw new HttpException($permanent ? 410 : 404);
  59.         }
  61.         $attributes = [];
  62.         if (false === $ignoreAttributes || \is_array($ignoreAttributes)) {
  63.             $attributes = $request->attributes->get('_route_params');
  64.             $attributes = $keepQueryParams ? array_merge($request->query->all(), $attributes) : $attributes;
  65.             unset($attributes['route'], $attributes['permanent'], $attributes['ignoreAttributes'], $attributes['keepRequestMethod'], $attributes['keepQueryParams']);
  66.             if ($ignoreAttributes) {
  67.                 $attributes = array_diff_key($attributes, array_flip($ignoreAttributes));
  68.             }
  69.         }
  71.         if ($keepRequestMethod) {
  72.             $statusCode = $permanent ? 308 : 307;
  73.         } else {
  74.             $statusCode = $permanent ? 301 : 302;
  75.         }
  77.         return new RedirectResponse($this->router->generate($route, $attributes, UrlGeneratorInterface::ABSOLUTE_URL), $statusCode);
  78.     }
  80.     /**
  81.      * Redirects to a URL.
  82.      *
  83.      * The response status code is 302 if the permanent parameter is false (default),
  84.      * and 301 if the redirection is permanent.
  85.      *
  86.      * In case the path is empty, the status code will be 404 when permanent is false
  87.      * and 410 otherwise.
  88.      *
  89.      * @param Request     $request           The request instance
  90.      * @param string      $path              The absolute path or URL to redirect to
  91.      * @param bool        $permanent         Whether the redirect is permanent or not
  92.      * @param string|null $scheme            The URL scheme (null to keep the current one)
  93.      * @param int|null    $httpPort          The HTTP port (null to keep the current one for the same scheme or the default configured port)
  94.      * @param int|null    $httpsPort         The HTTPS port (null to keep the current one for the same scheme or the default configured port)
  95.      * @param bool        $keepRequestMethod Whether redirect action should keep HTTP request method
  96.      *
  97.      * @throws HttpException In case the path is empty
  98.      */
  99.     public function urlRedirectAction(Request $request, string $path, bool $permanent = false, string $scheme = null, int $httpPort = null, int $httpsPort = null, bool $keepRequestMethod = false): Response {
  100.         if ('' == $path) {
  101.             throw new HttpException($permanent ? 410 : 404);
  102.         }
  104.         if ($keepRequestMethod) {
  105.             $statusCode = $permanent ? 308 : 307;
  106.         } else {
  107.             $statusCode = $permanent ? 301 : 302;
  108.         }
  110.         // redirect if the path is a full URL
  111.         if (parse_url($path, PHP_URL_SCHEME)) {
  112.             return new RedirectResponse($path, $statusCode);
  113.         }
  115.         if (null === $scheme) {
  116.             $scheme = $request->getScheme();
  117.         }
  119.         $qs = $request->getQueryString();
  120.         if ($qs) {
  121.             if (false === strpos($path, '?')) {
  122.                 $qs = '?' . $qs;
  123.             } else {
  124.                 $qs = '&' . $qs;
  125.             }
  126.         }
  128.         $port = '';
  129.         if ('http' === $scheme) {
  130.             if (null === $httpPort) {
  131.                 if ('http' === $request->getScheme()) {
  132.                     $httpPort = $request->getPort();
  133.                 } else {
  134.                     $httpPort = $this->httpPort;
  135.                 }
  136.             }
  138.             if (null !== $httpPort && 80 != $httpPort) {
  139.                 $port = ":$httpPort";
  140.             }
  141.         } elseif ('https' === $scheme) {
  142.             if (null === $httpsPort) {
  143.                 if ('https' === $request->getScheme()) {
  144.                     $httpsPort = $request->getPort();
  145.                 } else {
  146.                     $httpsPort = $this->httpsPort;
  147.                 }
  148.             }
  150.             if (null !== $httpsPort && 443 != $httpsPort) {
  151.                 $port = ":$httpsPort";
  152.             }
  153.         }
  155.         $url = $scheme . '://' . $request->getHost() . $port . $request->getBaseUrl() . $path . $qs;
  157.         return new RedirectResponse($url, $statusCode);
  158.     }
  160. }