Documentation

ServerRequest extends Request
in package
implements ServerRequestInterface

Interfaces, Classes, Traits and Enums

ServerRequestInterface
Representation of an incoming, server-side HTTP request.

Table of Contents

$attributes  : mixed
$cookieParams  : mixed
$headerNames  : mixed
$headers  : mixed
$method  : mixed
$parsedBody  : mixed
$protocol  : mixed
$queryParams  : mixed
$requestTarget  : mixed
$serverParams  : mixed
$stream  : mixed
$uploadedFiles  : mixed
$uri  : mixed
__construct()  : mixed
fromGlobals()  : mixed
getAttribute()  : mixed
Retrieve a single derived request attribute.
getAttributes()  : array<string|int, mixed>
Retrieve attributes derived from the request.
getBody()  : mixed
getCookieParams()  : array<string|int, mixed>
Retrieve cookies.
getHeader()  : mixed
getHeaderLine()  : mixed
getHeaders()  : mixed
getMethod()  : string
Retrieves the HTTP method of the request.
getParsedBody()  : null|array<string|int, mixed>|object
Retrieve any parameters provided in the request body.
getProtocolVersion()  : mixed
getQueryParams()  : array<string|int, mixed>
Retrieve query string arguments.
getRequestTarget()  : string
Retrieves the message's request target.
getServerParams()  : array<string|int, mixed>
Retrieve server parameters.
getUploadedFiles()  : array<string|int, mixed>
Retrieve normalized file upload data.
getUri()  : UriInterface
Retrieves the URI instance.
getUriFromGlobals()  : mixed
hasHeader()  : mixed
normalizeFiles()  : mixed
withAddedHeader()  : mixed
withAttribute()  : static
Return an instance with the specified derived request attribute.
withBody()  : mixed
withCookieParams()  : static
Return an instance with the specified cookies.
withHeader()  : mixed
withMethod()  : static
Return an instance with the provided HTTP method.
withoutAttribute()  : static
Return an instance that removes the specified derived request attribute.
withoutHeader()  : mixed
withParsedBody()  : static
Return an instance with the specified body parameters.
withProtocolVersion()  : mixed
withQueryParams()  : static
Return an instance with the specified query string arguments.
withRequestTarget()  : static
Return an instance with the specific request-target.
withUploadedFiles()  : static
Create a new instance with the specified uploaded files.
withUri()  : static
Returns an instance with the provided URI.
assertHeader()  : mixed
assertMethod()  : mixed
createUploadedFileFromSpec()  : mixed
extractHostAndPortFromAuthority()  : mixed
normalizeHeaderValue()  : mixed
normalizeNestedFileSpec()  : mixed
setHeaders()  : mixed
trimHeaderValues()  : mixed
updateHostFromUri()  : mixed

Properties

$requestTarget

private mixed $requestTarget

Methods

__construct()

public __construct(mixed $method, mixed $uri[, array<string|int, mixed> $headers = [] ][, mixed $body = null ][, mixed $version = '1.1' ][, array<string|int, mixed> $serverParams = [] ]) : mixed
Parameters
$method : mixed
$uri : mixed
$headers : array<string|int, mixed> = []
$body : mixed = null
$version : mixed = '1.1'
$serverParams : array<string|int, mixed> = []
Return values
mixed

fromGlobals()

public static fromGlobals() : mixed
Return values
mixed

getAttribute()

Retrieve a single derived request attribute.

public getAttribute(mixed $attribute[, mixed $default = null ]) : mixed

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 : mixed = null

Default value to return if the attribute does not exist.

Return values
mixed

getAttributes()

Retrieve attributes derived from the request.

public getAttributes() : array<string|int, mixed>

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.

Return values
array<string|int, mixed>

Attributes derived from the request.

getBody()

public getBody() : mixed
Return values
mixed

getCookieParams()

Retrieve cookies.

public getCookieParams() : array<string|int, mixed>

Retrieves cookies sent by the client to the server.

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

Return values
array<string|int, mixed>

getHeader()

public getHeader(mixed $header) : mixed
Parameters
$header : mixed
Return values
mixed

getHeaderLine()

public getHeaderLine(mixed $header) : mixed
Parameters
$header : mixed
Return values
mixed

getHeaders()

public getHeaders() : mixed
Return values
mixed

getMethod()

Retrieves the HTTP method of the request.

public getMethod() : string
Return values
string

Returns the request method.

getParsedBody()

Retrieve any parameters provided in the request body.

public getParsedBody() : null|array<string|int, mixed>|object

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.

Return values
null|array<string|int, mixed>|object

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

getProtocolVersion()

public getProtocolVersion() : mixed
Return values
mixed

getQueryParams()

Retrieve query string arguments.

public getQueryParams() : array<string|int, mixed>

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.

