123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114 |
- <?php
- /*
- * This file is part of the Symfony package.
- *
- * (c) Fabien Potencier <fabien@symfony.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
- namespace Symfony\Component\HttpFoundation;
- /**
- * RedirectResponse represents an HTTP response doing a redirect.
- *
- * @author Fabien Potencier <fabien@symfony.com>
- */
- class RedirectResponse extends Response
- {
- protected $targetUrl;
- /**
- * Creates a redirect response so that it conforms to the rules defined for a redirect status code.
- *
- * @param string $url The URL to redirect to. The URL should be a full URL, with schema etc.,
- * but practically every browser redirects on paths only as well
- * @param int $status The status code (302 by default)
- * @param array $headers The headers (Location is always set to the given URL)
- *
- * @throws \InvalidArgumentException
- *
- * @see https://tools.ietf.org/html/rfc2616#section-10.3
- */
- public function __construct(?string $url, int $status = 302, array $headers = [])
- {
- if (null === $url) {
- @trigger_error(sprintf('Passing a null url when instantiating a "%s" is deprecated since Symfony 4.4.', __CLASS__), \E_USER_DEPRECATED);
- $url = '';
- }
- parent::__construct('', $status, $headers);
- $this->setTargetUrl($url);
- if (!$this->isRedirect()) {
- throw new \InvalidArgumentException(sprintf('The HTTP status code is not a redirect ("%s" given).', $status));
- }
- if (301 == $status && !\array_key_exists('cache-control', array_change_key_case($headers, \CASE_LOWER))) {
- $this->headers->remove('cache-control');
- }
- }
- /**
- * Factory method for chainability.
- *
- * @param string $url The url to redirect to
- * @param int $status The response status code
- * @param array $headers An array of response headers
- *
- * @return static
- */
- public static function create($url = '', $status = 302, $headers = [])
- {
- return new static($url, $status, $headers);
- }
- /**
- * Returns the target URL.
- *
- * @return string target URL
- */
- public function getTargetUrl()
- {
- return $this->targetUrl;
- }
- /**
- * Sets the redirect target of this response.
- *
- * @param string $url The URL to redirect to
- *
- * @return $this
- *
- * @throws \InvalidArgumentException
- */
- public function setTargetUrl($url)
- {
- if ('' === ($url ?? '')) {
- throw new \InvalidArgumentException('Cannot redirect to an empty URL.');
- }
- $this->targetUrl = $url;
- $this->setContent(
- sprintf('<!DOCTYPE html>
- <html>
- <head>
- <meta charset="UTF-8" />
- <meta http-equiv="refresh" content="0;url=\'%1$s\'" />
- <title>Redirecting to %1$s</title>
- </head>
- <body>
- Redirecting to <a href="%1$s">%1$s</a>.
- </body>
- </html>', htmlspecialchars($url, \ENT_QUOTES, 'UTF-8')));
- $this->headers->set('Location', $url);
- return $this;
- }
- }
|