Representation of an outgoing, server-side response. More...
Inheritance diagram for Psr\Http\Message\ResponseInterface:
Collaboration diagram for Psr\Http\Message\ResponseInterface:
Public Member Functions | |
| getStatusCode () | |
| Gets the response status code. More... | |
| withStatus ($code, $reasonPhrase='') | |
| Return an instance with the specified status code and, optionally, reason phrase. More... | |
| getReasonPhrase () | |
| Gets the response reason phrase associated with the status code. More... | |
| Public Member Functions inherited from Psr\Http\Message\MessageInterface | |
| getProtocolVersion () | |
| Retrieves the HTTP protocol version as a string. More... | |
| withProtocolVersion ($version) | |
| Return an instance with the specified HTTP protocol version. More... | |
| getHeaders () | |
| Retrieves all message header values. More... | |
| hasHeader ($name) | |
| Checks if a header exists by the given case-insensitive name. More... | |
| getHeader ($name) | |
| Retrieves a message header value by the given case-insensitive name. More... | |
| getHeaderLine ($name) | |
| Retrieves a comma-separated string of the values for a single header. More... | |
| withHeader ($name, $value) | |
| Return an instance with the provided value replacing the specified header. More... | |
| withAddedHeader ($name, $value) | |
| Return an instance with the specified header appended with the given value. More... | |
| withoutHeader ($name) | |
| Return an instance without the specified header. More... | |
| getBody () | |
| Gets the body of the message. More... | |
| withBody (StreamInterface $body) | |
| Return an instance with the specified message body. More... | |
Detailed Description
Representation of an outgoing, server-side response.
Per the HTTP specification, this interface includes properties for each of the following:
- Protocol version
- Status code and reason phrase
- Headers
- Message body
Responses are considered immutable; all methods that might change state MUST be implemented such that they retain the internal state of the current message and return an instance that contains the changed state.
Definition at line 20 of file ResponseInterface.php.
Member Function Documentation
◆ getReasonPhrase()
| Psr\Http\Message\ResponseInterface::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.
http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml string Reason phrase; must return an empty string if none present.
Implemented in Slim\Http\Response, GuzzleHttp\Psr7\Response, and Dflydev\FigCookies\FigCookieTestingResponse.
Referenced by Slim\App\respond().
Here is the caller graph for this function:
◆ getStatusCode()
| Psr\Http\Message\ResponseInterface::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
- int Status code.
Implemented in Slim\Http\Response, GuzzleHttp\Psr7\Response, and Dflydev\FigCookies\FigCookieTestingResponse.
Referenced by Slim\App\isEmptyResponse(), Slim\App\respond(), and ILIAS\HTTP\Response\Sender\DefaultResponseSenderStrategy\sendResponse().
Here is the caller graph for this function:
◆ withStatus()
| Psr\Http\Message\ResponseInterface::withStatus | ( | $code, | |
$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.
http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml int $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. static For invalid status code arguments.
Implemented in Slim\Http\Response, GuzzleHttp\Psr7\Response, and Dflydev\FigCookies\FigCookieTestingResponse.
Referenced by Slim\Handlers\NotFound\__invoke(), Slim\Handlers\PhpError\__invoke(), Slim\Handlers\NotAllowed\__invoke(), and Slim\Handlers\Error\__invoke().
Here is the caller graph for this function:
The documentation for this interface was generated from the following file:
- libs/composer/vendor/psr/http-message/src/ResponseInterface.php
