phasync
CurlResponse / withAddedHeader

Method

CurlResponse::withAddedHeader

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

Description#

public CurlResponse::withAddedHeader(
    string $name,
    $value
): MessageInterface

Existing values for the specified header will be maintained. The new value(s) will be appended to the existing list. If the header did not exist previously, it will be added.

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 header and/or value.

Parameters#

$name string
Case-insensitive header field name to add.
$value
Header value(s).

Return values#

MessageInterface

Errors / Exceptions#

ExceptionWhen
InvalidArgumentExceptionFor invalid header names or values.