class AbstractMessage implements MessageInterface (View source)

The AbstractMessage class.

Methods

string
getProtocolVersion()

Retrieves the HTTP protocol version as a string.

withProtocolVersion(string $version)

Return an instance with the specified HTTP protocol version.

array
getHeaders()

Retrieves all message header values.

bool
hasHeader(string $name)

Checks if a header exists by the given case-insensitive name.

string[]
getHeader(string $name)

Retrieves a message header value by the given case-insensitive name.

string
getHeaderLine(string $name)

Retrieves a comma-separated string of the values for a single header.

withHeader(string $name, string|string[] $value)

Return an instance with the provided value replacing the specified header.

withAddedHeader(string $name, mixed $value)

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

withoutHeader(string $name)

Return an instance without the specified header.

StreamInterface
getBody()

Gets the body of the message.

withBody(StreamInterface $body)

Return an instance with the specified message body.

Details

at line line 57
string getProtocolVersion()

Retrieves the HTTP protocol version as a string.

The string MUST contain only the HTTP version number (e.g., "1.1", "1.0").

Return Value

string HTTP protocol version.

at line line 76
AbstractMessage withProtocolVersion(string $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

string $version HTTP protocol version

Return Value

AbstractMessage

at line line 127
array getHeaders()

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.

Return Value

array 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.

at line line 141
bool hasHeader(string $name)

Checks if a header exists by the given case-insensitive name.

Parameters

string $name Case-insensitive header field name.

Return Value

bool 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.

at line line 161
string[] getHeader(string $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

string $name Case-insensitive header field name.

Return Value

string[] 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.

at line line 193
string getHeaderLine(string $name)

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

string $name Case-insensitive header field name.

Return Value

string 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.

at line line 221
AbstractMessage withHeader(string $name, string|string[] $value)

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

string $name Case-insensitive header field name.
string|string[] $value Header value(s).

Return Value

AbstractMessage

Exceptions

InvalidArgumentException for invalid header names or values.

at line line 247
AbstractMessage withAddedHeader(string $name, mixed $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

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

Return Value

AbstractMessage

Exceptions

InvalidArgumentException for invalid header names or values.

at line line 288
AbstractMessage withoutHeader(string $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 immutability of the message, and MUST return an instance that removes the named header.

Parameters

string $name Case-insensitive header field name to remove.

Return Value

AbstractMessage

at line line 310
StreamInterface getBody()

Gets the body of the message.

Return Value

StreamInterface Returns the body as a stream.

at line line 329
AbstractMessage withBody(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 immutability of the message, and MUST return a new instance that has the new body stream.

Parameters

StreamInterface $body Body.

Return Value

AbstractMessage

Exceptions

InvalidArgumentException When the body is not valid.