\Psr\Http\MessageServerRequestInterface

Representation of an incoming, server-side HTTP request.

Per the HTTP specification, this interface includes properties for each of the following:

  • Protocol version
  • HTTP method
  • URI
  • Headers
  • Message body

Additionally, it encapsulates all data as it has arrived to the application from the CGI and/or PHP environment, including:

  • The values represented in $_SERVER.
  • Any cookies provided (generally via $_COOKIE)
  • Query string arguments (generally via $_GET, or as parsed via parse_str())
  • Upload files, if any (as represented by $_FILES)
  • Deserialized body parameters (generally from $_POST)

$_SERVER values MUST be treated as immutable, as they represent application state at the time of request; as such, no methods are provided to allow modification of those values. The other values provide such methods, as they can be restored from $_SERVER or the request body, and may need treatment during the application (e.g., body parameters may be deserialized based on content type).

Additionally, this interface recognizes the utility of introspecting a request to derive and match additional parameters (e.g., via URI path matching, decrypting cookie values, deserializing non-form-encoded body content, matching authorization headers to users, etc). These parameters are stored in an "attributes" property.

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.

Summary

Methods
Constants
getRequestTarget()
withRequestTarget()
getMethod()
withMethod()
getUri()
withUri()
getProtocolVersion()
withProtocolVersion()
getHeaders()
hasHeader()
getHeader()
getHeaderLine()
withHeader()
withAddedHeader()
withoutHeader()
getBody()
withBody()
getServerParams()
getCookieParams()
withCookieParams()
getQueryParams()
withQueryParams()
getUploadedFiles()
withUploadedFiles()
getParsedBody()
withParsedBody()
getAttributes()
getAttribute()
withAttribute()
withoutAttribute()
No constants found
No protected methods found
N/A
No private methods found
N/A

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

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

mixed $requestTarget

Returns

static —

getMethod()

getMethod() : string

Retrieves the HTTP method of the request.

Returns

string —

Returns the request method.

withMethod()

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.

Parameters

string $method

Case-sensitive method.

Throws

\InvalidArgumentException

for invalid HTTP methods.

Returns

static —

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.

withUri()

withUri(\Psr\Http\Message\UriInterface  $uri, bool  $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:

  • 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

\Psr\Http\Message\UriInterface $uri

New request URI to use.

bool $preserveHost

Preserve the original state of the Host header.

Returns

static —

getProtocolVersion()

getProtocolVersion() : string

Retrieves the HTTP protocol version as a string.

The string MUST contain only the HTTP version number (e.g., "1.1", "1.0").

Returns

string —

HTTP protocol version.

withProtocolVersion()

withProtocolVersion(string  $version) : static

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.

Parameters

string $version

HTTP protocol version

Returns

static —

getHeaders()

getHeaders() : string[][]

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.

Returns

string[][] —

Returns an associative array of the message's headers. Each key MUST be a header name, and each value MUST be an array of strings for that header.

hasHeader()

hasHeader(string  $name) : bool

Checks if a header exists by the given case-insensitive name.

Parameters

string $name

Case-insensitive header field name.

Returns

bool —

Returns true if any header names match the given header name using a case-insensitive string comparison. Returns false if no matching header name is found in the message.

getHeader()

getHeader(string  $name) : string[]

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.

Parameters

string $name

Case-insensitive header field name.

Returns

string[] —

An array of string values as provided for the given header. If the header does not appear in the message, this method MUST return an empty array.

getHeaderLine()

getHeaderLine(string  $name) : string

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.

Parameters

string $name

Case-insensitive header field name.

Returns

string —

A string of values as provided for the given header concatenated together using a comma. If the header does not appear in the message, this method MUST return an empty string.

withHeader()

withHeader(string  $name, string|string[]  $value) : static

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.

Parameters

string $name

Case-insensitive header field name.

string|string[] $value

Header value(s).

Throws

\InvalidArgumentException

for invalid header names or values.

Returns

static —

withAddedHeader()

withAddedHeader(string  $name, string|string[]  $value) : static

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.

Parameters

string $name

Case-insensitive header field name to add.

string|string[] $value

Header value(s).

Throws

\InvalidArgumentException

for invalid header names or values.

Returns

static —

withoutHeader()

withoutHeader(string  $name) : static

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.

Parameters

string $name

Case-insensitive header field name to remove.

Returns

static —

getBody()

getBody() : \Psr\Http\Message\StreamInterface

Gets the body of the message.

Returns

\Psr\Http\Message\StreamInterface —

Returns the body as a stream.

withBody()

withBody(\Psr\Http\Message\StreamInterface  $body) : static

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.

Parameters

\Psr\Http\Message\StreamInterface $body

Body.

Throws

\InvalidArgumentException

When the body is not valid.

Returns

static —

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 —

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 —

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.

Throws

\InvalidArgumentException

if an invalid structure is provided.

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.

Throws

\InvalidArgumentException

if an unsupported argument type is provided.

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(string  $name, 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

string $name

The attribute name.

mixed $default

Default value to return if the attribute does not exist.

Returns

mixed —

withAttribute()

withAttribute(string  $name, 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

string $name

The attribute name.

mixed $value

The value of the attribute.

Returns

static —

withoutAttribute()

withoutAttribute(string  $name) : 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

string $name

The attribute name.

Returns

static —