`mini\Http\Message\Request` class

Show private and protected members

Documentation

Representation of an outgoing, client-side request.

Per the HTTP specification, this interface includes properties for each of the following:

Protocol version
HTTP method
URI
Headers
Message body

During construction, implementations MUST attempt to set the Host header from a provided URI if no Host header is provided.

Requests are considered immutable; all methods that might change state MUST be implemented such that they retain the internal state of the current message and return an instance that contains the changed state.

Inheritance

Implements: Psr\Http\Message\RequestInterface Psr\Http\Message\MessageInterface

Uses Traits: mini\Http\Message\RequestTrait

Properties (7)

protected string $method

protected string $requestTarget

protected ?Psr\Http\Message\UriInterface $uriOverride

protected string $protocolVersion

protected Psr\Http\Message\StreamInterface $body

protected array $headers

protected array $headerCases

Methods (23)

public `__construct()`

Configure the request.

public static `create()`

Create a Request from a URI

public `__clone()`

Documentation missing

protected `RequestTrait()`

Configure the request.

public `getRequestTarget()`

Retrieves the message's request target.

public `withRequestTarget()`

Return an instance with the specific request-target.

public `getMethod()`

Retrieves the HTTP method of the request.

public `withMethod()`

Return an instance with the provided HTTP method.

public `getUri()`

Retrieves the URI instance.

public `withUri()`

Returns an instance with the provided URI.

public `getQuery()`

Get the query string from the request target.

protected `MessageTrait()`

Configure the message trait.

public `getProtocolVersion()`

Retrieves the HTTP protocol version as a string.

public `withProtocolVersion()`

Return an instance with the specified HTTP protocol version.

public `getHeaders()`

Get message headers

public `hasHeader()`

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

public `getHeader()`

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

public `getHeaderLine()`

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

public `withHeader()`

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

public `withAddedHeader()`

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

public `withoutHeader()`

Return an instance without the specified header.

public `getBody()`

Gets the body of the message.

public `withBody()`

Return an instance with the specified message body.

Source

src/Http/Message/Request.php:28-85