XmlResponse
class XmlResponse extends TextResponse (View source)
The XmlResponse class.
Methods
Return an instance with the specified HTTP protocol version.
Checks if a header exists by the given case-insensitive name.
Retrieves a message header value by the given case-insensitive name.
Retrieves a comma-separated string of the values for a single header.
Return an instance with the provided value replacing the specified header.
Return an instance with the specified header appended with the given value.
Return an instance without the specified header.
Return an instance with the specified message body.
Constructor.
Return an instance with the specified status code and, optionally, reason phrase.
Gets the response reason phrase associated with the status code.
withContent
Add Content-Type to header.
Details
in AbstractMessage 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").
in AbstractMessage 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.
in 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.
in AbstractMessage at line line 141
bool
hasHeader(string $name)
Checks if a header exists by the given case-insensitive name.
in AbstractMessage 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.
in AbstractMessage 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.
in AbstractMessage 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.
in AbstractMessage 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.
in AbstractMessage 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.
in AbstractMessage at line line 310
StreamInterface
getBody()
Gets the body of the message.
in AbstractMessage 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.
at line line 32
__construct(string $xml = '', int $status = 200, array $headers = array())
Constructor.
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.
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.
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.
in AbstractContentTypeResponse at line line 60
AbstractContentTypeResponse
withContent(string $content)
withContent
in AbstractContentTypeResponse at line line 72
AbstractContentTypeResponse
withContentType(string $contentType)
Add Content-Type to header.