function Utils::modifyRequest

Clone and modify a request with the given changes.

This method is useful for reducing the number of clones needed to mutate a message.

The changes can be one of:

• method: (string) Changes the HTTP method.
• set_headers: (array) Sets the given headers.
• remove_headers: (array) Remove the given headers.
• body: (mixed) Sets the given body.
• uri: (UriInterface) Set the URI.
• query: (string) Set the query string value of the URI.
• version: (string) Set the protocol version.

Parameters

RequestInterface $request Request to clone and modify.:

array $changes Changes to apply.:

File

vendor/guzzlehttp/psr7/src/Utils.php, line 159

Class

Utils

Namespace

GuzzleHttp\Psr7

Code

public static function modifyRequest(RequestInterface $request, array $changes) : RequestInterface {
    if (!$changes) {
        return $request;
    }
    $headers = $request->getHeaders();
    if (!isset($changes['uri'])) {
        $uri = $request->getUri();
    }
    else {
        // Remove the host header if one is on the URI
        if ($host = $changes['uri']->getHost()) {
            $changes['set_headers']['Host'] = $host;
            if ($port = $changes['uri']->getPort()) {
                $standardPorts = [
                    'http' => 80,
                    'https' => 443,
                ];
                $scheme = $changes['uri']->getScheme();
                if (isset($standardPorts[$scheme]) && $port != $standardPorts[$scheme]) {
                    $changes['set_headers']['Host'] .= ':' . $port;
                }
            }
        }
        $uri = $changes['uri'];
    }
    if (!empty($changes['remove_headers'])) {
        $headers = self::caselessRemove($changes['remove_headers'], $headers);
    }
    if (!empty($changes['set_headers'])) {
        $headers = self::caselessRemove(array_keys($changes['set_headers']), $headers);
        $headers = $changes['set_headers'] + $headers;
    }
    if (isset($changes['query'])) {
        $uri = $uri->withQuery($changes['query']);
    }
    if ($request instanceof ServerRequestInterface) {
        $new = (new ServerRequest($changes['method'] ?? $request->getMethod(), $uri, $headers, $changes['body'] ?? $request->getBody(), $changes['version'] ?? $request->getProtocolVersion(), $request->getServerParams()))
            ->withParsedBody($request->getParsedBody())
            ->withQueryParams($request->getQueryParams())
            ->withCookieParams($request->getCookieParams())
            ->withUploadedFiles($request->getUploadedFiles());
        foreach ($request->getAttributes() as $key => $value) {
            $new = $new->withAttribute($key, $value);
        }
        return $new;
    }
    return new Request($changes['method'] ?? $request->getMethod(), $uri, $headers, $changes['body'] ?? $request->getBody(), $changes['version'] ?? $request->getProtocolVersion());
}