JsonResponse.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Core\Http;
 
class ‪JsonResponse extends ‪Response
{
    public const ‪DEFAULT_JSON_FLAGS = JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT | JSON_UNESCAPED_SLASHES;
 
    public function ‪__construct(
        ?array $data = [],
        int $status = 200,
        array ‪$headers = [],
        int $encodingOptions = self::DEFAULT_JSON_FLAGS
    ) {
        ‪$body = new ‪Stream('php://temp', 'wb+');
        parent::__construct(‪$body, $status, ‪$headers);
 
        if ($data !== null) {
            $this->‪setPayload($data, $encodingOptions);
        }
 
        // Ensure that application/json header is set, if Content-Type was not set before
        if (!$this->‪hasHeader('Content-Type')) {
            $this->headers['Content-Type'][] = 'application/json; charset=utf-8';
            $this->lowercasedHeaderNames['content-type'] = 'Content-Type';
        }
    }
 
    public function ‪setPayload(array $data = [], int $encodingOptions = self::DEFAULT_JSON_FLAGS): ‪JsonResponse
    {
        $this->body->write($this->‪jsonEncode($data, $encodingOptions));
        $this->body->rewind();
        return $this;
    }
 
    private function ‪jsonEncode(array $data, int $encodingOptions): string
    {
        // Clear json_last_error()
        json_encode(null);
        $json = json_encode($data, $encodingOptions);
        if (json_last_error() !== JSON_ERROR_NONE) {
            throw new \InvalidArgumentException(sprintf(
                'Unable to encode data to JSON in %s: %s',
                __CLASS__,
                json_last_error_msg()
            ), 1504972434);
        }
        return $json;
    }
}