Fr3nch13/CakePHP Utilities

JsonResponse extends Response
in package

Application

uses InjectContentTypeTrait

JSON response.

Allows creating a response by passing data to the constructor; by default, serializes the data to JSON, sets a status code of 200 and sets the Content-Type header to application/json.

Constants

DEFAULT_JSON_FLAGS = \JSON_HEX_TAG | \JSON_HEX_APOS | \JSON_HEX_AMP | \JSON_HEX_QUOT | \JSON_UNESCAPED_SLASHES: Default flags for json_encode
MAX_STATUS_CODE_VALUE = 599
MIN_STATUS_CODE_VALUE = 100

Properties

$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.
$encodingOptions : int
$payload : mixed
$phrases : array<string|int, mixed>: Map of standard HTTP status code/reason phrases
$protocol : string
$reasonPhrase : string
$statusCode : int
$stream : StreamInterface

Methods

__construct() : mixed: Create a JSON response with the given data.
getBody() : StreamInterface: Gets the body of the message.
getEncodingOptions() : int
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.
getPayload() : mixed
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.
hasHeader() : bool: Checks if a header exists by the given case-insensitive name.
withAddedHeader() : static: Return an instance with the specified header appended with the given value.
withBody() : static: Return an instance with the specified message body.
withEncodingOptions() : JsonResponse
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.
withPayload() : JsonResponse
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.
assertHeader() : void: Ensure header name and values are valid.
createBodyFromJson() : Stream
filterHeaderValue() : array<int, string>
getStream() : StreamInterface
injectContentType() : array<string|int, mixed>: Inject the provided Content-Type, if none is already present.
jsonEncode() : string: Encode the provided data to JSON.
setHeaders() : void: Filter a set of headers to ensure they are in the correct internal format.
setPayload() : void
setStatusCode() : void: Set a valid status code.
updateBodyFor() : JsonResponse: Update the response body for the given instance.
validateProtocolVersion() : void: Validate the HTTP protocol version

DEFAULT_JSON_FLAGS

Default flags for json_encode


    public
        mixed
    DEFAULT_JSON_FLAGS
    = \JSON_HEX_TAG | \JSON_HEX_APOS | \JSON_HEX_AMP | \JSON_HEX_QUOT | \JSON_UNESCAPED_SLASHES

MAX_STATUS_CODE_VALUE


    public
        mixed
    MAX_STATUS_CODE_VALUE
    = 599

MIN_STATUS_CODE_VALUE


    public
        mixed
    MIN_STATUS_CODE_VALUE
    = 100

$headerNames

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


    protected
        array<string|int, mixed>
    $headerNames
     = []

$headers

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


    protected
        array<string|int, mixed>
    $headers
     = []

$encodingOptions


    private
        int
    $encodingOptions
     = self::DEFAULT_JSON_FLAGS

$payload


    private
        mixed
    $payload

$phrases

