| Methods |
public
|
getProtocolVersion(): string
Retrieves the HTTP protocol version as a string.
Retrieves the HTTP protocol version as a string.
The string MUST contain only the HTTP version number (e.g., "1.1", "1.0").
Returns
|
#
|
public
|
withProtocolVersion(string $version): static
Return an instance with the specified HTTP protocol version.
Return an instance with the specified HTTP protocol version.
The version string MUST contain only the HTTP version number (e.g.,
"1.1", "1.0").
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 protocol version.
Parameters
| $version |
HTTP protocol version
|
|
#
|
public
|
getHeaders(): string[][]
Retrieves all message header values.
Retrieves all message header values.
The keys represent the header name as it will be sent over the wire, and
each value is an array of strings associated with the header.
// Represent the headers as a string
foreach ($message->getHeaders() as $name => $values) {
echo $name . ": " . implode(", ", $values);
}
// Emit headers iteratively:
foreach ($message->getHeaders() as $name => $values) {
foreach ($values as $value) {
header(sprintf('%s: %s', $name, $value), false);
}
}
While header names are not case-sensitive, getHeaders() will preserve the
exact case in which headers were originally specified.
Returns
Returns an associative array of the message's headers. Each
key MUST be a header name, and each value MUST be an array of strings
for that header.
|
#
|
public
|
hasHeader(string $name): bool
Checks if a header exists by the given case-insensitive name.
Checks if a header exists by the given case-insensitive name.
Parameters
| $name |
Case-insensitive header field name.
|
Returns
Returns true if any header names match the given header
name using a case-insensitive string comparison. Returns false if
no matching header name is found in the message.
|
#
|
public
|
getHeader(string $name): string[]
Retrieves a message header value by the given case-insensitive name.
Retrieves a message header value by the given case-insensitive name.
This method returns an array of all the header values of the given
case-insensitive header name.
If the header does not appear in the message, this method MUST return an
empty array.
Parameters
| $name |
Case-insensitive header field name.
|
Returns
An array of string values as provided for the given
header. If the header does not appear in the message, this method MUST
return an empty array.
|
#
|
public
|
getHeaderLine(string $name): string
Retrieves a comma-separated string of the values for a single header.
Retrieves a comma-separated string of the values for a single header.
This method returns all of the header values of the given
case-insensitive header name as a string concatenated together using
a comma.
NOTE: Not all header values may be appropriately represented using
comma concatenation. For such headers, use getHeader() instead
and supply your own delimiter when concatenating.
If the header does not appear in the message, this method MUST return
an empty string.
Parameters
| $name |
Case-insensitive header field name.
|
Returns
A string of values as provided for the given header
concatenated together using a comma. If the header does not appear in
the message, this method MUST return an empty string.
|
#
|
public
|
withHeader(string $name, string|string[] $value): static
Return an instance with the provided value replacing the specified header.
Return an instance with the provided value replacing the specified header.
While header names are case-insensitive, the casing of the header will
be preserved by this function, and returned from getHeaders().
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 and/or updated header and value.
Parameters
| $name |
Case-insensitive header field name.
|
| $value |
Header value(s).
|
Throws
|
#
|
public
|
withAddedHeader(string $name, string|string[] $value): static
Return an instance with the specified header appended with the given value.
Return an instance with the specified header appended with the given value.
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 |
Case-insensitive header field name to add.
|
| $value |
Header value(s).
|
Throws
|
#
|
public
|
withoutHeader(string $name): static
Return an instance without the specified header.
Return an instance without the specified header.
Header resolution MUST be done without case-sensitivity.
This method MUST be implemented in such a way as to retain the
immutability of the message, and MUST return an instance that removes
the named header.
Parameters
| $name |
Case-insensitive header field name to remove.
|
|
#
|
public
|
getBody(): StreamInterface
Gets the body of the message.
Gets the body of the message.
Returns
Returns the body as a stream.
|
#
|
public
|
withBody(StreamInterface $body): static
Return an instance with the specified message body.
Return an instance with the specified message body.
The body MUST be a StreamInterface object.
This method MUST be implemented in such a way as to retain the
immutability of the message, and MUST return a new instance that has the
new body stream.
Parameters
Throws
|
#
|