TYPO3 11.5 API: Request

Request extends Message implements RequestInterface

Default implementation for the RequestInterface of the PSR-7 standard It is the base for any request sent BY PHP.

Please see ServerRequest for the typical use cases in the framework.

Highly inspired by https://github.com/phly/http/

Internal

Note that this is not public API yet.

Interfaces

RequestInterface

Properties

$body : StreamInterface|null: The body as a Stream object
$headers : array<string|int, mixed>: Associative array containing all headers of this Message This is a mixed-case list of the headers (as due to the specification)
$lowercasedHeaderNames : array<string|int, mixed>: Lowercased version of all headers, in order to check if a header is set or not this way a lot of checks are easier to be set
$method : string|null: The HTTP method, defaults to GET
$protocolVersion : string: The HTTP Protocol version, defaults to 1.1
$requestTarget : string|null: The request-target, if it has been provided or calculated.
$supportedMethods : array<string|int, mixed>: Supported HTTP methods
$uri : UriInterface|null: An instance of the Uri object

Methods

__construct() : mixed: Constructor, the only place to set all parameters of this Request
filter() : string: Filter a header value
getBody() : StreamInterface: Gets the body of the message.
getHeader() : array<string|int, string>: Retrieves a message header value by the given case-insensitive name.
getHeaderLine() : string: Retrieves a comma-separated string of the values for a single header.
getHeaders() : array<string|int, mixed>: Retrieves all message header values.
getMethod() : string: Retrieves the HTTP method of the request, defaults to GET
getProtocolVersion() : string: Retrieves the HTTP protocol version as a string.
getRequestTarget() : string: Retrieves the message's request target.
getUri() : UriInterface: Retrieves the URI instance.
hasHeader() : bool: Checks if a header exists by the given case-insensitive name.
isValidHeaderValue() : bool: Checks if an HTTP header value is valid.
validateHeaderName() : mixed: Check whether or not a header name is valid and throw an exception.
withAddedHeader() : static: Return an instance with the specified header appended with the given value.
withBody() : static: Return an instance with the specified message body.
withHeader() : static: Return an instance with the provided value replacing the specified header.
withMethod() : static: Return an instance with the provided HTTP method.
withoutHeader() : static: Return an instance without the specified header.
withProtocolVersion() : static: Return an instance with the specified HTTP protocol version.
withRequestTarget() : static: Return an instance with the specific request-target.
withUri() : static: Returns an instance with the provided URI.
arrayContainsOnlyStrings() : bool: Helper function to test if an array contains only strings
assertHeaders() : mixed: Ensure header names and values are valid.
filterHeaders() : array<string|int, mixed>: Filter a set of headers to ensure they are in the correct internal format.
getHostFromUri() : string: Retrieve the host from the URI instance
validateHeaderValues() : mixed: Assert that the provided header values are valid.
validateMethod() : mixed: Validate the HTTP method, helper function.

$body

The body as a Stream object


    protected
        StreamInterface|null
    $body

$headers

Associative array containing all headers of this Message This is a mixed-case list of the headers (as due to the specification)


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

$lowercasedHeaderNames

Lowercased version of all headers, in order to check if a header is set or not this way a lot of checks are easier to be set


    protected
        array<string|int, mixed>
    $lowercasedHeaderNames
     = []

$method

The HTTP method, defaults to GET


    protected
        string|null
    $method

$protocolVersion

The HTTP Protocol version, defaults to 1.1


    protected
        string
    $protocolVersion
     = '1.1'

$requestTarget

The request-target, if it has been provided or calculated.


    protected
        string|null
    $requestTarget

$supportedMethods

Supported HTTP methods


    protected
        array<string|int, mixed>
    $supportedMethods
     = [
    'CONNECT',
    'DELETE',
    'GET',
    'HEAD',
    'OPTIONS',
    'PATCH',
    'POST',
    'PUT',
    'TRACE',
    // WebDAV methods
    'COPY',
    'LOCK',
    'MKCOL',
    'MOVE',
    'PROPFIND',
    'PROPPATCH',
    'REPORT',
    'UNLOCK',
    // Custom methods
    'PURGE',
    'BAN',
]

$uri

An instance of the Uri object


    protected
        UriInterface|null
    $uri

__construct()

Constructor, the only place to set all parameters of this Request


    public
                    __construct([string|UriInterface|null $uri = null ][, string|null $method = null ][, string|resource|StreamInterface|null $body = 'php://input' ][, array<string|int, mixed> $headers = [] ]) : mixed

Parameters

$uri : string|UriInterface|null = null: URI for the request, if any.
$method : string|null = null: HTTP method for the request, if any.
$body : string|resource|StreamInterface|null = 'php://input': Message body, if any.
$headers : array<string|int, mixed> = []: Headers for the message, if any.

filter()

Filter a header value


    public
                    filter(string $value) : string

Ensures CRLF header injection vectors are filtered.

Per RFC 7230, only VISIBLE ASCII characters, spaces, and horizontal tabs are allowed in values; header continuations MUST consist of a single CRLF sequence followed by a space or horizontal tab.

This method filters any values not allowed from the string, and is lossy.

Parameters

$value : string

Return values

string

getBody()

