Request
class Request extends AbstractRequest implements RequestInterface (View source)
The Request class.
Methods
Return an instance with the specified HTTP protocol version.
Retrieves all message header values.
Checks if a header exists by the given case-insensitive name.
Retrieves a message header value by the given case-insensitive name.
Retrieves a comma-separated string of the values for a single header.
Return an instance with the provided value replacing the specified header.
Return an instance with the specified header appended with the given value.
Return an instance without the specified header.
Return an instance with the specified message body.
Class init.
Return an instance with the specific request-target.
Return an instance with the provided HTTP method.
Returns an instance with the provided URI.
Details
in AbstractMessage at line line 57
string
getProtocolVersion()
Retrieves the HTTP protocol version as a string.
The string MUST contain only the HTTP version number (e.g., "1.1", "1.0").
in AbstractMessage at line line 76
AbstractMessage
withProtocolVersion(string $version)
Return an instance with the specified HTTP protocol version.
The version string MUST contain only the HTTP version number (e.g., "1.1", "1.0").
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 protocol version.
at line line 45
array
getHeaders()
Retrieves all message header values.
The keys represent the header name as it will be sent over the wire, and each value is an array of strings associated with the header.
// Represent the headers as a string
foreach ($message->getHeaders() as $name => $values) {
echo $name . ": " . implode(", ", $values);
}
// Emit headers iteratively:
foreach ($message->getHeaders() as $name => $values) {
foreach ($values as $value) {
header(sprintf('%s: %s', $name, $value), false);
}
}
While header names are not case-sensitive, getHeaders() will preserve the exact case in which headers were originally specified.
at line line 98
bool
hasHeader(string $name)
Checks if a header exists by the given case-insensitive name.
at line line 72
string[]
getHeader(string $name)
Retrieves a message header value by the given case-insensitive name.
This method returns an array of all the header values of the given case-insensitive header name.
If the header does not appear in the message, this method MUST return an empty array.
in AbstractMessage at line line 193
string
getHeaderLine(string $name)
Retrieves a comma-separated string of the values for a single header.
This method returns all of the header values of the given case-insensitive header name as a string concatenated together using a comma.
NOTE: Not all header values may be appropriately represented using comma concatenation. For such headers, use getHeader() instead and supply your own delimiter when concatenating.
If the header does not appear in the message, this method MUST return an empty string.
in AbstractMessage at line line 221
AbstractMessage
withHeader(string $name, string|string[] $value)
Return an instance with the provided value replacing the specified header.
While header names are case-insensitive, the casing of the header will be preserved by this function, and returned from getHeaders().
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 and/or updated header and value.
in AbstractMessage at line line 247
AbstractMessage
withAddedHeader(string $name, mixed $value)
Return an instance with the specified header appended with the given value.
Existing values for the specified header will be maintained. The new value(s) will be appended to the existing list. If the header did not exist previously, it will be added.
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 header and/or value.
in AbstractMessage at line line 288
AbstractMessage
withoutHeader(string $name)
Return an instance without the specified header.
Header resolution MUST be done without case-sensitivity.
This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that removes the named header.
in AbstractMessage at line line 310
StreamInterface
getBody()
Gets the body of the message.
in AbstractMessage at line line 329
AbstractMessage
withBody(StreamInterface $body)
Return an instance with the specified message body.
The body MUST be a StreamInterface object.
This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return a new instance that has the new body stream.
in AbstractRequest at line line 73
__construct(string|UriInterface $uri = null, string $method = null, string|StreamInterface $body = 'php://memory', array $headers = array())
Class init.
in AbstractRequest at line line 125
string
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 "/".
in AbstractRequest at line line 172
AbstractRequest
withRequestTarget(mixed $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.
in AbstractRequest at line line 190
string
getMethod()
Retrieves the HTTP method of the request.
in AbstractRequest at line line 211
AbstractRequest
withMethod(string $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.
in AbstractRequest at line line 231
UriInterface
getUri()
Retrieves the URI instance.
This method MUST return a UriInterface instance.
in AbstractRequest at line line 268
AbstractRequest
withUri(UriInterface $uri, bool $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 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.