Representation of an outgoing, client-side request. More...
Inheritance diagram for Psr\Http\Message\RequestInterface:
Collaboration diagram for Psr\Http\Message\RequestInterface:
Public Member Functions | |
| getRequestTarget () | |
| Retrieves the message's request target. More... | |
| withRequestTarget ($requestTarget) | |
| Return an instance with the specific request-target. More... | |
| getMethod () | |
| Retrieves the HTTP method of the request. More... | |
| withMethod ($method) | |
| Return an instance with the provided HTTP method. More... | |
| getUri () | |
| Retrieves the URI instance. More... | |
| withUri (UriInterface $uri, $preserveHost=false) | |
| Returns an instance with the provided URI. 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, client-side request.
Per the HTTP specification, this interface includes properties for each of the following:
- Protocol version
- HTTP method
- URI
- Headers
- Message body
During construction, implementations MUST attempt to set the Host header from a provided URI if no Host header is provided.
Requests 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 24 of file RequestInterface.php.
Member Function Documentation
◆ getMethod()
| Psr\Http\Message\RequestInterface::getMethod | ( | ) |
Retrieves the HTTP method of the request.
- Returns
- string Returns the request method.
Implemented in Slim\Http\Request, GuzzleHttp\Psr7\Request, and Dflydev\FigCookies\FigCookieTestingRequest.
Referenced by Slim\Handlers\NotFound\__invoke(), Slim\Handlers\NotAllowed\__invoke(), Slim\Router\dispatch(), Slim\App\dispatchRouterAndPrepareRoute(), GuzzleHttp\Psr7\modify_request(), and Slim\App\respond().
Here is the caller graph for this function:
◆ getRequestTarget()
| Psr\Http\Message\RequestInterface::getRequestTarget | ( | ) |
Retrieves the message's request target.
Retrieves the message's request-target either as it will appear (for clients), as it appeared at request (for servers), or as it was specified for the instance (see withRequestTarget()).
In most cases, this will be the origin-form of the composed URI, unless a value was provided to the concrete implementation (see withRequestTarget() below).
If no URI is available, and no request-target has been specifically provided, this method MUST return the string "/".
- Returns
- string
Implemented in Slim\Http\Request, GuzzleHttp\Psr7\Request, and Dflydev\FigCookies\FigCookieTestingRequest.
◆ getUri()
| Psr\Http\Message\RequestInterface::getUri | ( | ) |
Retrieves the URI instance.
This method MUST return a UriInterface instance.
UriInterface Returns a UriInterface instance representing the URI of the request.
Implemented in Slim\Http\Request, GuzzleHttp\Psr7\Request, and Dflydev\FigCookies\FigCookieTestingRequest.
Referenced by Slim\Router\dispatch(), Slim\App\dispatchRouterAndPrepareRoute(), GuzzleHttp\Psr7\modify_request(), Slim\App\process(), Slim\App\processInvalidMethod(), Slim\Handlers\NotFound\renderHtmlNotFoundOutput(), and Slim\App\respond().
Here is the caller graph for this function:
◆ withMethod()
| Psr\Http\Message\RequestInterface::withMethod | ( | $method | ) |
Return an instance with the provided HTTP method.
While HTTP method names are typically all uppercase characters, HTTP method names are case-sensitive and thus implementations SHOULD NOT modify the given string.
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 changed request method.
- Parameters
-
string $method Case-sensitive method.
- Returns
- static
- Exceptions
-
Implemented in Slim\Http\Request, GuzzleHttp\Psr7\Request, and Dflydev\FigCookies\FigCookieTestingRequest.
◆ withRequestTarget()
| Psr\Http\Message\RequestInterface::withRequestTarget | ( | $requestTarget | ) |
Return an instance with the specific request-target.
If the request needs a non-origin-form request-target — e.g., for specifying an absolute-form, authority-form, or asterisk-form — this method may be used to create an instance with the specified request-target, verbatim.
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 changed request target.
(for the various request-target forms allowed in request messages) mixed $requestTarget static
Implemented in Slim\Http\Request, GuzzleHttp\Psr7\Request, and Dflydev\FigCookies\FigCookieTestingRequest.
◆ withUri()
| Psr\Http\Message\RequestInterface::withUri | ( | UriInterface | $uri, |
$preserveHost = false |
|||
| ) |
Returns an instance with the provided URI.
This method MUST update the Host header of the returned request by default if the URI contains a host component. If the URI does not contain a host component, any pre-existing Host header MUST be carried over to the returned request.
You can opt-in to preserving the original state of the Host header by setting $preserveHost to true. When $preserveHost is set to true, this method interacts with the Host header in the following ways:
- If the Host header is missing or empty, and the new URI contains a host component, this method MUST update the Host header in the returned request.
- If the Host header is missing or empty, and the new URI does not contain a host component, this method MUST NOT update the Host header in the returned request.
- If a Host header is present and non-empty, this method MUST NOT update the Host header in the returned request.
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 new UriInterface instance.
Implemented in Slim\Http\Request, GuzzleHttp\Psr7\Request, and Dflydev\FigCookies\FigCookieTestingRequest.
The documentation for this interface was generated from the following file:
- libs/composer/vendor/psr/http-message/src/RequestInterface.php
