Properties

$method

$method : string

Type

string

$headers

$headers : array

Type

array

$protocol

$protocol : string

Type

string

$pathname

$pathname : string

Type

string

$query

$query : array

Type

array

$body

$body : string

Type

string

$port

$port : int

Type

int

$requestTarget

$requestTarget : string|null

Type

string|null

$uri

$uri : \Psr\Http\Message\UriInterface

Type

UriInterface

$headerNames

$headerNames : array

Type

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

Methods

__construct()

__construct(mixed  $method = 'GET', mixed  $uri = '', array  $headers = [], mixed  $body = null, mixed  $version = '1.1') : mixed

Parameters

mixed $method

HTTP method

mixed $uri

URI

array $headers

Request headers

mixed $body

Request body

mixed $version

Protocol version

Returns

mixed —

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(mixed  $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

mixed $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, mixed  $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.

mixed $preserveHost

Preserve the original state of the Host header.

Returns

static —

getProtocolVersion()

getProtocolVersion() : mixed

Returns

mixed —

withProtocolVersion()

withProtocolVersion(mixed  $version) : mixed

Parameters

mixed $version

Returns

mixed —

getHeaders()

getHeaders() : mixed

Returns

mixed —

hasHeader()

hasHeader(mixed  $header) : mixed

Parameters

mixed $header

Returns

mixed —

getHeader()

getHeader(mixed  $header) : mixed

Parameters

mixed $header

Returns

mixed —

getHeaderLine()

getHeaderLine(mixed  $header) : mixed

Parameters

mixed $header

Returns

mixed —

withHeader()

withHeader(mixed  $header, mixed  $value) : mixed

Parameters

mixed $header
mixed $value

Returns

mixed —

withAddedHeader()

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

Parameters

mixed $header
mixed $value

Returns

mixed —

withoutHeader()

withoutHeader(mixed  $header) : mixed

Parameters

mixed $header

Returns

mixed —

getBody()

getBody() : mixed

Returns

mixed —

withBody()

withBody(\Psr\Http\Message\StreamInterface  $body) : mixed

Parameters

\Psr\Http\Message\StreamInterface $body

Returns

mixed —

getPsrRequest()

getPsrRequest() : \GuzzleHttp\Psr7\Request

These fields are compatible if you define other fields.

Mainly for compatibility situations where the code generator cannot generate set properties.

Returns

\GuzzleHttp\Psr7\Request —

updateHostFromUri()

updateHostFromUri() : mixed

Returns

mixed —

assertMethod()

assertMethod(mixed  $method) : mixed

Parameters

mixed $method

Returns

mixed —

setHeaders()

setHeaders(array  $headers) : mixed

Parameters

array $headers

Returns

mixed —

normalizeHeaderValue()

normalizeHeaderValue(mixed  $value) : mixed

Parameters

mixed $value

Returns

mixed —

trimHeaderValues()

trimHeaderValues(string[]  $values) : 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

string[] $values

Header values

Returns

string[] —

Trimmed header values

assertHeader()

assertHeader(mixed  $header) : mixed

Parameters

mixed $header

Returns

mixed —

assertQuery()

assertQuery(array  $query) : mixed

Parameters

array $query

Returns

mixed —