4 * This file is part of the Symfony package.
6 * (c) Fabien Potencier <fabien@symfony.com>
8 * For the full copyright and license information, please view the LICENSE
9 * file that was distributed with this source code.
12 namespace Symfony\Component\HttpFoundation;
15 * RedirectResponse represents an HTTP response doing a redirect.
17 * @author Fabien Potencier <fabien@symfony.com>
19 class RedirectResponse extends Response
24 * Creates a redirect response so that it conforms to the rules defined for a redirect status code.
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)
31 * @throws \InvalidArgumentException
33 * @see http://tools.ietf.org/html/rfc2616#section-10.3
35 public function __construct($url, $status = 302, $headers = array())
37 parent::__construct('', $status, $headers);
39 $this->setTargetUrl($url);
41 if (!$this->isRedirect()) {
42 throw new \InvalidArgumentException(sprintf('The HTTP status code is not a redirect ("%s" given).', $status));
49 public static function create($url = '', $status = 302, $headers = array())
51 return new static($url, $status, $headers);
55 * Returns the target URL.
57 * @return string target URL
59 public function getTargetUrl()
61 return $this->targetUrl;
65 * Sets the redirect target of this response.
67 * @param string $url The URL to redirect to
71 * @throws \InvalidArgumentException
73 public function setTargetUrl($url)
76 throw new \InvalidArgumentException('Cannot redirect to an empty URL.');
79 $this->targetUrl = $url;
82 sprintf('<!DOCTYPE html>
85 <meta charset="UTF-8" />
86 <meta http-equiv="refresh" content="1;url=%1$s" />
88 <title>Redirecting to %1$s</title>
91 Redirecting to <a href="%1$s">%1$s</a>.
93 </html>', htmlspecialchars($url, ENT_QUOTES, 'UTF-8')));
95 $this->headers->set('Location', $url);