StreamedResponse represents a streamed HTTP response.
A StreamedResponse uses a callback for its content.
The callback should use the standard PHP functions like echo to stream the response back to the client. The flush() method can also be used if needed.
@author Fabien Potencier <fabien@symfony.com>
@api
Expanded class hierarchy of StreamedResponse
flush()
class StreamedResponse extends Response {
protected $callback;
protected $streamed;
/**
* Constructor.
*
* @param mixed $callback A valid PHP callback
* @param integer $status The response status code
* @param array $headers An array of response headers
*
* @api
*/
public function __construct($callback = null, $status = 200, $headers = array()) {
parent::__construct(null, $status, $headers);
if (null !== $callback) {
$this
->setCallback($callback);
}
$this->streamed = false;
}
/**
* {@inheritDoc}
*/
public static function create($callback = null, $status = 200, $headers = array()) {
return new static($callback, $status, $headers);
}
/**
* Sets the PHP callback associated with this Response.
*
* @param mixed $callback A valid PHP callback
*/
public function setCallback($callback) {
if (!is_callable($callback)) {
throw new \LogicException('The Response callback must be a valid PHP callable.');
}
$this->callback = $callback;
}
/**
* {@inheritdoc}
*/
public function prepare(Request $request) {
if ('HTTP/1.0' != $request->server
->get('SERVER_PROTOCOL')) {
$this
->setProtocolVersion('1.1');
}
$this->headers
->set('Cache-Control', 'no-cache');
return parent::prepare($request);
}
/**
* {@inheritdoc}
*
* This method only sends the content once.
*/
public function sendContent() {
if ($this->streamed) {
return;
}
$this->streamed = true;
if (null === $this->callback) {
throw new \LogicException('The Response callback must not be null.');
}
call_user_func($this->callback);
}
/**
* {@inheritdoc}
*
* @throws \LogicException when the content is not null
*/
public function setContent($content) {
if (null !== $content) {
throw new \LogicException('The content cannot be set on a StreamedResponse instance.');
}
}
/**
* {@inheritdoc}
*
* @return false
*/
public function getContent() {
return false;
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
StreamedResponse:: |
public | function |
Constructor. Overrides Response:: |
|
StreamedResponse:: |
public static | function |
Factory method for chainability Overrides Response:: |
|
StreamedResponse:: |
public | function | Sets the PHP callback associated with this Response. | |
StreamedResponse:: |
public | function |
Prepares the Response before it is sent to the client. Overrides Response:: |
|
StreamedResponse:: |
public | function |
This method only sends the content once. Overrides Response:: |
|
StreamedResponse:: |
public | function |
Overrides Response:: |
|
StreamedResponse:: |
public | function |
Overrides Response:: |
|
Response:: |
public | function | Returns the Response as an HTTP string. | |
Response:: |
public | function | Clones the current Response instance. | |
Response:: |
public | function | Sends HTTP headers. | |
Response:: |
public | function | Sends HTTP headers and content. | |
Response:: |
public | function | Sets the HTTP protocol version (1.0 or 1.1). | |
Response:: |
public | function | Gets the HTTP protocol version. | |
Response:: |
public | function | Sets the response status code. | |
Response:: |
public | function | Retrieves the status code for the current web response. | |
Response:: |
public | function | Sets the response charset. | |
Response:: |
public | function | Retrieves the response charset. | |
Response:: |
public | function | Returns true if the response is worth caching under any circumstance. | |
Response:: |
public | function | Returns true if the response is "fresh". | |
Response:: |
public | function | Returns true if the response includes headers that can be used to validate the response with the origin server using a conditional GET request. | |
Response:: |
public | function | Marks the response as "private". | |
Response:: |
public | function | Marks the response as "public". | |
Response:: |
public | function | Returns true if the response must be revalidated by caches. | |
Response:: |
public | function | Returns the Date header as a DateTime instance. | |
Response:: |
public | function | Sets the Date header. | |
Response:: |
public | function | Returns the age of the response. | |
Response:: |
public | function | Marks the response stale by setting the Age header to be equal to the maximum age of the response. | |
Response:: |
public | function | Returns the value of the Expires header as a DateTime instance. | |
Response:: |
public | function | Sets the Expires HTTP header with a DateTime instance. | |
Response:: |
public | function | Sets the number of seconds after the time specified in the response's Date header when the the response should no longer be considered fresh. | |
Response:: |
public | function | Sets the number of seconds after which the response should no longer be considered fresh. | |
Response:: |
public | function | Sets the number of seconds after which the response should no longer be considered fresh by shared caches. | |
Response:: |
public | function | Returns the response's time-to-live in seconds. | |
Response:: |
public | function | Sets the response's time-to-live for shared caches. | |
Response:: |
public | function | Sets the response's time-to-live for private/client caches. | |
Response:: |
public | function | Returns the Last-Modified HTTP header as a DateTime instance. | |
Response:: |
public | function | Sets the Last-Modified HTTP header with a DateTime instance. | |
Response:: |
public | function | Returns the literal value of the ETag HTTP header. | |
Response:: |
public | function | Sets the ETag value. | |
Response:: |
public | function | Sets the response's cache headers (validation and/or expiration). | |
Response:: |
public | function | Modifies the response so that it conforms to the rules defined for a 304 status code. | |
Response:: |
public | function | Returns true if the response includes a Vary header. | |
Response:: |
public | function | Returns an array of header names given in the Vary header. | |
Response:: |
public | function | Sets the Vary header. | |
Response:: |
public | function | Determines if the Response validators (ETag, Last-Modified) match a conditional value specified in the Request. | |
Response:: |
public | function | Is response invalid? | |
Response:: |
public | function | Is response informative? | |
Response:: |
public | function | Is response successful? | |
Response:: |
public | function | Is the response a redirect? | |
Response:: |
public | function | Is there a client error? | |
Response:: |
public | function | Was there a server side error? | |
Response:: |
public | function | Is the response OK? | |
Response:: |
public | function | Is the reponse forbidden? | |
Response:: |
public | function | Is the response a not found error? | |
Response:: |
public | function | Is the response a redirect of some form? | |
Response:: |
public | function | Is the response empty? | |
StreamedResponse:: |
protected | property | ||
StreamedResponse:: |
protected | property | ||
Response:: |
public | property | ||
Response:: |
protected | property | ||
Response:: |
protected | property | ||
Response:: |
protected | property | ||
Response:: |
protected | property | ||
Response:: |
protected | property | ||
Response:: |
public static | property | Status codes translation table. |