Gets the body of the message.


    public
                    getBody() : StreamInterface

Return values

StreamInterface —

Returns the body as a stream.

getHeader()

Retrieves a message header value by the given case-insensitive name.


    public
                    getHeader(string $header) : array<string|int, string>

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

$header : string: Case-insensitive header field name.

Return values

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

Retrieves a comma-separated string of the values for a single header.


    public
                    getHeaderLine(string $name) : string

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

$name : string: Case-insensitive header field name.

Return values

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.

getHeaders()

Retrieves all message header values.


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

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.

Return values

array<string|int, mixed> —

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.

getMethod()

Retrieves the HTTP method of the request, defaults to GET


    public
                    getMethod() : string

Return values

string —

Returns the request method.

getProtocolVersion()

Retrieves the HTTP protocol version as a string.


    public
                    getProtocolVersion() : string

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

Return values

string —

HTTP protocol version.

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

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

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


    public
                    hasHeader(string $name) : bool

Parameters

$name : string: Case-insensitive header field name.

Return values

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.

isValidHeaderValue()

Checks if an HTTP header value is valid.


    public
                    isValidHeaderValue(string $value) : bool

Per RFC 7230, only VISIBLE ASCII characters, spaces, and horizontal tabs are allowed in values; header continuations MUST consist of a single CRLF sequence followed by a space or horizontal tab.

Parameters

$value : string

Return values

bool

validateHeaderName()

Check whether or not a header name is valid and throw an exception.


    public
                    validateHeaderName(string $name) : mixed

Parameters

$name : string

withAddedHeader()

Return an instance with the specified header appended with the given value.


    public
                    withAddedHeader(string $name, string|array<string|int, string> $value) : static

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

$name : string: Case-insensitive header field name to add.
$value : string|array<string|int, string>: Header value(s).

Return values

static

withBody()

Return an instance with the specified message body.


    public
                    withBody(StreamInterface $body) : static

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

$body : StreamInterface: Body.

Return values

static

withHeader()

Return an instance with the provided value replacing the specified header.


    public
                    withHeader(string $name, string|array<string|int, string> $value) : static

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

$name : string: Case-insensitive header field name.
$value : string|array<string|int, string>: Header value(s).

Return values

static

withMethod()

Return an instance with the provided HTTP method.


    public
                    withMethod(string $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 : string: Case-sensitive method.

Return values

static

withoutHeader()

Return an instance without the specified header.


    public
                    withoutHeader(string $name) : static

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

$name : string: Case-insensitive header field name to remove.

Return values

static

withProtocolVersion()

Return an instance with the specified HTTP protocol version.


    public
                    withProtocolVersion(string $version) : static

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

$version : string: HTTP protocol version

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

withUri()

Returns an instance with the provided URI.


    public
                    withUri(UriInterface $uri[, bool $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 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 : bool = false: Preserve the original state of the Host header.

Return values

static

arrayContainsOnlyStrings()

Helper function to test if an array contains only strings


    protected
                    arrayContainsOnlyStrings(array<string|int, mixed> $data) : bool

Parameters

$data : array<string|int, mixed>

Return values

bool

assertHeaders()

Ensure header names and values are valid.


    protected
                    assertHeaders(array<string|int, mixed> $headers) : mixed

Parameters

$headers : array<string|int, mixed>

filterHeaders()

Filter a set of headers to ensure they are in the correct internal format.


    protected
                    filterHeaders(array<string|int, mixed> $originalHeaders) : array<string|int, mixed>

Used by message constructors to allow setting all initial headers at once.

Parameters

$originalHeaders : array<string|int, mixed>: Headers to filter.

Return values

array<string|int, mixed> —

Filtered headers and names.

getHostFromUri()

Retrieve the host from the URI instance


    protected
                    getHostFromUri() : string

Return values

string

validateHeaderValues()

Assert that the provided header values are valid.


    protected
                    validateHeaderValues(array<string|int, string> $values) : mixed

Parameters

$values : array<string|int, string>

validateMethod()

Validate the HTTP method, helper function.


    protected
                    validateMethod(string|null $method) : mixed

Parameters

$method : string|null

Request extends Message implements RequestInterface

Table of Contents

Interfaces

Properties

Methods

Properties

$body

$headers

$lowercasedHeaderNames

$method

$protocolVersion

$requestTarget

$supportedMethods

$uri

Methods

__construct()

Parameters

Tags

filter()

Parameters

Tags

Return values

getBody()

Return values

getHeader()

Parameters

Return values

getHeaderLine()

Parameters

Return values

getHeaders()

Return values

getMethod()

Return values

getProtocolVersion()

Return values

getRequestTarget()

Return values

getUri()

Tags

Return values

hasHeader()

Parameters

Return values

isValidHeaderValue()

Parameters

Tags

Return values

validateHeaderName()

Parameters

Tags

withAddedHeader()

Parameters

Tags

Return values

withBody()

Parameters

Tags

Return values

withHeader()

Parameters

Tags

Return values

withMethod()

Parameters

Tags

Return values

withoutHeader()

Parameters

Return values

withProtocolVersion()

Parameters

Return values

withRequestTarget()

Parameters

Tags

Return values

withUri()

Parameters

Tags