Documentation

ServerRequest extends Request
in package
implements ServerRequestInterface

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.

Interfaces, Classes and Traits

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

Table of Contents

$attributes  : array<string|int, mixed>
$cookieParams  : array<string|int, mixed>
$headerNames  : array<string|int, mixed>
$headers  : array<string|int, mixed>
$method  : string
$parsedBody  : array<string|int, mixed>|object|null
$protocol  : string
$queryParams  : array<string|int, mixed>
$requestTarget  : string|null
$serverParams  : array<string|int, mixed>
$stream  : StreamInterface|null
$uploadedFiles  : array<string|int, mixed>
$uri  : UriInterface
__construct()  : mixed
fromGlobals()  : ServerRequestInterface
Return a ServerRequest populated with superglobals: $_GET $_POST $_COOKIE $_FILES $_SERVER
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()  : UriInterface
Get a Uri populated with values from $_SERVER.
hasHeader()  : mixed
normalizeFiles()  : array<string|int, mixed>
Return an UploadedFile instance array.
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()  : array<string|int, mixed>|UploadedFileInterface
Create and return an UploadedFile instance from a $_FILES specification.
extractHostAndPortFromAuthority()  : mixed
normalizeHeaderValue()  : mixed
normalizeNestedFileSpec()  : array<string|int, UploadedFileInterface>
Normalize an array of file specifications.
setHeaders()  : mixed
trimHeaderValues()  : array<string|int, string>
Trims whitespace from the header values.
updateHostFromUri()  : mixed

Properties

$attributes

private array<string|int, mixed> $attributes = []

$cookieParams

private array<string|int, mixed> $cookieParams = []

$headerNames

private array<string|int, mixed> $headerNames = []

$parsedBody

private array<string|int, mixed>|object|null $parsedBody

$queryParams

private array<string|int, mixed> $queryParams = []

$requestTarget

private string|null $requestTarget

$serverParams

private array<string|int, mixed> $serverParams

$uploadedFiles

private array<string|int, mixed> $uploadedFiles = []

Methods

__construct()

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

HTTP method

$uri : string|UriInterface

URI

$headers : array<string|int, mixed> = []

Request headers

$body : string|resource|StreamInterface|null = null

Request body

$version : string = '1.1'

Protocol version

$serverParams : array<string|int, mixed> = []

Typically the $_SERVER superglobal

Return values
mixed —

getAttribute()

Retrieve a single derived request attribute.

public getAttribute(mixed $attribute[, mixed $default = null ]) : mixed
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>
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>
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
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>
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>
Return values
array<string|int, mixed> —

getUploadedFiles()

Retrieve normalized file upload data.

public getUploadedFiles() : array<string|int, mixed>
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.

hasHeader()

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

normalizeFiles()

Return an UploadedFile instance array.

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

A array which respect $_FILES structure

Tags
throws
InvalidArgumentException

for unrecognized values

Return values
array<string|int, 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
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
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
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
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
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
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()

Create and return an UploadedFile instance from a $_FILES specification.

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

If the specification represents an array of values, this method will delegate to normalizeNestedFileSpec() and return that return value.

Parameters
$value : array<string|int, mixed>

$_FILES struct

Return values
array<string|int, mixed>|UploadedFileInterface —

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

Normalize an array of file specifications.

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

Loops through all nested files and returns a normalized array of UploadedFileInterface instances.

Parameters
$files : array<string|int, mixed> = []
Return values
array<string|int, UploadedFileInterface> —

setHeaders()

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

trimHeaderValues()

Trims whitespace from the header values.

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

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 )

Parameters
$values : array<string|int, string>

Header values

Tags
see
https://tools.ietf.org/html/rfc7230#section-3.2.4
Return values
array<string|int, string> —

Trimmed header values

updateHostFromUri()

private updateHostFromUri() : mixed
Return values
mixed —

Search results