Работа с JSON

Nette\Utils\Json – это статический класс с функциями для кодирования и декодирования формата JSON. Он обрабатывает уязвимости различных версий PHP и выбрасывает исключения при ошибках.

Установка:

composer require nette/utils

Все примеры предполагают, что создан псевдоним:

use Nette\Utils\Json;

Использование

encode (mixed $value, bool $pretty=false, bool $asciiSafe=false, bool $htmlSafe=false, bool $forceObjects=false): string

Преобразует $value в формат JSON.

При установке $pretty форматирует JSON для облегчения чтения и наглядности:

Json::encode($value); // возвращает JSON
Json::encode($value, pretty: true); // возвращает более читаемый JSON

При $asciiSafe генерирует вывод в ASCII, т.е. символы unicode заменяются последовательностями \uxxxx:

Json::encode('žluťoučký', asciiSafe: true);
// '"\u017elu\u0165ou\u010dk\u00fd"'

Параметр $htmlSafe гарантирует, что вывод не будет содержать символов, имеющих специальное значение в HTML:

Json::encode('one<two & three', htmlSafe: true);
// '"one\u003Ctwo \u0026 three"'

С $forceObjects даже массивы с числовыми ключами будут кодироваться как объекты JavaScript:

Json::encode(['a', 'b', 'c']);
// '["a","b","c"]'
Json::encode(['a', 'b', 'c'], forceObjects: true);
// '{"0":"a","1":"b","2":"c"}'

При ошибке выбрасывает исключение Nette\Utils\JsonException.

try {
	$json = Json::encode($value);
} catch (Nette\Utils\JsonException $e) {
	// Обработка исключения
}

decode (string $json, bool $forceArray=false): mixed

Парсит JSON в PHP.

Установка $forceArray заставляет возвращать массивы вместо объектов:

Json::decode('{"variable": true}'); // возвращает объект типа stdClass
Json::decode('{"variable": true}', forceArrays: true); // возвращает массив

При ошибке выбрасывает исключение Nette\Utils\JsonException.

try {
	$value = Json::decode($json);
} catch (Nette\Utils\JsonException $e) {
	// Обработка исключения
}

Как отправить JSON из презентера?

Для этого можно использовать метод $this->sendJson($data), который можно вызвать, например, в методе action*(), см. Отправка ответа.