Class Response
- GuzzleHttp\Psr7\Response implements Psr\Http\Message\ResponseInterface uses GuzzleHttp\Psr7\MessageTrait
- Namespace: GuzzleHttp\Psr7
- Located at Response.php
PSR-7 response implementation.
Methods Summary
- __construct ( int $status = 200, array $headers = [], string|null|resource|StreamInterface $body = null, string $version = '1.1', string|null $reason = null )
-
getStatusCode ( )
Gets the response status code.
-
getReasonPhrase ( )
Gets the response reason phrase associated with the status code.
-
withStatus ( int $code, string $reasonPhrase = '' )
Return an instance with the specified status code and, optionally, reason phrase.
Methods inherited from Psr\Http\Message\MessageInterface
getBody(),
getHeader(),
getHeaderLine(),
getHeaders(),
getProtocolVersion(),
hasHeader(),
withAddedHeader(),
withBody(),
withHeader(),
withProtocolVersion(),
withoutHeader()
Methods used from GuzzleHttp\Psr7\MessageTrait
Methods Details
__construct (
integer
$status = 200,
array
$headers = [],
string|null|resource|Psr\Http\Message\StreamInterface
$body = null,
string
$version = '1.1',
string|null
$reason = null
)
Parameters
| integer | $status = 200 | Status code |
| array | $headers = [] | Response headers |
string|null|resource|Psr\Http\Message\StreamInterface |
$body = null | Response body |
| string | $version = '1.1' | Protocol version |
| string|null | $reason = null | Reason phrase (when empty a default will be used based on the status code) |
integer getStatusCode ( )
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. |
Implementation of
string getReasonPhrase ( )
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. |
Link
http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
Implementation of
static withStatus ( integer $code, string $reasonPhrase = '' )
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 |
Exceptions
| InvalidArgumentException For invalid status code arguments. |
Link
http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml