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.
Methods |
public
abstract
getBody
() |
public
abstract
getHeader
(
$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 If the header does not appear in the message, this method MUST return an
|
public
abstract
getHeaderLine
(
$name
) Retrieves a comma-separated string of the values for a single header. This method returns all of the header values of the given NOTE: Not all header values may be appropriately represented using If the header does not appear in the message, this method MUST return
|
public
abstract
getHeaders
() Retrieves all message header values. The keys represent the header name as it will be sent over the wire, and
While header names are not case-sensitive, getHeaders() will preserve the
|
public
abstract
getProtocolVersion
() Retrieves the HTTP protocol version as a string. The string MUST contain only the HTTP version number (e.g., "1.1", "1.0").
|
public
abstract
hasHeader
(
$name
) Checks if a header exists by the given case-insensitive name.
|
public
abstract
withAddedHeader
(
$name
,
$value
) Return an instance with the specified header appended with the given value. Existing values for the specified header will be maintained. The new This method MUST be implemented in such a way as to retain the
|
public
abstract
withBody
(
Psr\Http\Message\StreamInterface
$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
|
public
abstract
withHeader
(
$name
,
$value
) Return an instance with the provided value replacing the specified header. While header names are case-insensitive, the casing of the header will This method MUST be implemented in such a way as to retain the
|
public
abstract
withoutHeader
(
$name
) 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
|
public
abstract
withProtocolVersion
(
$version
) Return an instance with the specified HTTP protocol version. The version string MUST contain only the HTTP version number (e.g., This method MUST be implemented in such a way as to retain the
|