Properties

$headers

$headers : array

Type

array — Map of all registered headers, as original name => array of values

$headerNames

$headerNames : array

Type

array — Map of lowercase header name => original name at registration

$protocol

$protocol : string

Type

string

$phrases

$phrases : array

Type

array — Map of standard HTTP status code/reason phrases

$reasonPhrase

$reasonPhrase : string

Type

string

$statusCode

$statusCode : integer

Type

integer

Methods

getProtocolVersion()

getProtocolVersion() 

withProtocolVersion()

withProtocolVersion(  $version) 

Parameters

$version

getHeaders()

getHeaders() 

hasHeader()

hasHeader(  $header) 

Parameters

$header

getHeader()

getHeader(  $header) 

Parameters

$header

getHeaderLine()

getHeaderLine(  $header) 

Parameters

$header

withHeader()

withHeader(  $header,   $value) 

Parameters

$header
$value

withAddedHeader()

withAddedHeader(  $header,   $value) 

Parameters

$header
$value

withoutHeader()

withoutHeader(  $header) 

Parameters

$header

getBody()

getBody() 

__construct()

__construct(integer  $status = 200, array  $headers = array(), string|null|resource|\Psr\Http\Message\StreamInterface  $body = null, string  $version = '1.1', string|null  $reason = null) 

Parameters

integer $status

Status code

array $headers

Response headers

string|null|resource|\Psr\Http\Message\StreamInterface $body

Response body

string $version

Protocol version

string|null $reason

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

getStatusCode()

getStatusCode() : integer

Gets the response status code.

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

Returns

integer —

Status code.

getReasonPhrase()

getReasonPhrase() : string

Gets the response reason phrase associated with the status code.

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.

Returns

string —

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

withStatus()

withStatus(integer  $code, string  $reasonPhrase = '') : static

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

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

integer $code

The 3-digit integer result code to set.

string $reasonPhrase

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.

Returns

static

setHeaders()

setHeaders(array  $headers) 

Parameters

array $headers

normalizeHeaderValue()

normalizeHeaderValue(  $value) 

Parameters

$value

trimHeaderValues()

trimHeaderValues(array<mixed,string>  $values) : array<mixed,string>

Trims whitespace from the header values.

Spaces and tabs ought to be excluded by parsers when extracting the field value from a header field.

header-field = field-name ":" OWS field-value OWS OWS = *( SP / HTAB )

Parameters

array<mixed,string> $values

Header values

Returns

array<mixed,string> —

Trimmed header values

assertHeader()

assertHeader(  $header) 

Parameters

$header

assertStatusCodeIsInteger()

assertStatusCodeIsInteger(  $statusCode) 

Parameters

$statusCode

assertStatusCodeRange()

assertStatusCodeRange(  $statusCode) 

Parameters

$statusCode