SDK for PHP 3.x

Response
in package
implements ResponseInterface Uses MessageTrait

PSR-7 response implementation.

Table of Contents

Interfaces

ResponseInterface
Representation of an outgoing, server-side response.

Methods

__construct()  : mixed
getBody()  : StreamInterface
getHeader()  : array<string|int, mixed>
getHeaderLine()  : string
getHeaders()  : array<string|int, mixed>
getProtocolVersion()  : string
getReasonPhrase()  : string
Gets the response reason phrase associated with the status code.
getStatusCode()  : int
Gets the response status code.
hasHeader()  : bool
withAddedHeader()  : MessageInterface
withBody()  : MessageInterface
withHeader()  : MessageInterface
withoutHeader()  : MessageInterface
withProtocolVersion()  : MessageInterface
withStatus()  : static
Return an instance with the specified status code and, optionally, reason phrase.

Methods

__construct()

public __construct([int $status = 200 ][, array<string|int, string|array<string|int, string>> $headers = [] ][, string|resource|StreamInterface|null $body = null ][, string $version = '1.1' ][, string|null $reason = null ]) : mixed
Parameters
$status : int = 200

Status code

$headers : array<string|int, string|array<string|int, string>> = []

Response headers

$body : string|resource|StreamInterface|null = null

Response body

$version : string = '1.1'

Protocol version

$reason : string|null = null

Reason phrase (when empty a default will be used based on the status code)

getHeader()

public getHeader(mixed $header) : array<string|int, mixed>
Parameters
$header : mixed
Return values
array<string|int, mixed>

getHeaderLine()

public getHeaderLine(mixed $header) : string
Parameters
$header : mixed
Return values
string

getHeaders()

public getHeaders() : array<string|int, mixed>
Return values
array<string|int, mixed>

getProtocolVersion()

public getProtocolVersion() : string
Return values
string

getReasonPhrase()

Gets the response reason phrase associated with the status code.

public getReasonPhrase() : string

Because a reason phrase is not a required element in a response status line, the reason phrase value MAY be null. Implementations MAY choose to return the default RFC 7231 recommended reason phrase (or those listed in the IANA HTTP Status Code Registry) for the response's status code.

Return values
string —

Reason phrase; must return an empty string if none present.

getStatusCode()

Gets the response status code.

public getStatusCode() : int

The status code is a 3-digit integer result code of the server's attempt to understand and satisfy the request.

Return values
int —

Status code.

hasHeader()

public hasHeader(mixed $header) : bool
Parameters
$header : mixed
Return values
bool

withAddedHeader()

public withAddedHeader(mixed $header, mixed $value) : MessageInterface
Parameters
$header : mixed
$value : mixed
Return values
MessageInterface

withStatus()

Return an instance with the specified status code and, optionally, reason phrase.

public withStatus(mixed $code[, mixed $reasonPhrase = '' ]) : static

If no reason phrase is specified, implementations MAY choose to default to the RFC 7231 or IANA recommended reason phrase for the response's status code.

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that has the updated status and reason phrase.

Parameters
$code : mixed

The 3-digit integer result code to set.

$reasonPhrase : mixed = ''

The reason phrase to use with the provided status code; if none is provided, implementations MAY use the defaults as suggested in the HTTP specification.

Return values
static
On this page