getProtocolVersion()
getProtocolVersion() : 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
string —HTTP protocol version.
Representation of an outgoing, server-side response.
Per the HTTP specification, this interface includes properties for each of the following:
Responses 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.
withProtocolVersion(string $version) : static
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.
| string | $version | HTTP protocol version |
getHeaders() : string[][]
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 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.
hasHeader(string $name) : bool
Checks if a header exists by the given case-insensitive name.
| string | $name | Case-insensitive header field name. |
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.
getHeader(string $name) : string[]
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.
| string | $name | Case-insensitive header field name. |
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.
getHeaderLine(string $name) : string
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.
| string | $name | Case-insensitive header field name. |
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.
withHeader(string $name, string|string[] $value) : static
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.
| string | $name | Case-insensitive header field name. |
| string|string[] | $value | Header value(s). |
for invalid header names or values.
withAddedHeader(string $name, string|string[] $value) : static
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.
| string | $name | Case-insensitive header field name to add. |
| string|string[] | $value | Header value(s). |
for invalid header names or values.
withoutHeader(string $name) : static
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.
| string | $name | Case-insensitive header field name to remove. |
withBody(\Psr\Http\Message\StreamInterface $body) : static
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.
| \Psr\Http\Message\StreamInterface | $body | Body. |
When the body is not valid.
withStatus(int $code, string $reasonPhrase = '') : static
Return an instance with the specified status code and, optionally, reason phrase.
If no reason phrase is specified, implementations MAY choose to default to the RFC 7231 or IANA recommended reason phrase for the response's status code.
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 updated status and reason phrase.
| int | $code | The 3-digit integer result code to set. |
| string | $reasonPhrase | The reason phrase to use with the provided status code; if none is provided, implementations MAY use the defaults as suggested in the HTTP specification. |
For invalid status code arguments.
getReasonPhrase() : string
Gets the response reason phrase associated with the status code.
Because a reason phrase is not a required element in a response status line, the reason phrase value MAY be null. Implementations MAY choose to return the default RFC 7231 recommended reason phrase (or those listed in the IANA HTTP Status Code Registry) for the response's status code.
Reason phrase; must return an empty string if none present.