Documentation

ServerRequest extends Request
in package

Application

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

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

Properties

$attributes : array<string|int, mixed>
$cookieParams : array<string|int, mixed>
$headerNames : array<string|int, string>
$headers : array<string|int, array<string|int, string>>
$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

Methods

__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() : StreamInterface
getCookieParams() : array<string|int, mixed>: Retrieve cookies.
getHeader() : array<string|int, mixed>
getHeaderLine() : string
getHeaders() : array<string|int, mixed>
getMethod() : string: Retrieves the HTTP method of the request.
getParsedBody() : array<string|int, mixed>|object|null: Retrieve any parameters provided in the request body.
getProtocolVersion() : string
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() : bool
normalizeFiles() : array<string|int, mixed>: Return an UploadedFile instance array.
withAddedHeader() : MessageInterface
withAttribute() : static: Return an instance with the specified derived request attribute.
withBody() : MessageInterface
withCookieParams() : static: Return an instance with the specified cookies.
withHeader() : MessageInterface
withMethod() : static: Return an instance with the provided HTTP method.
withoutAttribute() : static: Return an instance that removes the specified derived request attribute.
withoutHeader() : MessageInterface
withParsedBody() : static: Return an instance with the specified body parameters.
withProtocolVersion() : MessageInterface
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() : void
assertMethod() : void
assertValue() : void
createUploadedFileFromSpec() : UploadedFileInterface|array<string|int, UploadedFileInterface>: Create and return an UploadedFile instance from a $_FILES specification.
extractHostAndPortFromAuthority() : array<string|int, mixed>
normalizeHeaderValue() : array<string|int, string>
normalizeNestedFileSpec() : array<string|int, UploadedFileInterface>: Normalize an array of file specifications.
setHeaders() : void
trimAndValidateHeaderValues() : array<string|int, string>: Trims whitespace from the header values.
updateHostFromUri() : void

$attributes


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

$cookieParams


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

$headerNames


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

Map of lowercase header name => original name at registration

$headers


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

Map of all registered headers, as original name => array of values

$method


    private
        string
    $method

$parsedBody


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

$protocol


    private
        string
    $protocol
     = '1.1'

$queryParams


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

$requestTarget


    private
        string|null
    $requestTarget

$serverParams


    private
        array<string|int, mixed>
    $serverParams

$stream


    private
        StreamInterface|null
    $stream

$uploadedFiles


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

$uri


    private
        UriInterface
    $uri

__construct()


    public
                    __construct(string $method, string|UriInterface $uri[, array<string|int, string|array<string|int, string>> $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, string|array<string|int, string>> = []: 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

fromGlobals()

Return a ServerRequest populated with superglobals: $_GET $_POST $_COOKIE $_FILES $_SERVER


    public
            static        fromGlobals() : ServerRequestInterface

Return values

ServerRequestInterface

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.

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

Return values

StreamInterface

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

Parameters

$header : mixed

Return values

array<string|int, mixed>

getHeaderLine()


    public
                    getHeaderLine(mixed $header) : string

Parameters

$header : mixed

Return values

string

getHeaders()


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

Return values

array<string|int, 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() : array<string|int, mixed>|object|null

Return values

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

getProtocolVersion()


    public
                    getProtocolVersion() : string

Return values

string

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

Get a Uri populated with values from $_SERVER.


    public
            static        getUriFromGlobals() : UriInterface

Return values

UriInterface

hasHeader()


    public
                    hasHeader(mixed $header) : bool

Parameters

$header : mixed

Return values

bool

normalizeFiles()

Return an UploadedFile instance array.


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

Parameters

$files : array<string|int, mixed>: An array which respect $_FILES structure

Return values

array<string|int, mixed>

withAddedHeader()


    public
                    withAddedHeader(mixed $header, mixed $value) : MessageInterface

Parameters

$header : mixed
$value : mixed

Return values

MessageInterface

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

withBody()


    public
                    withBody(StreamInterface $body) : MessageInterface

Parameters

$body : StreamInterface

Return values

MessageInterface

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) : MessageInterface

Parameters

$header : mixed
$value : mixed

Return values

MessageInterface

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) : MessageInterface

Parameters

$header : mixed

Return values

MessageInterface

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) : MessageInterface

Parameters

$version : mixed

Return values

MessageInterface

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) : void

Parameters

$header : mixed

assertMethod()


    private
                    assertMethod(mixed $method) : void

Parameters

$method : mixed

assertValue()


    private
                    assertValue(string $value) : void

Parameters

$value : string

createUploadedFileFromSpec()

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


    private
            static        createUploadedFileFromSpec(array<string|int, mixed> $value) : UploadedFileInterface|array<string|int, 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

UploadedFileInterface|array<string|int, UploadedFileInterface>

extractHostAndPortFromAuthority()


    private
            static        extractHostAndPortFromAuthority(string $authority) : array<string|int, mixed>

Parameters

$authority : string

Return values

array<string|int, mixed>

normalizeHeaderValue()


    private
                    normalizeHeaderValue(mixed $value) : array<string|int, string>

Parameters

$value : mixed

Return values

array<string|int, string>

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, string|array<string|int, string>> $headers) : void

Parameters

$headers : array<string|int, string|array<string|int, string>>

trimAndValidateHeaderValues()

Trims whitespace from the header values.


    private
                    trimAndValidateHeaderValues(array<string|int, mixed> $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, mixed>: Header values

Return values

array<string|int, string> —

Trimmed header values

updateHostFromUri()


    private
                    updateHostFromUri() : void

ServerRequest extends Request in package Application implements ServerRequestInterface

Table of Contents

Interfaces

Properties

Methods

Properties

$attributes

$cookieParams

$headerNames

$headers

$method

$parsedBody

$protocol

$queryParams

$requestTarget

$serverParams

$stream

$uploadedFiles

$uri

Methods

__construct()

Parameters

fromGlobals()

Return values

getAttribute()

Parameters

getAttributes()

Return values

getBody()

Return values

getCookieParams()

Return values

getHeader()

Parameters

Return values

getHeaderLine()

Parameters

Return values

getHeaders()

Return values

getMethod()

Return values

getParsedBody()

Return values

getProtocolVersion()

Return values

getQueryParams()

Return values

getRequestTarget()

Return values

getServerParams()

Return values

getUploadedFiles()

Return values

getUri()

Return values

getUriFromGlobals()

Return values

hasHeader()

Parameters

Return values

normalizeFiles()

Parameters

Tags

Return values

withAddedHeader()

Parameters

Return values

withAttribute()

Parameters

Return values

withBody()

Parameters

Return values

withCookieParams()

Parameters

Return values

withHeader()

Parameters

Return values

ServerRequest extends Request
in package

Application

implements ServerRequestInterface