Map of standard HTTP status code/reason phrases


    private
        array<string|int, mixed>
    $phrases
     = [
    // INFORMATIONAL CODES
    100 => 'Continue',
    101 => 'Switching Protocols',
    102 => 'Processing',
    103 => 'Early Hints',
    // SUCCESS CODES
    200 => 'OK',
    201 => 'Created',
    202 => 'Accepted',
    203 => 'Non-Authoritative Information',
    204 => 'No Content',
    205 => 'Reset Content',
    206 => 'Partial Content',
    207 => 'Multi-Status',
    208 => 'Already Reported',
    226 => 'IM Used',
    // REDIRECTION CODES
    300 => 'Multiple Choices',
    301 => 'Moved Permanently',
    302 => 'Found',
    303 => 'See Other',
    304 => 'Not Modified',
    305 => 'Use Proxy',
    306 => 'Switch Proxy',
    // Deprecated to 306 => '(Unused)'
    307 => 'Temporary Redirect',
    308 => 'Permanent Redirect',
    // CLIENT ERROR
    400 => 'Bad Request',
    401 => 'Unauthorized',
    402 => 'Payment Required',
    403 => 'Forbidden',
    404 => 'Not Found',
    405 => 'Method Not Allowed',
    406 => 'Not Acceptable',
    407 => 'Proxy Authentication Required',
    408 => 'Request Timeout',
    409 => 'Conflict',
    410 => 'Gone',
    411 => 'Length Required',
    412 => 'Precondition Failed',
    413 => 'Content Too Large',
    414 => 'URI Too Long',
    415 => 'Unsupported Media Type',
    416 => 'Range Not Satisfiable',
    417 => 'Expectation Failed',
    418 => 'I\'m a teapot',
    421 => 'Misdirected Request',
    422 => 'Unprocessable Content',
    423 => 'Locked',
    424 => 'Failed Dependency',
    425 => 'Too Early',
    426 => 'Upgrade Required',
    428 => 'Precondition Required',
    429 => 'Too Many Requests',
    431 => 'Request Header Fields Too Large',
    444 => 'Connection Closed Without Response',
    451 => 'Unavailable For Legal Reasons',
    // SERVER ERROR
    499 => 'Client Closed Request',
    500 => 'Internal Server Error',
    501 => 'Not Implemented',
    502 => 'Bad Gateway',
    503 => 'Service Unavailable',
    504 => 'Gateway Timeout',
    505 => 'HTTP Version Not Supported',
    506 => 'Variant Also Negotiates',
    507 => 'Insufficient Storage',
    508 => 'Loop Detected',
    510 => 'Not Extended (OBSOLETED)',
    511 => 'Network Authentication Required',
    599 => 'Network Connect Timeout Error',
]

$protocol


    private
        string
    $protocol
     = '1.1'

$reasonPhrase


    private
        string
    $reasonPhrase

$statusCode


    private
        int
    $statusCode

$stream


    private
        StreamInterface
    $stream

__construct()

Create a JSON response with the given data.


    public
                    __construct(mixed $data[, int $status = 200 ][, array<string|int, mixed> $headers = [] ][, int $encodingOptions = self::DEFAULT_JSON_FLAGS ]) : mixed

Default JSON encoding is performed with the following options, which produces RFC4627-compliant JSON, capable of embedding into HTML.

JSON_HEX_TAG
JSON_HEX_APOS
JSON_HEX_AMP
JSON_HEX_QUOT
JSON_UNESCAPED_SLASHES

Parameters

$data : mixed: Data to convert to JSON.
$status : int = 200: Integer status code for the response; 200 by default.
$headers : array<string|int, mixed> = []: Array of headers to use at initialization.
$encodingOptions : int = self::DEFAULT_JSON_FLAGS: JSON encoding options to use.

getBody()

Gets the body of the message.


    public
                    getBody() : StreamInterface

Return values

StreamInterface —

Returns the body as a stream.

getEncodingOptions()


    public
                    getEncodingOptions() : int

Return values

int

getHeader()

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


    public
                    getHeader(string $header) : array<string|int, string>

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

$header : string: Case-insensitive header field name.

Return values

array<string|int, 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.

getHeaderLine()

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


    public
                    getHeaderLine(string $name) : string

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

$name : string: Case-insensitive header field name.

Return values

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.

getHeaders()

Retrieves all message headers.


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

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

Return values

array<string|int, mixed> —

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.

getPayload()


    public
                    getPayload() : mixed

getProtocolVersion()

Retrieves the HTTP protocol version as a string.


    public
                    getProtocolVersion() : string

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

Return values

string —

HTTP protocol version.

getReasonPhrase()

Gets the response reason phrase associated with the status code.


    public
                    getReasonPhrase() : string

Return values

string —

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

getStatusCode()

Gets the response status code.


    public
                    getStatusCode() : int

Return values

int —

Status code.

hasHeader()

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


    public
                    hasHeader(string $header) : bool

Parameters

$header : string: Case-insensitive header name.

Return values

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.

withAddedHeader()

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


    public
                    withAddedHeader(string $name, string|array<string|int, string> $value) : static

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

$name : string: Case-insensitive header field name to add.
$value : string|array<string|int, string>: Header value(s).

Return values

static

withBody()

Return an instance with the specified message body.


    public
                    withBody(StreamInterface $body) : static

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

$body : StreamInterface: Body.

Return values

static

withEncodingOptions()


    public
                    withEncodingOptions(int $encodingOptions) : JsonResponse

Parameters

$encodingOptions : int

Return values

JsonResponse

