StreamedResponse.php 3.3KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145
  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. * StreamedResponse represents a streamed HTTP response.
  13. *
  14. * A StreamedResponse uses a callback for its content.
  15. *
  16. * The callback should use the standard PHP functions like echo
  17. * to stream the response back to the client. The flush() method
  18. * can also be used if needed.
  19. *
  20. * @see flush()
  21. *
  22. * @author Fabien Potencier <fabien@symfony.com>
  23. */
  24. class StreamedResponse extends Response
  25. {
  26. protected $callback;
  27. protected $streamed;
  28. private $headersSent;
  29. /**
  30. * @param callable|null $callback A valid PHP callback or null to set it later
  31. * @param int $status The response status code
  32. * @param array $headers An array of response headers
  33. */
  34. public function __construct(callable $callback = null, int $status = 200, array $headers = array())
  35. {
  36. parent::__construct(null, $status, $headers);
  37. if (null !== $callback) {
  38. $this->setCallback($callback);
  39. }
  40. $this->streamed = false;
  41. $this->headersSent = false;
  42. }
  43. /**
  44. * Factory method for chainability.
  45. *
  46. * @param callable|null $callback A valid PHP callback or null to set it later
  47. * @param int $status The response status code
  48. * @param array $headers An array of response headers
  49. *
  50. * @return static
  51. */
  52. public static function create($callback = null, $status = 200, $headers = array())
  53. {
  54. return new static($callback, $status, $headers);
  55. }
  56. /**
  57. * Sets the PHP callback associated with this Response.
  58. *
  59. * @param callable $callback A valid PHP callback
  60. *
  61. * @return $this
  62. */
  63. public function setCallback(callable $callback)
  64. {
  65. $this->callback = $callback;
  66. return $this;
  67. }
  68. /**
  69. * {@inheritdoc}
  70. *
  71. * This method only sends the headers once.
  72. *
  73. * @return $this
  74. */
  75. public function sendHeaders()
  76. {
  77. if ($this->headersSent) {
  78. return $this;
  79. }
  80. $this->headersSent = true;
  81. return parent::sendHeaders();
  82. }
  83. /**
  84. * {@inheritdoc}
  85. *
  86. * This method only sends the content once.
  87. *
  88. * @return $this
  89. */
  90. public function sendContent()
  91. {
  92. if ($this->streamed) {
  93. return $this;
  94. }
  95. $this->streamed = true;
  96. if (null === $this->callback) {
  97. throw new \LogicException('The Response callback must not be null.');
  98. }
  99. call_user_func($this->callback);
  100. return $this;
  101. }
  102. /**
  103. * {@inheritdoc}
  104. *
  105. * @throws \LogicException when the content is not null
  106. *
  107. * @return $this
  108. */
  109. public function setContent($content)
  110. {
  111. if (null !== $content) {
  112. throw new \LogicException('The content cannot be set on a StreamedResponse instance.');
  113. }
  114. return $this;
  115. }
  116. /**
  117. * {@inheritdoc}
  118. *
  119. * @return false
  120. */
  121. public function getContent()
  122. {
  123. return false;
  124. }
  125. }