Properties

$headers

$headers : array

Type

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

$headerNames

$headerNames : array

Type

array — Map of lowercase header name => original name at registration

$protocol

$protocol : string

Type

string

$method

$method : string

Type

string

$requestTarget

$requestTarget : null|string

Type

null|string

Methods

getProtocolVersion()

getProtocolVersion() 

withProtocolVersion()

withProtocolVersion(  $version) 

Parameters

$version

getHeaders()

getHeaders() 

hasHeader()

hasHeader(  $header) 

Parameters

$header

getHeader()

getHeader(  $header) 

Parameters

$header

getHeaderLine()

getHeaderLine(  $header) 

Parameters

$header

withHeader()

withHeader(  $header,   $value) 

Parameters

$header
$value

withAddedHeader()

withAddedHeader(  $header,   $value) 

Parameters

$header
$value

withoutHeader()

withoutHeader(  $header) 

Parameters

$header

getBody()

getBody() 

__construct()

__construct(string  $method, string|\Psr\Http\Message\UriInterface  $uri, array  $headers = array(), string|null|resource|\Psr\Http\Message\StreamInterface  $body = null, string  $version = '1.1') 

Parameters

string $method

HTTP method

string|\Psr\Http\Message\UriInterface $uri

URI

array $headers

Request headers

string|null|resource|\Psr\Http\Message\StreamInterface $body

Request body

string $version

Protocol version

getRequestTarget()

getRequestTarget() : string

Retrieves the message's request target.

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

Returns

string

withRequestTarget()

withRequestTarget(mixed  $requestTarget) : static

Return an instance with the specific request-target.

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

mixed $requestTarget

Returns

static

getMethod()

getMethod() : string

Retrieves the HTTP method of the request.

Returns

string —

Returns the request method.

withMethod()

withMethod(string  $method) : static

Return an instance with the provided HTTP method.

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

string $method

Case-sensitive method.

Returns

static

getUri()

getUri() : \Psr\Http\Message\UriInterface

Retrieves the URI instance.

This method MUST return a UriInterface instance.

Returns

\Psr\Http\Message\UriInterface

Returns a UriInterface instance representing the URI of the request.

withUri()

withUri(\Psr\Http\Message\UriInterface  $uri, boolean  $preserveHost = false) : static

Returns an instance with the provided URI.

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

\Psr\Http\Message\UriInterface $uri

New request URI to use.

boolean $preserveHost

Preserve the original state of the Host header.

Returns

static

setHeaders()

setHeaders(array  $headers) 

Parameters

array $headers

normalizeHeaderValue()

normalizeHeaderValue(  $value) 

Parameters

$value

trimHeaderValues()

trimHeaderValues(array<mixed,string>  $values) : array<mixed,string>

Trims whitespace from the header values.

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

array<mixed,string> $values

Header values

Returns

array<mixed,string> —

Trimmed header values

assertHeader()

assertHeader(  $header) 

Parameters

$header

updateHostFromUri()

updateHostFromUri() 

assertMethod()

assertMethod(  $method) 

Parameters

$method