withHeader()

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


    public
                    withHeader(string $name, string|array<string|int, string> $value) : static

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

$name : string: Case-insensitive header field name.
$value : string|array<string|int, string>: Header value(s).

Return values

static

withoutHeader()

Return an instance without the specified header.


    public
                    withoutHeader(string $name) : static

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

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

Return values

static

withPayload()


    public
                    withPayload(mixed $data) : JsonResponse

Parameters

$data : mixed

Return values

JsonResponse

withProtocolVersion()

Return an instance with the specified HTTP protocol version.


    public
                    withProtocolVersion(string $version) : static

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

$version : string: HTTP protocol version

Return values

static

withStatus()

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


    public
                    withStatus(mixed $code[, mixed $reasonPhrase = '' ]) : static

Parameters

$code : mixed: The 3-digit integer result code to set.
$reasonPhrase : mixed = '': 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 values

static

assertHeader()

Ensure header name and values are valid.


    private
                    assertHeader(string $name) : void

Parameters

$name : string

createBodyFromJson()


    private
                    createBodyFromJson(string $json) : Stream

Parameters

$json : string

Return values

Stream

filterHeaderValue()


    private
                    filterHeaderValue(mixed $values) : array<int, string>

Parameters

$values : mixed

Return values

array<int, string>

getStream()


    private
                    getStream(StreamInterface|string|resource $stream, string $modeIfNotInstance) : StreamInterface

Parameters

$stream : StreamInterface|string|resource
$modeIfNotInstance : string

Return values

StreamInterface

injectContentType()

Inject the provided Content-Type, if none is already present.


    private
                    injectContentType(string $contentType, array<string|int, mixed> $headers) : array<string|int, mixed>

Parameters

$contentType : string
$headers : array<string|int, mixed>

Return values

array<string|int, mixed> —

Headers with injected Content-Type

jsonEncode()

Encode the provided data to JSON.


    private
                    jsonEncode(mixed $data, int $encodingOptions) : string

Parameters

$data : mixed
$encodingOptions : int

Return values

string

setHeaders()

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


    private
                    setHeaders(array<string|int, mixed> $originalHeaders) : void

Used by message constructors to allow setting all initial headers at once.

Parameters

$originalHeaders : array<string|int, mixed>: Headers to filter.

setPayload()


    private
                    setPayload(mixed $data) : void

Parameters

$data : mixed

setStatusCode()

Set a valid status code.


    private
                    setStatusCode(int $code[, string $reasonPhrase = '' ]) : void

Parameters

$code : int
$reasonPhrase : string = ''

updateBodyFor()

Update the response body for the given instance.


    private
                    updateBodyFor(self $toUpdate) : JsonResponse

Parameters

$toUpdate : self: Instance to update.

Return values

JsonResponse —

Returns a new instance with an updated body.

validateProtocolVersion()

Validate the HTTP protocol version


    private
                    validateProtocolVersion(string $version) : void

Parameters

$version : string

JsonResponse extends Response in package Application uses InjectContentTypeTrait

Table of Contents

Constants

Properties

Methods

Constants

DEFAULT_JSON_FLAGS

Tags

MAX_STATUS_CODE_VALUE

MIN_STATUS_CODE_VALUE

Properties

$headerNames

Tags

$headers

Tags

$encodingOptions

$payload

$phrases

Tags

$protocol

$reasonPhrase

$statusCode

$stream

Methods

__construct()

Parameters

Tags

getBody()

Return values

getEncodingOptions()

Return values

getHeader()

Parameters

Return values

getHeaderLine()

Parameters

Return values

getHeaders()

Tags

Return values

getPayload()

getProtocolVersion()

Return values

getReasonPhrase()

Return values

getStatusCode()

Return values

hasHeader()

Parameters

Return values

withAddedHeader()

Parameters

Tags

Return values

withBody()

Parameters

Tags

Return values

withEncodingOptions()

Parameters

Return values

withHeader()

Parameters

Tags

Return values

withoutHeader()

Parameters

Return values

withPayload()

Parameters

Return values

withProtocolVersion()

Parameters

Return values

withStatus()

Parameters

Return values

assertHeader()

Parameters

Tags

JsonResponse extends Response
in package

Application

uses InjectContentTypeTrait