vendor/symfony/http-foundation/RedirectResponse.php line 19

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\Component\HttpFoundation;
  14. /**
  15.  * RedirectResponse represents an HTTP response doing a redirect.
  16.  *
  17.  * @author Fabien Potencier <fabien@symfony.com>
  18.  */
  19. class RedirectResponse extends Response
  20. {
  21.     protected $targetUrl;
  23.     /**
  24.      * Creates a redirect response so that it conforms to the rules defined for a redirect status code.
  25.      *
  26.      * @param string $url     The URL to redirect to. The URL should be a full URL, with schema etc.,
  27.      *                        but practically every browser redirects on paths only as well
  28.      * @param int    $status  The status code (302 by default)
  29.      * @param array  $headers The headers (Location is always set to the given URL)
  30.      *
  31.      * @throws \InvalidArgumentException
  32.      *
  33.      * @see https://tools.ietf.org/html/rfc2616#section-10.3
  34.      */
  35.     public function __construct(?string $url, int $status = 302, array $headers = [])
  36.     {
  37.         if (null === $url) {
  38.             @trigger_error(sprintf('Passing a null url when instantiating a "%s" is deprecated since Symfony 4.4.', __CLASS__), \E_USER_DEPRECATED);
  39.             $url = '';
  40.         }
  42.         parent::__construct('', $status, $headers);
  44.         $this->setTargetUrl($url);
  46.         if (!$this->isRedirect()) {
  47.             throw new \InvalidArgumentException(sprintf('The HTTP status code is not a redirect ("%s" given).', $status));
  48.         }
  50.         if (301 == $status && !\array_key_exists('cache-control', array_change_key_case($headers, \CASE_LOWER))) {
  51.             $this->headers->remove('cache-control');
  52.         }
  53.     }
  55.     /**
  56.      * Factory method for chainability.
  57.      *
  58.      * @param string $url     The url to redirect to
  59.      * @param int    $status  The response status code
  60.      * @param array  $headers An array of response headers
  61.      *
  62.      * @return static
  63.      */
  64.     public static function create($url = '', $status = 302, $headers = [])
  65.     {
  66.         return new static($url, $status, $headers);
  67.     }
  69.     /**
  70.      * Returns the target URL.
  71.      *
  72.      * @return string target URL
  73.      */
  74.     public function getTargetUrl()
  75.     {
  76.         return $this->targetUrl;
  77.     }
  79.     /**
  80.      * Sets the redirect target of this response.
  81.      *
  82.      * @param string $url The URL to redirect to
  83.      *
  84.      * @return $this
  85.      *
  86.      * @throws \InvalidArgumentException
  87.      */
  88.     public function setTargetUrl($url)
  89.     {
  90.         if ('' === ($url ?? '')) {
  91.             throw new \InvalidArgumentException('Cannot redirect to an empty URL.');
  92.         }
  94.         $this->targetUrl = $url;
  96.         $this->setContent(
  97.             sprintf('<!DOCTYPE html>
  98. <html>
  99.     <head>
  100.         <meta charset="UTF-8" />
  101.         <meta http-equiv="refresh" content="0;url=\'%1$s\'" />
  103.         <title>Redirecting to %1$s</title>
  104.     </head>
  105.     <body>
  106.         Redirecting to <a href="%1$s">%1$s</a>.
  107.     </body>
  108. </html>', htmlspecialchars($url, \ENT_QUOTES, 'UTF-8')));
  110.         $this->headers->set('Location', $url);
  112.         return $this;
  113.     }
  114. }