phasync
CurlResponse / withStatus

Method

CurlResponse::withStatus

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

Description#

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

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 int
The 3-digit integer result code to set.
$reasonPhrase string = ''
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#

ResponseInterface

Errors / Exceptions#

ExceptionWhen
InvalidArgumentExceptionFor invalid status code arguments.