HTTP messages consist of requests from a client to a server and responses from a server to a client. This interface defines the methods common to each.
Messages 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.
TagsGets the body of the message.
public getBody() : StreamInterface Return valuesStreamInterface —
Returns the body as a stream.
Retrieves a message header value by the given case-insensitive name.
public getHeader(string $name) : array<string|int, string>
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.
ParametersCase-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.
Retrieves a comma-separated string of the values for a single header.
public getHeaderLine(string $name) : string
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.
ParametersCase-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.
Retrieves all message header values.
public getHeaders() : array<string|int, array<string|int, string>>
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.
Return valuesarray<string|int, array<string|int, string>> —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.
getProtocolVersion()Retrieves the HTTP protocol version as a string.
public getProtocolVersion() : string
The string MUST contain only the HTTP version number (e.g., "1.1", "1.0").
Return valuesstring —HTTP protocol version.
Checks if a header exists by the given case-insensitive name.
public hasHeader(string $name) : bool Parameters
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.
Return an instance with the specified header appended with the given value.
public withAddedHeader(string $name, string|array<string|int, string> $value) : static
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.
ParametersCase-insensitive header field name to add.
Header value(s).
for invalid header names or values.
Return an instance with the specified message body.
public withBody(StreamInterface $body) : static
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.
ParametersBody.
When the body is not valid.
Return an instance with the provided value replacing the specified header.
public withHeader(string $name, string|array<string|int, string> $value) : static
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.
ParametersCase-insensitive header field name.
Header value(s).
for invalid header names or values.
Return an instance without the specified header.
public withoutHeader(string $name) : static
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.
ParametersCase-insensitive header field name to remove.
Return an instance with the specified HTTP protocol version.
public withProtocolVersion(string $version) : static
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.
ParametersHTTP protocol version
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4