Return values
array<string|int, mixed>

getRequestTarget()

Retrieves the message's request target.

public getRequestTarget() : string

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

Return values
string

getServerParams()

Retrieve server parameters.

public getServerParams() : array<string|int, mixed>

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

Return values
array<string|int, mixed>

getUploadedFiles()

Retrieve normalized file upload data.

public getUploadedFiles() : array<string|int, mixed>

This method returns upload metadata in a normalized tree, with each leaf an instance of yxorP\inc\Psr\Http\Message\UploadedFileInterface.

These values MAY be prepared from $_FILES or the message body during instantiation, or MAY be injected via withUploadedFiles().

Return values
array<string|int, mixed>

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

getUri()

Retrieves the URI instance.

public getUri() : UriInterface

This method MUST return a UriInterface instance.

Return values
UriInterface

Returns a UriInterface instance representing the URI of the request.

getUriFromGlobals()

public static getUriFromGlobals() : mixed
Return values
mixed

hasHeader()

public hasHeader(mixed $header) : mixed
Parameters
$header : mixed
Return values
mixed

normalizeFiles()

public static normalizeFiles(array<string|int, mixed> $files) : mixed
Parameters
$files : array<string|int, mixed>
Return values
mixed

withAddedHeader()

public withAddedHeader(mixed $header, mixed $value) : mixed
Parameters
$header : mixed
$value : mixed
Return values
mixed

withAttribute()

Return an instance with the specified derived request attribute.

public withAttribute(mixed $attribute, mixed $value) : static

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 : mixed

The value of the attribute.

Return values
static

withCookieParams()

Return an instance with the specified cookies.

public withCookieParams(array<string|int, mixed> $cookies) : static

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
$cookies : array<string|int, mixed>

Array of key/value pairs representing cookies.

Return values
static

withHeader()

public withHeader(mixed $header, mixed $value) : mixed
Parameters
$header : mixed
$value : mixed
Return values
mixed

withMethod()

Return an instance with the provided HTTP method.

public withMethod(mixed $method) : static

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
$method : mixed

Case-sensitive method.

Return values
static

withoutAttribute()

Return an instance that removes the specified derived request attribute.

public withoutAttribute(mixed $attribute) : static

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 : mixed
Return values
static

withoutHeader()

public withoutHeader(mixed $header) : mixed
Parameters
$header : mixed
Return values
mixed

withParsedBody()

Return an instance with the specified body parameters.

public withParsedBody(mixed $data) : static

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
$data : mixed

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

Return values
static

withProtocolVersion()

public withProtocolVersion(mixed $version) : mixed
Parameters
$version : mixed
Return values
mixed

withQueryParams()

Return an instance with the specified query string arguments.

public withQueryParams(array<string|int, mixed> $query) : static

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
$query : array<string|int, mixed>

Array of query string arguments, typically from $_GET.

Return values
static

withRequestTarget()

Return an instance with the specific request-target.

public withRequestTarget(mixed $requestTarget) : static

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
$requestTarget : mixed
Return values
static

withUploadedFiles()

Create a new instance with the specified uploaded files.

public withUploadedFiles(array<string|int, mixed> $uploadedFiles) : static

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
$uploadedFiles : array<string|int, mixed>

An array tree of UploadedFileInterface instances.

Return values
static

withUri()

Returns an instance with the provided URI.

public withUri(UriInterface $uri[, mixed $preserveHost = false ]) : static

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
$uri : UriInterface

New request URI to use.

$preserveHost : mixed = false

Preserve the original state of the Host header.

Return values
static

assertHeader()

private assertHeader(mixed $header) : mixed
Parameters
$header : mixed
Return values
mixed

assertMethod()

private assertMethod(mixed $method) : mixed
Parameters
$method : mixed
Return values
mixed

createUploadedFileFromSpec()

private static createUploadedFileFromSpec(array<string|int, mixed> $value) : mixed
Parameters
$value : array<string|int, mixed>
Return values
mixed

extractHostAndPortFromAuthority()

private static extractHostAndPortFromAuthority(mixed $authority) : mixed
Parameters
$authority : mixed
Return values
mixed

normalizeHeaderValue()

private normalizeHeaderValue(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed

normalizeNestedFileSpec()

private static normalizeNestedFileSpec([array<string|int, mixed> $files = [] ]) : mixed
Parameters
$files : array<string|int, mixed> = []
Return values
mixed

setHeaders()

private setHeaders(array<string|int, mixed> $headers) : mixed
Parameters
$headers : array<string|int, mixed>
Return values
mixed

trimHeaderValues()

private trimHeaderValues(array<string|int, mixed> $values) : mixed
Parameters
$values : array<string|int, mixed>
Return values
mixed

updateHostFromUri()

private updateHostFromUri() : mixed
Return values
mixed

Search results