TYPO3 12.4 API: JsonResponse

JsonResponse extends Response

Standard values for a JSON response

Highly inspired by ZF zend-diactoros

Internal

Note that this is not public API, use PSR-17 interfaces instead

Constants

DEFAULT_JSON_FLAGS = JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT | JSON_UNESCAPED_SLASHES: Default flags for json_encode; value of:

Properties

$availableStatusCodes : array<string|int, mixed>: The standardized and other important HTTP Status Codes
$body : StreamInterface|null: The body as a Stream object
$headers : array<string|int, mixed>: Associative array containing all headers of this Message This is a mixed-case list of the headers (as due to the specification)
$lowercasedHeaderNames : array<string|int, mixed>: Lowercased version of all headers, in order to check if a header is set or not this way a lot of checks are easier to be set
$protocolVersion : string: The HTTP Protocol version, defaults to 1.1
$reasonPhrase : string: The reason phrase of the response
$statusCode : int: The HTTP status code of the response

Methods

__construct() : mixed: Create a JSON response with the given data.
filter() : string: Filter a header value
getBody() : StreamInterface: Gets the body of the message.
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 header values.
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.
isValidHeaderValue() : bool: Checks if an HTTP header value is valid.
setPayload() : JsonResponse: Overrides the exiting content, takes an array as input
validateHeaderName() : void: Check whether a header name is valid and throw an exception.
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 value replacing the specified header.
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.
arrayContainsOnlyStrings() : bool: Helper function to test if an array contains only strings
assertHeaders() : void: Ensure header names and values are valid.
filterHeaders() : array<string|int, mixed>: Filter a set of headers to ensure they are in the correct internal format.
validateHeaderValues() : void: Assert that the provided header values are valid.

DEFAULT_JSON_FLAGS

Default flags for json_encode; value of:


    public
        int
    DEFAULT_JSON_FLAGS
    = JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT | JSON_UNESCAPED_SLASHES


JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT | JSON_UNESCAPED_SLASHES

$availableStatusCodes

The standardized and other important HTTP Status Codes


    protected
        array<string|int, mixed>
    $availableStatusCodes
     = [
    // 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
    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 => 'Payload 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 Entity',
    423 => 'Locked',
    424 => 'Failed Dependency',
    425 => 'Unordered Collection',
    426 => 'Upgrade Required',
    428 => 'Precondition Required',
    429 => 'Too Many Requests',
    431 => 'Request Header Fields Too Large',
    451 => 'Unavailable For Legal Reasons',
    // SERVER ERROR
    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',
    509 => 'Bandwidth Limit Exceeded',
    510 => 'Not Extended',
    511 => 'Network Authentication Required',
]

$body

The body as a Stream object


    protected
        StreamInterface|null
    $body
     = null

$headers

Associative array containing all headers of this Message This is a mixed-case list of the headers (as due to the specification)


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

$lowercasedHeaderNames

Lowercased version of all headers, in order to check if a header is set or not this way a lot of checks are easier to be set


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

$protocolVersion

The HTTP Protocol version, defaults to 1.1


    protected
        string
    $protocolVersion
     = '1.1'

$reasonPhrase

The reason phrase of the response


    protected
        string
    $reasonPhrase
     = ''

$statusCode

The HTTP status code of the response


    protected
        int
    $statusCode

__construct()

Create a JSON response with the given data.


    public
                    __construct([array<string|int, mixed>|null $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 : array<string|int, mixed>|null = []: 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.

filter()

Filter a header value


    public
                    filter(string $value) : string

Ensures CRLF header injection vectors are filtered.

Per RFC 7230, only VISIBLE ASCII characters, spaces, and horizontal tabs are allowed in values; header continuations MUST consist of a single CRLF sequence followed by a space or horizontal tab.

This method filters any values not allowed from the string, and is lossy.

Parameters

$value : string

Return values

string

getBody()

Gets the body of the message.


    public
                    getBody() : StreamInterface

Return values

StreamInterface —

Returns the body as a stream.

getHeader()

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


    public
                    getHeader(string $name) : 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

$name : 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 header values.


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

While header names are not case-sensitive, getHeaders() will preserve the exact case in which headers were originally specified.

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 for that header.

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

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

Return values

string —

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

getStatusCode()

Gets the response status code.


    public
                    getStatusCode() : int

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

Return values

int —

Status code.

hasHeader()

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


    public
                    hasHeader(string $name) : bool

Parameters

$name : string: Case-insensitive header field 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.

isValidHeaderValue()

Checks if an HTTP header value is valid.


    public
                    isValidHeaderValue(string $value) : bool

Per RFC 7230, only VISIBLE ASCII characters, spaces, and horizontal tabs are allowed in values; header continuations MUST consist of a single CRLF sequence followed by a space or horizontal tab.

Parameters

$value : string

Return values

bool

setPayload()

Overrides the exiting content, takes an array as input


    public
                    setPayload([array<string|int, mixed> $data = [] ][, int $encodingOptions = self::DEFAULT_JSON_FLAGS ]) : JsonResponse

Parameters

$data : array<string|int, mixed> = []
$encodingOptions : int = self::DEFAULT_JSON_FLAGS

Return values

JsonResponse

validateHeaderName()

Check whether a header name is valid and throw an exception.


    public
                    validateHeaderName(string $name) : void

Parameters

$name : string

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

Return values

static

withHeader()

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


    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

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(int $code[, string $reasonPhrase = '' ]) : static

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

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

arrayContainsOnlyStrings()

Helper function to test if an array contains only strings


    protected
                    arrayContainsOnlyStrings(array<string|int, mixed> $data) : bool

Parameters

$data : array<string|int, mixed>

Return values

bool

assertHeaders()

Ensure header names and values are valid.


    protected
                    assertHeaders(array<string|int, mixed> $headers) : void

Parameters

$headers : array<string|int, mixed>

filterHeaders()

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


    protected
                    filterHeaders(array<string|int, mixed> $originalHeaders) : array<string|int, mixed>

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

Parameters

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

Return values

array<string|int, mixed> —

Filtered headers and names.

validateHeaderValues()

Assert that the provided header values are valid.


    protected
                    validateHeaderValues(array<string|int, string> $values) : void

Parameters

$values : array<string|int, string>

JsonResponse extends Response

Table of Contents

Constants

Properties

Methods

Constants

DEFAULT_JSON_FLAGS

Properties

$availableStatusCodes

$body

$headers

$lowercasedHeaderNames

$protocolVersion

$reasonPhrase

$statusCode

Methods

__construct()

Parameters

filter()

Parameters

Tags

Return values

getBody()

Return values

getHeader()

Parameters

Return values

getHeaderLine()

Parameters

Return values

getHeaders()

Return values

getProtocolVersion()

Return values

getReasonPhrase()

Tags

Return values

getStatusCode()

Return values

hasHeader()

Parameters

Return values

isValidHeaderValue()

Parameters

Tags

Return values

setPayload()

Parameters

Return values

validateHeaderName()

Parameters

Tags

withAddedHeader()

Parameters

Tags

Return values

withBody()

Parameters

Tags

Return values

withHeader()

Parameters

Tags

Return values

withoutHeader()

Parameters

Return values

withProtocolVersion()

Parameters

Return values

withStatus()

Parameters

Tags

Return values

arrayContainsOnlyStrings()

Parameters

Return values

assertHeaders()

Parameters

Tags