mini\Http\Message\ServerRequest::withUri() Method

public

Signature

public function withUri(Psr\Http\Message\UriInterface $uri, bool $preserveHost = false): Psr\Http\Message\RequestInterface

Parameters

Name Type Default Description
$uri Psr\Http\Message\UriInterface required Documentation missing
$preserveHost bool false Documentation missing

Returns

Psr\Http\Message\RequestInterface

Documentation

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.

Source

src/Http/Message/RequestTrait.php:188-197

← Back to Http\Message\ServerRequest