$method
$method : string
Server-side HTTP request
Extends the Request definition to add methods for accessing incoming data, specifically server parameters, cookies, matched path parameters, query string arguments, body parameters, and upload file information.
"Attributes" are discovered via decomposing the request (and usually specifically the URI path), and typically will be injected by the application.
Requests are considered immutable; all methods that might change state are implemented such that they retain the internal state of the current message and return a new instance that contains the changed state.
$uri : \Psr\Http\Message\UriInterface
$stream : \Psr\Http\Message\StreamInterface
__construct(string $method, string|\Psr\Http\Message\UriInterface $uri, array $headers = array(), string|null|resource|\Psr\Http\Message\StreamInterface $body = null, string $version = '1.1', array $serverParams = array())
| string | $method | HTTP method |
| string|\Psr\Http\Message\UriInterface | $uri | URI |
| array | $headers | Request headers |
| string|null|resource|\Psr\Http\Message\StreamInterface | $body | Request body |
| string | $version | Protocol version |
| array | $serverParams | Typically the $_SERVER superglobal |
getRequestTarget() : string
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 "/".
withRequestTarget(mixed $requestTarget) : static
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.
| mixed | $requestTarget |
withMethod(string $method) : static
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.
| string | $method | Case-sensitive method. |
getUri() : \Psr\Http\Message\UriInterface
Retrieves the URI instance.
This method MUST return a UriInterface instance.
Returns a UriInterface instance representing the URI of the request.
withUri(\Psr\Http\Message\UriInterface $uri, boolean $preserveHost = false) : static
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:
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.
| \Psr\Http\Message\UriInterface | $uri | New request URI to use. |
| boolean | $preserveHost | Preserve the original state of the Host header. |
withBody(\Psr\Http\Message\StreamInterface $body)
| \Psr\Http\Message\StreamInterface | $body |
fromGlobals() : \Psr\Http\Message\ServerRequestInterface
Return a ServerRequest populated with superglobals: $_GET $_POST $_COOKIE $_FILES $_SERVER
getUriFromGlobals() : \Psr\Http\Message\UriInterface
Get a Uri populated with values from $_SERVER.
getUploadedFiles() : array
Retrieve normalized file upload data.
This method returns upload metadata in a normalized tree, with each leaf an instance of Psr\Http\Message\UploadedFileInterface.
These values MAY be prepared from $_FILES or the message body during instantiation, or MAY be injected via withUploadedFiles().
An array tree of UploadedFileInterface instances; an empty array MUST be returned if no data is present.
withUploadedFiles(array $uploadedFiles) : static
Create a new instance with the specified uploaded files.
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 updated body parameters.
| array | $uploadedFiles | An array tree of UploadedFileInterface instances. |
withCookieParams(array $cookies) : static
Return an instance with the specified cookies.
The data IS NOT REQUIRED to come from the $_COOKIE superglobal, but MUST be compatible with the structure of $_COOKIE. Typically, this data will be injected at instantiation.
This method MUST NOT update the related Cookie header of the request instance, nor related values in the server params.
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 updated cookie values.
| array | $cookies | Array of key/value pairs representing cookies. |
getQueryParams() : array
Retrieve query string arguments.
Retrieves the deserialized query string arguments, if any.
Note: the query params might not be in sync with the URI or server
params. If you need to ensure you are only getting the original
values, you may need to parse the query string from getUri()->getQuery()
or from the QUERY_STRING server param.
withQueryParams(array $query) : static
Return an instance with the specified query string arguments.
These values SHOULD remain immutable over the course of the incoming request. They MAY be injected during instantiation, such as from PHP's $_GET superglobal, or MAY be derived from some other value such as the URI. In cases where the arguments are parsed from the URI, the data MUST be compatible with what PHP's parse_str() would return for purposes of how duplicate query parameters are handled, and how nested sets are handled.
Setting query string arguments MUST NOT change the URI stored by the request, nor the values in the server params.
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 updated query string arguments.
| array | $query | Array of query string arguments, typically from $_GET. |
getParsedBody() : null|array|object
Retrieve any parameters provided in the request body.
If the request Content-Type is either application/x-www-form-urlencoded or multipart/form-data, and the request method is POST, this method MUST return the contents of $_POST.
Otherwise, this method may return any results of deserializing the request body content; as parsing returns structured content, the potential types MUST be arrays or objects only. A null value indicates the absence of body content.
The deserialized body parameters, if any. These will typically be an array or object.
withParsedBody(null|array|object $data) : static
Return an instance with the specified body parameters.
These MAY be injected during instantiation.
If the request Content-Type is either application/x-www-form-urlencoded or multipart/form-data, and the request method is POST, use this method ONLY to inject the contents of $_POST.
The data IS NOT REQUIRED to come from $_POST, but MUST be the results of deserializing the request body content. Deserialization/parsing returns structured data, and, as such, this method ONLY accepts arrays or objects, or a null value if nothing was available to parse.
As an example, if content negotiation determines that the request data is a JSON payload, this method could be used to create a request instance with the deserialized parameters.
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 updated body parameters.
| null|array|object | $data | The deserialized body data. This will typically be in an array or object. |
getAttributes() : array
Retrieve attributes derived from the request.
The request "attributes" may be used to allow injection of any parameters derived from the request: e.g., the results of path match operations; the results of decrypting cookies; the results of deserializing non-form-encoded message bodies; etc. Attributes will be application and request specific, and CAN be mutable.
Attributes derived from the request.
getAttribute( $attribute, mixed $default = null) : mixed
Retrieve a single derived request attribute.
Retrieves a single derived request attribute as described in getAttributes(). If the attribute has not been previously set, returns the default value as provided.
This method obviates the need for a hasAttribute() method, as it allows specifying a default value to return if the attribute is not found.
| $attribute | ||
| mixed | $default | Default value to return if the attribute does not exist. |
withAttribute( $attribute, mixed $value) : static
Return an instance with the specified derived request attribute.
This method allows setting a single derived request attribute as described in getAttributes().
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 updated attribute.
| $attribute | ||
| mixed | $value | The value of the attribute. |
withoutAttribute( $attribute) : static
Return an instance that removes the specified derived request attribute.
This method allows removing a single derived request attribute as described in getAttributes().
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 attribute.
| $attribute |
trimHeaderValues(array<mixed,string> $values) : array<mixed,string>
Trims whitespace from the header values.
Spaces and tabs ought to be excluded by parsers when extracting the field value from a header field.
header-field = field-name ":" OWS field-value OWS OWS = *( SP / HTAB )
| array<mixed,string> | $values | Header values |
Trimmed header values
createUploadedFileFromSpec(array $value) : array|\Psr\Http\Message\UploadedFileInterface
Create and return an UploadedFile instance from a $_FILES specification.
If the specification represents an array of values, this method will delegate to normalizeNestedFileSpec() and return that return value.
| array | $value | $_FILES struct |
normalizeNestedFileSpec(array $files = array()) : array<mixed,\Psr\Http\Message\UploadedFileInterface>
Normalize an array of file specifications.
Loops through all nested files and returns a normalized array of UploadedFileInterface instances.
| array | $files |