class HtmlResponse extends TextResponse (View source)

The HtmlResponse 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.

__construct(string $body = '', int $status = 200, array $headers = array())

Constructor.

int
getStatusCode()

Gets the response status code.

from Response
withStatus(int $code, string $reasonPhrase = '')

Return an instance with the specified status code and, optionally, reason phrase.

from Response
string
getReasonPhrase()

Gets the response reason phrase associated with the status code.

from Response
withContentType(string $contentType)

Add Content-Type to header.

Details

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.

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

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.

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.

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.

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.

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.

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.

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

StreamInterface getBody()

Gets the body of the message.

Return Value

StreamInterface Returns the body as a stream.

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.

__construct(string $body = '', int $status = 200, array $headers = array())

Constructor.

Parameters

string $body The body data.
int $status The status code.
array $headers The custom headers.

in Response at line line 85
int getStatusCode()

Gets the response status code.

The status code is a 3-digit integer result code of the server's attempt to understand and satisfy the request.

Return Value

int Status code.

in Response at line line 112
Response withStatus(int $code, string $reasonPhrase = '')

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.

Parameters

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.

Return Value

Response

Exceptions

InvalidArgumentException For invalid status code arguments.

in Response at line line 140
string getReasonPhrase()

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 Structure) for the response's status code.

Return Value

string Reason phrase; must return an empty string if none present.

AbstractContentTypeResponse withContent(string $content)

withContent

Parameters

string $content

Return Value

AbstractContentTypeResponse

Exceptions

InvalidArgumentException

AbstractContentTypeResponse withContentType(string $contentType)

Add Content-Type to header.

Parameters

string $contentType The content type.

Return Value

AbstractContentTypeResponse