\Zend\DiactorosServerRequest

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.

Summary

Methods
Properties
Constants
getRequestTarget()
withRequestTarget()
getMethod()
withMethod()
getUri()
withUri()
__construct()
getServerParams()
getUploadedFiles()
withUploadedFiles()
getCookieParams()
withCookieParams()
getQueryParams()
withQueryParams()
getParsedBody()
withParsedBody()
getAttributes()
getAttribute()
withAttribute()
withoutAttribute()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
initialize()
createUri()
validateMethod()
getHostFromUri()
validateUploadedFiles()
$method
$requestTarget
$uri
$attributes
$cookieParams
$parsedBody
$queryParams
$serverParams
$uploadedFiles
N/A

Properties

$method

$method : string

Type

string

$requestTarget

$requestTarget : null|string

The request-target, if it has been provided or calculated.

Type

null|string

$attributes

$attributes : array

Type

array

$cookieParams

$cookieParams : array

Type

array

$parsedBody

$parsedBody : null|array|object

Type

null|array|object

$queryParams

$queryParams : array

Type

array

$serverParams

$serverParams : array

Type

array

$uploadedFiles

$uploadedFiles : array

Type

array

Methods

getRequestTarget()

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 "/".

Returns

string

withRequestTarget()

withRequestTarget(mixed  $requestTarget) : static

Create a new instance with a 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 a new instance that has the changed request target.

Parameters

mixed $requestTarget

Throws

\InvalidArgumentException

if the request target is invalid.

Returns

static

getMethod()

getMethod() : string

Proxy to receive the request method.

This overrides the parent functionality to ensure the method is never empty; if no method is present, it returns 'GET'.

Returns

string

withMethod()

withMethod(string  $method) : self

Set the request method.

Unlike the regular Request implementation, the server-side normalizes the method to uppercase to ensure consistency and make checking the method simpler.

This methods returns a new instance.

Parameters

string $method

Returns

self

getUri()

getUri() : \Psr\Http\Message\UriInterface

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, if any.

withUri()

withUri(\Psr\Http\Message\UriInterface  $uri, boolean  $preserveHost = false) : static

Returns an instance with the provided URI.

This method will 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 will 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, the returned request will not update the Host header of the returned message -- even if the message contains no Host header. This means that a call to getHeader('Host') on the original request MUST equal the return value of a call to getHeader('Host') on 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

\Psr\Http\Message\UriInterface $uri

New request URI to use.

boolean $preserveHost

Preserve the original state of the Host header.

Returns

static

__construct()

__construct(array  $serverParams = array(), array  $uploadedFiles = array(), null|string|\Psr\Http\Message\UriInterface  $uri = null, null|string  $method = null, string|resource|\Psr\Http\Message\StreamInterface  $body = 'php://input', array  $headers = array(), array  $cookies = array(), array  $queryParams = array(), null|array|object  $parsedBody = null, string  $protocol = '1.1') 

Parameters

array $serverParams

Server parameters, typically from $_SERVER

array $uploadedFiles

Upload file information, a tree of UploadedFiles

null|string|\Psr\Http\Message\UriInterface $uri

URI for the request, if any.

null|string $method

HTTP method for the request, if any.

string|resource|\Psr\Http\Message\StreamInterface $body

Message body, if any.

array $headers

Headers for the message, if any.

array $cookies

Cookies for the message, if any.

array $queryParams

Query params for the message, if any.

null|array|object $parsedBody

The deserialized body parameters, if any.

string $protocol

HTTP protocol version.

Throws

\InvalidArgumentException

for any invalid value.

getServerParams()

getServerParams() : array

Retrieve server parameters.

Retrieves data related to the incoming request environment, typically derived from PHP's $_SERVER superglobal. The data IS NOT REQUIRED to originate from $_SERVER.

Returns

array

getUploadedFiles()

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().

Returns

array —

An array tree of UploadedFileInterface instances; an empty array MUST be returned if no data is present.

withUploadedFiles()

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.

Parameters

array $uploadedFiles

An array tree of UploadedFileInterface instances.

Returns

static

getCookieParams()

getCookieParams() : array

Retrieve cookies.

Retrieves cookies sent by the client to the server.

The data MUST be compatible with the structure of the $_COOKIE superglobal.

Returns

array

withCookieParams()

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.

Parameters

array $cookies

Array of key/value pairs representing cookies.

Returns

static

getQueryParams()

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.

Returns

array

withQueryParams()

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.

Parameters

array $query

Array of query string arguments, typically from $_GET.

Returns

static

getParsedBody()

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.

Returns

null|array|object —

The deserialized body parameters, if any. These will typically be an array or object.

withParsedBody()

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.

Parameters

null|array|object $data

The deserialized body data. This will typically be in an array or object.

Returns

static

getAttributes()

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.

Returns

array —

Attributes derived from the request.

getAttribute()

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.

Parameters

$attribute
mixed $default

Default value to return if the attribute does not exist.

Returns

mixed

withAttribute()

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.

Parameters

$attribute
mixed $value

The value of the attribute.

Returns

static

withoutAttribute()

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.

Parameters

$attribute

Returns

static

initialize()

initialize(null|string|\Psr\Http\Message\UriInterface  $uri = null, null|string  $method = null, string|resource|\Psr\Http\Message\StreamInterface  $body = 'php://memory', array  $headers = array()) 

Initialize request state.

Used by constructors.

Parameters

null|string|\Psr\Http\Message\UriInterface $uri

URI for the request, if any.

null|string $method

HTTP method for the request, if any.

string|resource|\Psr\Http\Message\StreamInterface $body

Message body, if any.

array $headers

Headers for the message, if any.

Throws

\InvalidArgumentException

for any invalid value.

createUri()

createUri(null|string|\Psr\Http\Message\UriInterface  $uri) : \Psr\Http\Message\UriInterface

Create and return a URI instance.

If $uri is a already a UriInterface instance, returns it.

If $uri is a string, passes it to the Uri constructor to return an instance.

If $uri is null, creates and returns an emptyUri` instance.

Otherwise, it raises an exception.

Parameters

null|string|\Psr\Http\Message\UriInterface $uri

Throws

\InvalidArgumentException

Returns

\Psr\Http\Message\UriInterface

validateMethod()

validateMethod(null|string  $method) 

Validate the HTTP method

Parameters

null|string $method

Throws

\InvalidArgumentException

on invalid HTTP method.

getHostFromUri()

getHostFromUri() : string

Retrieve the host from the URI instance

Returns

string

validateUploadedFiles()

validateUploadedFiles(array  $uploadedFiles) 

Recursively validate the structure in an uploaded files array.

Parameters

array $uploadedFiles

Throws

\InvalidArgumentException

if any leaf is not an UploadedFileInterface instance.