SDK for PHP 3.x

Request
in package
implements RequestInterface Uses MessageTrait

PSR-7 request implementation.

Table of Contents

Interfaces

RequestInterface
Representation of an outgoing, client-side request.

Methods

__construct()  : mixed
getBody()  : StreamInterface
getHeader()  : array<string|int, mixed>
getHeaderLine()  : string
getHeaders()  : array<string|int, mixed>
getMethod()  : string
Retrieves the HTTP method of the request.
getProtocolVersion()  : string
getRequestTarget()  : string
Retrieves the message's request target.
getUri()  : UriInterface
Retrieves the URI instance.
hasHeader()  : bool
withAddedHeader()  : MessageInterface
withBody()  : MessageInterface
withHeader()  : MessageInterface
withMethod()  : static
Return an instance with the provided HTTP method.
withoutHeader()  : MessageInterface
withProtocolVersion()  : MessageInterface
withRequestTarget()  : static
Return an instance with the specific request-target.
withUri()  : static
Returns an instance with the provided URI.

Methods

__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' ]) : 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

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.

getProtocolVersion()

public getProtocolVersion() : string
Return values
string

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

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

withAddedHeader()

public withAddedHeader(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

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[, 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
On this page