Class Request

PSR-7 request implementation.

GuzzleHttp\Psr7\Request implements Psr\Http\Message\RequestInterface uses GuzzleHttp\Psr7\MessageTrait

Direct known subclasses

GuzzleHttp\Psr7\ServerRequest

Namespace: GuzzleHttp\Psr7
Located at src/Request.php

Methods summary
`public`	# `__construct( string $method, string\|Psr\Http\Message\UriInterface $uri, array $headers = [], string\|null\|resource\|Psr\Http\Message\StreamInterface $body = null, string $version = '1.1' )` Parameters `$method` HTTP method `$uri` URI `$headers` Request headers `$body` Request body `$version` Protocol version
`public string`	# `getRequestTarget( )` Retrieves the message's request target. 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 Implementation of `Psr\Http\Message\RequestInterface::getRequestTarget()`
`public static`	# `withRequestTarget( mixed $requestTarget )` Return an instance with the specific request-target. 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. Parameters `$requestTarget` Returns static Link (for the various request-target forms allowed in request messages) Implementation of `Psr\Http\Message\RequestInterface::withRequestTarget()`
`public string`	# `getMethod( )` Retrieves the HTTP method of the request. Retrieves the HTTP method of the request. Returns string Returns the request method. Implementation of `Psr\Http\Message\RequestInterface::getMethod()`
`public static`	# `withMethod( string $method )` Return an instance with the provided HTTP 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 `$method` Case-sensitive method. Returns static Throws InvalidArgumentException for invalid HTTP methods. Implementation of `Psr\Http\Message\RequestInterface::withMethod()`
`public Psr\Http\Message\UriInterface`	# `getUri( )` Retrieves the URI instance. Retrieves the URI instance. This method MUST return a UriInterface instance. Returns `Psr\Http\Message\UriInterface` Returns a UriInterface instance representing the URI of the request. Link http://tools.ietf.org/html/rfc3986#section-4.3 Implementation of `Psr\Http\Message\RequestInterface::getUri()`
`public static`	# `withUri( Psr\Http\Message\UriInterface $uri, boolean $preserveHost = false )` Returns an instance with the provided URI. 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. Parameters `$uri` New request URI to use. `$preserveHost` Preserve the original state of the Host header. Returns static Link http://tools.ietf.org/html/rfc3986#section-4.3 Implementation of `Psr\Http\Message\RequestInterface::withUri()`

Methods inherited from Psr\Http\Message\MessageInterface
`getBody(), getHeader(), getHeaderLine(), getHeaders(), getProtocolVersion(), hasHeader(), withAddedHeader(), withBody(), withHeader(), withProtocolVersion(), withoutHeader()`

Methods used from GuzzleHttp\Psr7\MessageTrait
`getBody(), getHeader(), getHeaderLine(), getHeaders(), getProtocolVersion(), hasHeader(), withAddedHeader(), withBody(), withHeader(), withProtocolVersion(), withoutHeader()`