$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.
$method : string
$requestTarget : string|null
$uri : \Psr\Http\Message\UriInterface
$headers : array
$headerNames : array
$protocol : string
$stream : \Psr\Http\Message\StreamInterface|null
$attributes : array
$cookieParams : array
$parsedBody : array|object|null
$queryParams : array
$serverParams : array
$uploadedFiles : array
__construct(string $method, string|\Psr\Http\Message\UriInterface $uri, array $headers = [], string|resource|\Psr\Http\Message\StreamInterface|null $body = null, string $version = '1.1', array $serverParams = []) : mixed
| string | $method | HTTP method |
| string|\Psr\Http\Message\UriInterface | $uri | URI |
| array | $headers | Request headers |
| string|resource|\Psr\Http\Message\StreamInterface|null | $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(mixed $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.
| mixed | $method | Case-sensitive method. |
withUri(\Psr\Http\Message\UriInterface $uri, mixed $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. |
| mixed | $preserveHost | Preserve the original state of the Host header. |
trimHeaderValues(string[] $values) : 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 )
| 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 = []) : \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 |