Class Salient\Http\HttpResponse

`extends`	`AbstractHttpMessage`
`implements`	`HttpResponseInterface`
`uses`	`HasMutator`

A PSR-7 response

Salient\Http\AbstractHttpMessage implements HttpMessageInterface uses HasHttpHeaders, HasMutator
- Salient\Http\HttpResponse implements HttpResponseInterface uses HasMutator

Located at Toolkit/Http/HttpResponse.php

Methods


					
	public

__construct(
	int $code = 200,
	StreamInterface|resource|string|null $body = null,
	Arrayable<string, string[]|string>|iterable<string, string[]|string>|null $headers = null,
	?string $reasonPhrase = null,
	string $version = '1.1',
)

Creates a new HttpResponse object

Overrides

Salient\Http\AbstractHttpMessage::__construct()


					
	public
					static

fromPsr7(MessageInterface $message): HttpResponse

Get an instance of the class from a compatible PSR-7 message

Implements

Salient\Contract\Http\HttpMessageInterface::fromPsr7()


					
	public

getStatusCode(): int

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

Status code.

Implements

Psr\Http\Message\ResponseInterface::getStatusCode()


					
	public

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

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

Implements

Psr\Http\Message\ResponseInterface::getReasonPhrase()


					
	public

withStatus(int $code, string $reasonPhrase = ''): ResponseInterface

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

`$code`	The 3-digit integer result code to set.
`$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.

Implements

Psr\Http\Message\ResponseInterface::withStatus()


					
	public

jsonSerialize(
	
): array{status: int, statusText: string, httpVersion: string, cookies: array<array{name: string, value: string, path?: string, domain?: string, expires?: string, httpOnly?: bool, secure?: bool}>, headers: array<array{name: string, value: string}>, content: array{size: int, mimeType: string, text: string}, redirectURL: string, headersSize: int, bodySize: int}

Overrides

Salient\Http\AbstractHttpMessage::jsonSerialize()

Implements

JsonSerializable::jsonSerialize()


					
	protected

getStartLine(): string

Get the start line of the message

Implements

Salient\Http\AbstractHttpMessage::getStartLine()

Methods inherited from Salient\Http\AbstractHttpMessage
`getProtocolVersion(), getBody(), getHttpPayload(), withProtocolVersion(), withBody(), __toString(),`

Methods used from Salient\Http\HasHttpHeaders
`getHttpHeaders(), getHeaders(), hasHeader(), getHeader(), getHeaderValues(), getHeaderLine(), getFirstHeaderLine(), getLastHeaderLine(), getOneHeaderLine(), withHeader(), withAddedHeader(), withoutHeader()`

Constants
`protected`	STATUS_CODE = [ 100 => 'Continue', 101 => 'Switching Protocols', 102 => 'Processing', 103 => 'Early Hints', 200 => 'OK', 201 => 'Created', 202 => 'Accepted', 203 => 'Non-Authoritative Information', 204 => 'No Content', 205 => 'Reset Content', 206 => 'Partial Content', 207 => 'Multi-Status', 208 => 'Already Reported', 226 => 'IM Used', 300 => 'Multiple Choices', 301 => 'Moved Permanently', 302 => 'Found', 303 => 'See Other', 304 => 'Not Modified', 305 => 'Use Proxy', 307 => 'Temporary Redirect', 308 => 'Permanent Redirect', 400 => 'Bad Request', 401 => 'Unauthorized', 402 => 'Payment Required', 403 => 'Forbidden', 404 => 'Not Found', 405 => 'Method Not Allowed', 406 => 'Not Acceptable', 407 => 'Proxy Authentication Required', 408 => 'Request Timeout', 409 => 'Conflict', 410 => 'Gone', 411 => 'Length Required', 412 => 'Precondition Failed', 413 => 'Content Too Large', 414 => 'URI Too Long', 415 => 'Unsupported Media Type', 416 => 'Range Not Satisfiable', 417 => 'Expectation Failed', 421 => 'Misdirected Request', 422 => 'Unprocessable Content', 423 => 'Locked', 424 => 'Failed Dependency', 425 => 'Too Early', 426 => 'Upgrade Required', 428 => 'Precondition Required', 429 => 'Too Many Requests', 431 => 'Request Header Fields Too Large', 451 => 'Unavailable For Legal Reasons', 500 => 'Internal Server Error', 501 => 'Not Implemented', 502 => 'Bad Gateway', 503 => 'Service Unavailable', 504 => 'Gateway Timeout', 505 => 'HTTP Version Not Supported', 506 => 'Variant Also Negotiates', 507 => 'Insufficient Storage', 508 => 'Loop Detected', 510 => 'Not Extended', 511 => 'Network Authentication Required', ]	#

Properties
`protected`	`int`	`$StatusCode`	#
`protected`	`?string`	`$ReasonPhrase`	#

Properties inherited from Salient\Http\AbstractHttpMessage
`$ProtocolVersion, $Headers, $Body`

Namespaces

Classes

Traits

Class Salient\Http\HttpResponse

Overrides

Implements

Returns

Implements

Returns

Implements

Parameters

Implements

Overrides

Implements

Implements