Classes List

Symfony\Component\HttpFoundation\RedirectResponse

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
 55 
 56 
 57 
 58 
 59 
 60 
 61 
 62 
 63 
 64 
 65 
 66 
 67 
 68 
 69 
 70 
 71 
 72 
 73 
 74 
 75 
 76 
 77 
 78 
 79 
 80 
 81 
 82 
 83 
 84 
 85 
 86 
 87 
 88 
 89 
 90 
 91 
 92 
 93 
 94 
 95 
 96 
 97 
 98 
 99 
 100 
 101 
 102 
 103 
 104 
 105 
 106 
 107 
 108 
 109 
 110 
<?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 http://tools.ietf.org/html/rfc2616#section-10.3 */
    public function __construct($url$status = 302$headers = array())
    {
        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'$headers)) {
            $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 = array())
    {
        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 (empty($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($urlENT_QUOTES'UTF-8')));

        $this->headers->set('Location'$url);

        return $this;
    }
}