Public Member Functions | |
| __construct ( $method, $uri, array $headers=[], $body=null, $version='1.1') | |
| getMethod () | |
| getRequestTarget () | |
| getUri () | |
| withMethod ($method) | |
| withRequestTarget ($requestTarget) | |
| withUri (UriInterface $uri, $preserveHost=false) | |
 Public Member Functions inherited from Psr\Http\Message\MessageInterface | |
| getBody () | |
| getHeader ($name) | |
| getHeaderLine ($name) | |
| getHeaders () | |
| getProtocolVersion () | |
| hasHeader ($name) | |
| withAddedHeader ($name, $value) | |
| withBody (StreamInterface $body) | |
| withHeader ($name, $value) | |
| withoutHeader ($name) | |
| withProtocolVersion ($version) | |
Detailed Description
PSR-7 request implementation.
Definition at line 12 of file vendor/guzzlehttp/psr7/src/Request.php.
Constructor & Destructor Documentation
◆ __construct()
| GuzzleHttp\Psr7\Request::__construct | ( | $method, | |
| $uri, | |||
| array | $headers = [], |
||
$body = null, |
|||
$version = '1.1' |
|||
| ) |
- Parameters
-
string $method HTTP method string | UriInterface $uri URI array $headers Request headers string | null | resource | StreamInterface $body Request body string $version Protocol version
Definition at line 41 of file vendor/guzzlehttp/psr7/src/Request.php.
References GuzzleHttp\Psr7\stream_for().
Member Function Documentation
◆ getMethod()
| GuzzleHttp\Psr7\Request::getMethod | ( | ) |
Retrieves the HTTP method of the request.
- Returns
- string Returns the request method.
Implements Psr\Http\Message\RequestInterface.
Definition at line 97 of file vendor/guzzlehttp/psr7/src/Request.php.
◆ getRequestTarget()
| GuzzleHttp\Psr7\Request::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
Implements Psr\Http\Message\RequestInterface.
Definition at line 67 of file vendor/guzzlehttp/psr7/src/Request.php.
◆ getUri()
| GuzzleHttp\Psr7\Request::getUri | ( | ) |
Retrieves the URI instance.
This method MUST return a UriInterface instance.
UriInterface Returns a UriInterface instance representing the URI of the request.
Implements Psr\Http\Message\RequestInterface.
Definition at line 110 of file vendor/guzzlehttp/psr7/src/Request.php.
◆ withMethod()
| GuzzleHttp\Psr7\Request::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
-
Implements Psr\Http\Message\RequestInterface.
Definition at line 102 of file vendor/guzzlehttp/psr7/src/Request.php.
◆ withRequestTarget()
| GuzzleHttp\Psr7\Request::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
Implements Psr\Http\Message\RequestInterface.
Definition at line 84 of file vendor/guzzlehttp/psr7/src/Request.php.
◆ withUri()
| GuzzleHttp\Psr7\Request::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.
Implements Psr\Http\Message\RequestInterface.
Definition at line 115 of file vendor/guzzlehttp/psr7/src/Request.php.
The documentation for this class was generated from the following file:
