Fr3nch13/CakePHP Utilities

Response extends Message

in package

• Application

implements ResponseInterface uses MessageTrait

Implements methods for HTTP responses.

$val = $response->getHeaderLine('content-type');

$response->getHeaders();

$content = $response->getBody();

$content = $response->getStringBody();

// Get as XML
$content = $response->getXml()
// Get as JSON
$content = $response->getJson()

$content = $response->getStatusCode();

Table of Contents

Interfaces

ResponseInterface

Representation of an outgoing, server-side response.

Constants

METHOD_DELETE  = 'DELETE'

HTTP DELETE method

METHOD_GET  = 'GET'

HTTP GET method

METHOD_HEAD  = 'HEAD'

HTTP HEAD method

METHOD_OPTIONS  = 'OPTIONS'

HTTP OPTIONS method

METHOD_PATCH  = 'PATCH'

HTTP PATCH method

METHOD_POST  = 'POST'

HTTP POST method

METHOD_PUT  = 'PUT'

HTTP PUT method

METHOD_TRACE  = 'TRACE'

HTTP TRACE method

STATUS_ACCEPTED  = 202

HTTP 202 code

STATUS_CREATED  = 201

HTTP 201 code

STATUS_FOUND  = 302

HTTP 302 code

STATUS_MOVED_PERMANENTLY  = 301

HTTP 301 code

STATUS_NO_CONTENT  = 204

HTTP 204 code

STATUS_NON_AUTHORITATIVE_INFORMATION  = 203

HTTP 203 code

STATUS_OK  = 200

HTTP 200 code

STATUS_PERMANENT_REDIRECT  = 308

HTTP 308 code

STATUS_SEE_OTHER  = 303

HTTP 303 code

STATUS_TEMPORARY_REDIRECT  = 307

HTTP 307 code

Properties

$_cookies  : array<string|int, mixed>

The array of cookies in the response.

$_json  : mixed

Cached decoded JSON data.

$_xml  : SimpleXMLElement

Cached decoded XML data.

$code  : int

The status code of the response.

$cookies  : CookieCollection

Cookie Collection instance

$headerNames  : array<string|int, mixed>

Map of normalized header name to original name used to register header.

$headers  : array<string|int, mixed>

List of all registered headers, as key => array of values.

$reasonPhrase  : string

The reason phrase for the status code

$protocol  : string

$stream  : StreamInterface

Methods

__construct()  : mixed

Constructor

cookies()  : array<string|int, mixed>

Get all cookies

getBody()  : StreamInterface

Gets the body of the message.

getCookie()  : array<string|int, mixed>|string|null

Get the value of a single cookie.

getCookieCollection()  : CookieCollection

Get the cookie collection from this response.

getCookieData()  : array<string|int, mixed>|null

Get the full data for a single cookie.

getCookies()  : array<string|int, mixed>

Get the all cookie data.

getEncoding()  : string|null

Get the encoding if it was set.

getHeader()  : array<string|int, string>

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

getHeaderLine()  : string

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

getHeaders()  : array<string|int, mixed>

Retrieves all message headers.

getJson()  : mixed

Get the response body as JSON decoded data.

getProtocolVersion()  : string

Retrieves the HTTP protocol version as a string.

getReasonPhrase()  : string

Gets the response reason phrase associated with the status code.

getStatusCode()  : int

Gets the response status code.

getStringBody()  : string

Get the response body as string.

getXml()  : SimpleXMLElement|null

Get the response body as XML decoded data.

hasHeader()  : bool

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

isOk()  : bool

Check if the response status code was in the 2xx/3xx range

isRedirect()  : bool

Check if the response had a redirect status code.

isSuccess()  : bool

Check if the response status code was in the 2xx range

withAddedHeader()  : static

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

withBody()  : static

Return an instance with the specified message body.

withHeader()  : static

Return an instance with the provided header, replacing any existing values of any headers with the same case-insensitive name.

withoutHeader()  : static

Return an instance without the specified header.

withProtocolVersion()  : static

Return an instance with the specified HTTP protocol version.

withStatus()  : static

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

_decodeGzipBody()  : string

Uncompress a gzip response.

_getBody()  : string

Provides magic __get() support.

_getCookies()  : array<string|int, mixed>

Property accessor for `$this->cookies`

_getHeaders()  : array<string|int, string>

Provides magic __get() support.

_getJson()  : mixed

Get the response body as JSON decoded data.

_getXml()  : SimpleXMLElement|null

Get the response body as XML decoded data.

_parseHeaders()  : void

Parses headers if necessary.

buildCookieCollection()  : void

Lazily build the CookieCollection and cookie objects from the response header

assertHeader()  : void

Ensure header name and values are valid.

filterHeaderValue()  : array<int, string>

getStream()  : StreamInterface

setHeaders()  : void

Filter a set of headers to ensure they are in the correct internal format.

validateProtocolVersion()  : void

Validate the HTTP protocol version

// 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);
    }
}