MessageInterface.php
2 years ago
RequestInterface.php
2 years ago
ResponseInterface.php
2 years ago
ServerRequestInterface.php
2 years ago
StreamInterface.php
2 years ago
UploadedFileInterface.php
2 years ago
UriInterface.php
2 years ago
ResponseInterface.php
69 lines
| 1 | <?php |
| 2 | |
| 3 | declare (strict_types=1); |
| 4 | namespace IAWPSCOPED\Psr\Http\Message; |
| 5 | |
| 6 | /** |
| 7 | * Representation of an outgoing, server-side response. |
| 8 | * |
| 9 | * Per the HTTP specification, this interface includes properties for |
| 10 | * each of the following: |
| 11 | * |
| 12 | * - Protocol version |
| 13 | * - Status code and reason phrase |
| 14 | * - Headers |
| 15 | * - Message body |
| 16 | * |
| 17 | * Responses are considered immutable; all methods that might change state MUST |
| 18 | * be implemented such that they retain the internal state of the current |
| 19 | * message and return an instance that contains the changed state. |
| 20 | * @internal |
| 21 | */ |
| 22 | interface ResponseInterface extends MessageInterface |
| 23 | { |
| 24 | /** |
| 25 | * Gets the response status code. |
| 26 | * |
| 27 | * The status code is a 3-digit integer result code of the server's attempt |
| 28 | * to understand and satisfy the request. |
| 29 | * |
| 30 | * @return int Status code. |
| 31 | */ |
| 32 | public function getStatusCode(); |
| 33 | /** |
| 34 | * Return an instance with the specified status code and, optionally, reason phrase. |
| 35 | * |
| 36 | * If no reason phrase is specified, implementations MAY choose to default |
| 37 | * to the RFC 7231 or IANA recommended reason phrase for the response's |
| 38 | * status code. |
| 39 | * |
| 40 | * This method MUST be implemented in such a way as to retain the |
| 41 | * immutability of the message, and MUST return an instance that has the |
| 42 | * updated status and reason phrase. |
| 43 | * |
| 44 | * @link http://tools.ietf.org/html/rfc7231#section-6 |
| 45 | * @link http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml |
| 46 | * @param int $code The 3-digit integer result code to set. |
| 47 | * @param string $reasonPhrase The reason phrase to use with the |
| 48 | * provided status code; if none is provided, implementations MAY |
| 49 | * use the defaults as suggested in the HTTP specification. |
| 50 | * @return static |
| 51 | * @throws \InvalidArgumentException For invalid status code arguments. |
| 52 | */ |
| 53 | public function withStatus(int $code, string $reasonPhrase = ''); |
| 54 | /** |
| 55 | * Gets the response reason phrase associated with the status code. |
| 56 | * |
| 57 | * Because a reason phrase is not a required element in a response |
| 58 | * status line, the reason phrase value MAY be null. Implementations MAY |
| 59 | * choose to return the default RFC 7231 recommended reason phrase (or those |
| 60 | * listed in the IANA HTTP Status Code Registry) for the response's |
| 61 | * status code. |
| 62 | * |
| 63 | * @link http://tools.ietf.org/html/rfc7231#section-6 |
| 64 | * @link http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml |
| 65 | * @return string Reason phrase; must return an empty string if none present. |
| 66 | */ |
| 67 | public function getReasonPhrase(); |
| 68 | } |
| 69 |