MessageInterface.php
3 years ago
RequestInterface.php
3 years ago
ResponseInterface.php
3 years ago
ServerRequestInterface.php
3 years ago
StreamInterface.php
3 years ago
UploadedFileInterface.php
3 years ago
UriInterface.php
3 years ago
RequestInterface.php
126 lines
| 1 | <?php |
| 2 | |
| 3 | declare (strict_types=1); |
| 4 | namespace IAWP_SCOPED\Psr\Http\Message; |
| 5 | |
| 6 | /** |
| 7 | * Representation of an outgoing, client-side request. |
| 8 | * |
| 9 | * Per the HTTP specification, this interface includes properties for |
| 10 | * each of the following: |
| 11 | * |
| 12 | * - Protocol version |
| 13 | * - HTTP method |
| 14 | * - URI |
| 15 | * - Headers |
| 16 | * - Message body |
| 17 | * |
| 18 | * During construction, implementations MUST attempt to set the Host header from |
| 19 | * a provided URI if no Host header is provided. |
| 20 | * |
| 21 | * Requests are considered immutable; all methods that might change state MUST |
| 22 | * be implemented such that they retain the internal state of the current |
| 23 | * message and return an instance that contains the changed state. |
| 24 | */ |
| 25 | interface RequestInterface extends MessageInterface |
| 26 | { |
| 27 | /** |
| 28 | * Retrieves the message's request target. |
| 29 | * |
| 30 | * Retrieves the message's request-target either as it will appear (for |
| 31 | * clients), as it appeared at request (for servers), or as it was |
| 32 | * specified for the instance (see withRequestTarget()). |
| 33 | * |
| 34 | * In most cases, this will be the origin-form of the composed URI, |
| 35 | * unless a value was provided to the concrete implementation (see |
| 36 | * withRequestTarget() below). |
| 37 | * |
| 38 | * If no URI is available, and no request-target has been specifically |
| 39 | * provided, this method MUST return the string "/". |
| 40 | * |
| 41 | * @return string |
| 42 | */ |
| 43 | public function getRequestTarget(); |
| 44 | /** |
| 45 | * Return an instance with the specific request-target. |
| 46 | * |
| 47 | * If the request needs a non-origin-form request-target — e.g., for |
| 48 | * specifying an absolute-form, authority-form, or asterisk-form — |
| 49 | * this method may be used to create an instance with the specified |
| 50 | * request-target, verbatim. |
| 51 | * |
| 52 | * This method MUST be implemented in such a way as to retain the |
| 53 | * immutability of the message, and MUST return an instance that has the |
| 54 | * changed request target. |
| 55 | * |
| 56 | * @link http://tools.ietf.org/html/rfc7230#section-5.3 (for the various |
| 57 | * request-target forms allowed in request messages) |
| 58 | * @param string $requestTarget |
| 59 | * @return static |
| 60 | */ |
| 61 | public function withRequestTarget(string $requestTarget); |
| 62 | /** |
| 63 | * Retrieves the HTTP method of the request. |
| 64 | * |
| 65 | * @return string Returns the request method. |
| 66 | */ |
| 67 | public function getMethod(); |
| 68 | /** |
| 69 | * Return an instance with the provided HTTP method. |
| 70 | * |
| 71 | * While HTTP method names are typically all uppercase characters, HTTP |
| 72 | * method names are case-sensitive and thus implementations SHOULD NOT |
| 73 | * modify the given string. |
| 74 | * |
| 75 | * This method MUST be implemented in such a way as to retain the |
| 76 | * immutability of the message, and MUST return an instance that has the |
| 77 | * changed request method. |
| 78 | * |
| 79 | * @param string $method Case-sensitive method. |
| 80 | * @return static |
| 81 | * @throws \InvalidArgumentException for invalid HTTP methods. |
| 82 | */ |
| 83 | public function withMethod(string $method); |
| 84 | /** |
| 85 | * Retrieves the URI instance. |
| 86 | * |
| 87 | * This method MUST return a UriInterface instance. |
| 88 | * |
| 89 | * @link http://tools.ietf.org/html/rfc3986#section-4.3 |
| 90 | * @return UriInterface Returns a UriInterface instance |
| 91 | * representing the URI of the request. |
| 92 | */ |
| 93 | public function getUri(); |
| 94 | /** |
| 95 | * Returns an instance with the provided URI. |
| 96 | * |
| 97 | * This method MUST update the Host header of the returned request by |
| 98 | * default if the URI contains a host component. If the URI does not |
| 99 | * contain a host component, any pre-existing Host header MUST be carried |
| 100 | * over to the returned request. |
| 101 | * |
| 102 | * You can opt-in to preserving the original state of the Host header by |
| 103 | * setting `$preserveHost` to `true`. When `$preserveHost` is set to |
| 104 | * `true`, this method interacts with the Host header in the following ways: |
| 105 | * |
| 106 | * - If the Host header is missing or empty, and the new URI contains |
| 107 | * a host component, this method MUST update the Host header in the returned |
| 108 | * request. |
| 109 | * - If the Host header is missing or empty, and the new URI does not contain a |
| 110 | * host component, this method MUST NOT update the Host header in the returned |
| 111 | * request. |
| 112 | * - If a Host header is present and non-empty, this method MUST NOT update |
| 113 | * the Host header in the returned request. |
| 114 | * |
| 115 | * This method MUST be implemented in such a way as to retain the |
| 116 | * immutability of the message, and MUST return an instance that has the |
| 117 | * new UriInterface instance. |
| 118 | * |
| 119 | * @link http://tools.ietf.org/html/rfc3986#section-4.3 |
| 120 | * @param UriInterface $uri New request URI to use. |
| 121 | * @param bool $preserveHost Preserve the original state of the Host header. |
| 122 | * @return static |
| 123 | */ |
| 124 | public function withUri(UriInterface $uri, bool $preserveHost = \false); |
| 125 | } |
| 126 |