Skip to content

Latest commit

 

History

History
142 lines (84 loc) · 4.49 KB

response.md

File metadata and controls

142 lines (84 loc) · 4.49 KB
Raw
title permalink
Response
/classes/response
  • Table of Contents {:toc}

The Response class represents an HTTP response. The Response promise is returned by request handlers and middleware.

Constructor

public function __construct(
    int $code = Status::OK, 
    string[] | string[][] $headers = [], 
    Amp\ByteStream\InputStream | string | null $stringOrStream = null
)

Parameters

|int|$code|HTTP response status code| |string[]
string[][]|$headers|An array of strings or an array of string arrays.| |Amp\ByteStream\InputStream
string
null|$stringOrStream|Response body|

Destructor

Invokes dispose handlers (i.e. functions that registered via onDispose method).

{:.note}

Uncaught exceptions from the dispose handlers will be forwarded to the event loop error handler.

getBody(): Amp\ByteStream\InputStream

Returns the stream for the message body.

setBody(\Amp\ByteStream\InputStream | string | null $stringOrStream)

Sets the stream for the message body.

{:.note}

Using a string will automatically set the Content-Length header to the length of the given string. Setting an InputStream will remove the Content-Length header. If you know the exact content length of your stream, you can add a content-length header after calling setBody().

getHeaders(): array

Returns the headers as a string-indexed array of arrays of strings or an empty array if no headers have been set.

hasHeader(string $name): bool

Checks if given header exists.

getHeaderArray(string $name): array

Returns the array of values for the given header or an empty array if the header does not exist.

getHeader(string $name): ?string

Returns the value of the given header. If multiple headers are present for the named header, only the first header value will be returned. Use getHeaderArray() to return an array of all values for the particular header. Returns null if the header does not exist.

setHeaders(array $headers)

Sets the headers from the given array.

setHeader(string $name, string | string[] $value)

Sets the header to the given value(s). All previous header lines with the given name will be replaced.

addHeader(string $name, string | string[] $value)

Adds an additional header line with the given name.

removeHeader(string $name)

Removes the given header if it exists. If multiple header lines with the same name exist, all of them are removed.

getStatus(): int

Returns the response status code.

getReason(): string

Returns the reason phrase describing the status code.

setStatus(int $code, string | null $reason)

Sets the numeric HTTP status code (between 100 and 599) and reason phrase. Use null for the reason phrase to use the default phrase associated with the status code.

getCookies(): ResponseCookie[]

Returns all cookies in an associative map.

getCookie(string $name): ResponseCookie | null

Gets a cookie value by name or null if no cookie with that name is present.

setCookie(ResponseCookie $cookie)

Adds a cookie to the response.

removeCookie(string $name)

Removes a cookie from the response.

getPush(): string[][]

Returns list of push resources in an associative map:

[
    string $url => [ Psr\Http\Message\UriInterface $uri, string[][] $headers ],
]

push(string $url, string[][] $headers)

Indicate resources which a client likely needs to fetch. (e.g. Link: preload or HTTP/2 Server Push).

isUpgraded(): bool

Returns true if a detach callback has been set, false if none.

upgrade(callable $upgrade)

Sets a callback to be invoked once the response has been written to the client and changes the status of the response to 101 Switching Protocols.

The callback may be removed by changing the status to something else.

getUpgradeCallable(): callable | null

Returns the upgrade function if present.

onDispose(callable $onDispose)

Registers a function that is invoked when the Response is discarded. A response is discarded either once it has been written to the client or if it gets replaced in a middleware chain.