RedirectResponse.php 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\HttpFoundation;
  11. /**
  12. * RedirectResponse represents an HTTP response doing a redirect.
  13. *
  14. * @author Fabien Potencier <fabien@symfony.com>
  15. */
  16. class RedirectResponse extends Response
  17. {
  18. protected $targetUrl;
  19. /**
  20. * Creates a redirect response so that it conforms to the rules defined for a redirect status code.
  21. *
  22. * @param string $url The URL to redirect to. The URL should be a full URL, with schema etc.,
  23. * but practically every browser redirects on paths only as well
  24. * @param int $status The status code (302 by default)
  25. * @param array $headers The headers (Location is always set to the given URL)
  26. *
  27. * @throws \InvalidArgumentException
  28. *
  29. * @see http://tools.ietf.org/html/rfc2616#section-10.3
  30. */
  31. public function __construct($url, $status = 302, $headers = array())
  32. {
  33. parent::__construct('', $status, $headers);
  34. $this->setTargetUrl($url);
  35. if (!$this->isRedirect()) {
  36. throw new \InvalidArgumentException(sprintf('The HTTP status code is not a redirect ("%s" given).', $status));
  37. }
  38. }
  39. /**
  40. * Factory method for chainability.
  41. *
  42. * @param string $url The url to redirect to
  43. * @param int $status The response status code
  44. * @param array $headers An array of response headers
  45. *
  46. * @return static
  47. */
  48. public static function create($url = '', $status = 302, $headers = array())
  49. {
  50. return new static($url, $status, $headers);
  51. }
  52. /**
  53. * Returns the target URL.
  54. *
  55. * @return string target URL
  56. */
  57. public function getTargetUrl()
  58. {
  59. return $this->targetUrl;
  60. }
  61. /**
  62. * Sets the redirect target of this response.
  63. *
  64. * @param string $url The URL to redirect to
  65. *
  66. * @return $this
  67. *
  68. * @throws \InvalidArgumentException
  69. */
  70. public function setTargetUrl($url)
  71. {
  72. if (empty($url)) {
  73. throw new \InvalidArgumentException('Cannot redirect to an empty URL.');
  74. }
  75. $this->targetUrl = $url;
  76. $this->setContent(
  77. sprintf('<!DOCTYPE html>
  78. <html>
  79. <head>
  80. <meta charset="UTF-8" />
  81. <meta http-equiv="refresh" content="0;url=%1$s" />
  82. <title>Redirecting to %1$s</title>
  83. </head>
  84. <body>
  85. Redirecting to <a href="%1$s">%1$s</a>.
  86. </body>
  87. </html>', htmlspecialchars($url, ENT_QUOTES, 'UTF-8')));
  88. $this->headers->set('Location', $url);
  89. return $this;
  90. }
  91. }