Properties

$version

$version : 

Type

$headers

$headers : 

Type

$body

$body : 

Type

$requestTarget

$requestTarget : 

Type

$method

$method : 

Type

$uri

$uri : 

Type

$server

$server : 

Type

$cookies

$cookies : 

Type

$query

$query : 

Type

$uploadedFiles

$uploadedFiles : 

Type

$data

$data : 

Type

$attributes

$attributes : 

Type

Methods

__construct()

__construct(  $version = '1.1', array  $headers = array(), \Psr\Http\Message\StreamInterface  $body = null,   $requestTarget = '/',   $method = 'GET',   $uri = null, array  $server = array(), array  $cookies = array(), array  $query = array(), array  $uploadedFiles = array(),   $data = null, array  $attributes = array()) 

Parameters

$version
array $headers
\Psr\Http\Message\StreamInterface $body
$requestTarget
$method
$uri
array $server
array $cookies
array $query
array $uploadedFiles
$data
array $attributes

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() : array<mixed,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

array<mixed,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) : boolean

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

Parameters

string $name

Case-insensitive header field name.

Returns

boolean —

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) : array<mixed,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

array<mixed,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|array<mixed,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|array<mixed,string> $value

Header value(s).

Returns

static

withAddedHeader()

withAddedHeader(string  $name, string|array<mixed,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|array<mixed,string> $value

Header value(s).

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

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.

Returns

static

getRequestTarget()

getRequestTarget() 

withRequestTarget()

withRequestTarget(  $requestTarget) 

Parameters

$requestTarget

getMethod()

getMethod() 

withMethod()

withMethod(  $method) 

Parameters

$method

getUri()

getUri() 

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.

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