Interface RequestInterface
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.
-
Psr\Http\Message\RequestInterface
implements
Psr\Http\Message\MessageInterface
Methods summary
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
|
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
mixed
$requestTarget Returns
static
Link
|
public
string
|
#
getMethod( )
Retrieves the HTTP method of the request.
Retrieves the HTTP method of the request.
Returns
string
Returns the request method.
|
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
string
$method Case-sensitive method. Returns
static
Throws
|
public
Psr\Http\Message\UriInterface
|
#
getUri( )
Retrieves the URI instance.
Retrieves the URI instance.
This method MUST return a UriInterface instance.
Returns
Link
|
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
Psr\Http\Message\UriInterface
$uri New request URI to use.- $preserveHost
boolean
$preserveHost Preserve the original state of the Host header. Returns
static
Link
|
Methods inherited from Psr\Http\Message\MessageInterface
getBody(),
getHeader(),
getHeaderLine(),
getHeaders(),
getProtocolVersion(),
hasHeader(),
withAddedHeader(),
withBody(),
withHeader(),
withProtocolVersion(),
withoutHeader()
|