StreamResponse

MMO\core\server · 1 symbol · generated 30 Sep 2026

class

StreamResponse

Psr Response that reads a stream Used to retrieve files The application sends it as it reads it, a chunk at a time (render's output option): a download is not limited by php's memory.

class MMO\core\server\StreamResponse extends MMO\core\classes\aResponse

Namespace: MMO\core\server
Extends: aResponse

return StreamResponse::File($filename, [], 'Été 2025.pdf');

Index

	CHUNK_SIZE	the size of what is read, then sent, at a time (`render`'s `output` option)
	stream
	ContentDisposition($name, $inline) static	A `Content-Disposition` header for a file named $name: an ascii name for old clients, and the real one as RFC 6266 has it (`filename*`), so that a quote, an accent or a line break in a name cannot …
	File($filename, $headers, $clientFilename) static	Create a Stream response using a local file
	getBody()	Gets the body of the message.
	getContentType($single)	Prefers an explicitly-set 'Content-Type' header (`tWithHeaders::getContentType`); falls back to the stream's own detected type (`Stream::getContentType`) when no header was set and the stream…
	getParsedBody()	Get response body decoded.
	JSON($filename, $clientFilename) static	Create a Stream response for a local JSON file (attachment, `must-revalidate` caching).
	lock()	Close the underlying stream, releasing its resource.
	logEvent($event)
	output()	Send the stream as it is read, a chunk at a time: from its start when it can seek, as `render` reads it.
	render($opts)
	withBody($body)	Return an instance with the specified message body.
	withParsedBody($data)
	Zip($filename, $headers, $clientFilename) static	Create a Stream response for a local file, forced to the 'zip' content type (`File` for the rest).
	__construct($stream, $code, $reason, $headers)

Constants1

CHUNK_SIZE

the size of what is read, then sent, at a time (render's output option)

const CHUNK_SIZE = 1048576

Properties1

stream

protected Psr\Http\Message\StreamInterface $stream

Type: StreamInterface

Methods14

ContentDisposition($name, $inline)

staticStreamResponse.php:110

A Content-Disposition header for a file named $name: an ascii name for old clients, and the real one as RFC 6266 has it (filename*), so that a quote, an accent or a line break in a name cannot break the header.

static function ContentDisposition(string $name, bool $inline = false): string

$name	string
$inline = false	bool	if true, the browser shows the file rather than saving it
returns	string

StreamResponse::ContentDisposition('Été "2025".pdf'); // attachment; filename="_t_ _2025_.pdf"; filename*=UTF-8''%C3%89t%C3%A9%20%222025%22.pdf

File($filename, $headers, $clientFilename)

staticStreamResponse.php:52

Create a Stream response using a local file

static function File(string $filename, array $headers = [], ?string $clientFilename = null): self

$filename	string	the local filename
$headers = []	array	headers of the response
$clientFilename = null	null \| string	the filename displayed for the user (by default it is the basename of filename)
returns	self

getBody()

StreamResponse.php:202

Gets the body of the message.

function getBody(): Psr\Http\Message\StreamInterface

returns StreamInterface Returns the body as a stream.

getContentType($single)

StreamResponse.php:165

Prefers an explicitly-set 'Content-Type' header (tWithHeaders::getContentType); falls back to the stream's own detected type (Stream::getContentType) when no header was set and the stream is our

function getContentType(bool $single = true): array|string

See: Stream class. NOTE: like Stream::getContentType, this can fall through to return false (when no header is set AND the stream isn't a Stream instance, e.g. a bare third-party StreamInterface) even though the return type is declared string|array -- harmless in practice (PHP's weak typing coerces that false into '', and getParsedBody's only caller passes the result through extension(), which handles '' the same as any unrecognized type). UNLIKE Stream::getContentType, the type is NOT widened here: this overrides tWithHeaders::getContentType (via aMessage), and PHP requires an override's return type to be covariant (a subtype) of the parent's -- adding |false here is not a subtype of the parent's string|array and fails at class-load time (Fatal error: Declaration ... must be compatible with ...), confirmed by testing. So this one keeps the technically-inaccurate string|array declaration; this note documents the actual (occasionally-false) behavior instead.

$single = true	bool	if true, return only the media type; if false, every parameter too.
returns	array \| string

getParsedBody()

StreamResponse.php:176

Get response body decoded.

function getParsedBody(): ArrayAccess|array|null

Decodes per the response's content type: JSON/CSV are parsed to arrays, HTML to [`XmlParser::Nodes`](https://mmoframework.fr/documentation/mmo.core/php/XmlParser.md#xmlparser-nodes), anything else is returned as a single-element array wrapping the raw content.

returns	ArrayAccess \| array \| null
throws

JSON($filename, $clientFilename)

staticStreamResponse.php:88

Create a Stream response for a local JSON file (attachment, must-revalidate caching).

static function JSON(string $filename, ?string $clientFilename = null): self

$filename	string	the local filename
$clientFilename = null	null \| string	the filename displayed for the user (by default it is the basename of filename)
returns	self

lock()

StreamResponse.php:42

Close the underlying stream, releasing its resource.

function lock(): void

returns

void

logEvent($event)

StreamResponse.php:37

function logEvent(object $event): bool

$event	object
returns	bool	always false -- a StreamResponse never triggers event logging.

output()

StreamResponse.php:136

Send the stream as it is read, a chunk at a time: from its start when it can seek, as render reads it.

protected function output(): void

returns

void

render($opts)

StreamResponse.php:127

function render(array $opts = []): string

See: iRenderable::render

$opts = []	array	`output` => true: the stream is sent as it is read, a chunk at a time (`CHUNK_SIZE`), rather than returned -- how `Application::sendResponse` sends it, so that a download is not limited by php's memory. Otherwise forwarded to the stream's own render() when it's our `Stream` class.
returns	string	the stream's full content, or '' when it was sent (`output`).

$response->render(); // the whole content, read into a string

$response->render(['output' => true]); // '': the content was echoed, a megabyte at a time

withBody($body)

StreamResponse.php:219

Return an instance with the specified message body.

function withBody(Psr\Http\Message\StreamInterface $body): self

The body MUST be a StreamInterface object. This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return a new instance that has the new body stream.

$body	`StreamInterface`	Body.
returns	self
throws		When the body is not valid.

withParsedBody($data)

StreamResponse.php:190

function withParsedBody(ArrayAccess|array|null $data): MMO\core\server\Response

$data	ArrayAccess \| array \| null
returns	Response	a new (non-stream) Response wrapping $data, keeping this response's status/headers.

Zip($filename, $headers, $clientFilename)

staticStreamResponse.php:78

Create a Stream response for a local file, forced to the 'zip' content type (File for the rest).

static function Zip(string $filename, array $headers = [], ?string $clientFilename = null): self

$filename	string	the local filename
$headers = []	array	headers of the response
$clientFilename = null	null \| string	the filename displayed for the user (by default it is the basename of filename)
returns	self

__construct($stream, $code, $reason, $headers)

StreamResponse.php:31

function __construct( Psr\Http\Message\StreamInterface $stream, int $code = 200, string $reason = '', array $headers = [] )

$stream	`StreamInterface`	the response body.
$code = 200	int	Response code
$reason = ''	string	Status text
$headers = []	array	headers

Inherited members (62)

	Properties	Declared by	Description
	`headers`	aMessage
	`ikeys`	aMessage
	`Listeners`	aMessage
	`protocol`	aMessage
	`statusCode`	aResponse
	`statusText`	aResponse
	`stopped`	aResponse

Methods	Declared by	Description
`addHeader($name, $value)`	aMessage	Append a value to a header, keeping any value(s) already set (as opposed to `setHeader`, which replaces).
`AddListener($handler, $order)`	aMessage	Register a listener directly (as opposed to `ConnectListeners`'s attribute-based discovery).
`ConnectListeners($obj)`	aMessage	Scan $obj's methods for #[Listen(EventClass::class)] attributes and register each one as a listener on the matching event class.
`debugName()`	aResponse
`DisconnectListeners($obj)`	aMessage	Undo a previous `ConnectListeners`: removes every listener that `connect` had registered for $obj on this event class.
`dispatch()`	aMessage	Invoke every `GetListeners` listener with $this.
`getCharset()`	aMessage
`getContentExtension()`	aMessage
`getExitCode()`	aResponse
`getHeader($name)`	aMessage	Retrieves a message header value by the given case-insensitive name.
`getHeaderLine($name)`	aMessage	Retrieves a comma-separated string of the values for a single header.
`getHeaders()`	aMessage	Retrieves all message header values.
`GetListeners()`	aMessage	Collect every listener for this class, including those registered on its parent classes (so a subclass event is also caught by listeners of its parent event), sorted by ascending $order (ties keep …
`getOrigin()`	aMessage	Get origin of the request by looking at 'Origin', then 'Referer', then 'Sender' in the request's headers.
`getProtocolVersion()`	aMessage	Retrieves the HTTP protocol version as a string.
`getReasonPhrase()`	aResponse	Gets the response reason phrase associated with the status code.
`getRedirect()`	aResponse
`getStatusCode()`	aResponse	Gets the response status code.
`getUserAgent()`	aMessage
`hasHeader($name)`	aMessage	Checks if a header exists by the given case-insensitive name.
`HasListener($handler)`	aMessage
`isHTML()`	aMessage
`isIe()`	aMessage
`isIphone()`	aMessage
`isJSON()`	aMessage
`isMac()`	aMessage
`isMobile()`	aMessage
`isOk()`	aResponse
`isPropagationStopped()`	aResponse
`isWindows()`	aMessage
`RemoveListener($handler)`	aMessage	Remove the last added handler from the listeners.
`Send($args)`	aMessage	Construct a new instance of this class with $args, then `dispatch` it to every listener.
`setCacheControl($cache, $pragma)`	aMessage	Set the Cache-Control header (and, optionally, the legacy Pragma header alongside it).
`setContentType($type, $charset)`	aMessage	Set the Content-Type header, appending a charset parameter (unless $charset is null/empty).
`setExpires($time)`	aMessage	Set the Expires header from a unix timestamp, formatted as an RFC 7231 HTTP-date.
`setHeader($name, $value)`	aMessage	Set header, replacing any previous value(s) for the same (case-insensitively matched) header name.
`SetListenerOrder($handler, $order)`	aMessage	Change the order of an already-registered listener, whether added directly via `AddListener` or indirectly via `ConnectListeners` (which also stores its `[$obj, $methodName]` callables here).
`setRedirect($url, $status)`	aResponse	Set a redirection call send() to actually redirect
`setRequireAuth($realm, $type)`	aResponse	Set redirection to a login/password inputbox call send() to actually redirect
`setStatus($code, $reason)`	aResponse
`stopPropagation()`	aResponse	Prevent any remaining listener in the current dispatch chain from being called.
`unsetHeader($name)`	aMessage	Remove a header entirely.
`withAddedHeader($name, $value)`	aMessage	Return an instance with the specified header appended with the given value.
`withCacheControl($cache, $pragma)`	aMessage	Set cache control of a clone.
`withContentType($type, $charset)`	aMessage	Set content type of a clone.
`withExpires($time)`	aMessage	Set cache expire date of a clone.
`withHeader($name, $value)`	aMessage	Return an instance with the provided value replacing the specified header.
`withHeaders($headers, $reset)`	aMessage	Return a clone with every header in $headers set (through `tWithHeaders::setHeader`, so each value replaces any existing one for the same header name).
`withoutHeader($name)`	aMessage	Return an instance without the specified header.
`withProtocolVersion($version)`	aMessage	Return an instance with the specified HTTP protocol version.
`withRedirect($url, $status)`	aResponse	Set a redirection of a clone call send() to actually redirect
`withRequireAuth($realm, $type)`	aResponse	Set redirection to a login/password inputbox of a clone call send() to actually redirect
`withStatus($code, $reasonPhrase)`	aResponse	Return an instance with the specified status code and, optionally, reason phrase.
`__clone()`	aResponse	A cloned event starts fresh: propagation is never considered stopped on the clone, even if it was on the original instance.
`__toString()`	aResponse