Praca z JSON

Nette\Utils\Json to klasa statyczna z funkcjami do kodowania i dekodowania formatu JSON. Radzi sobie z podatnościami w różnych wersjach PHP i przy błędach zgłasza wyjątki.

Instalacja:

composer require nette/utils

Wszystkie przykłady zakładają, że zdefiniowany jest następujący alias klasy:

use Nette\Utils\Json;

Użycie

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

Konwertuje $value do formatu JSON.

Ustawienie $pretty na true formatuje JSON dla lepszej czytelności i przejrzystości:

Json::encode($value); // zwraca JSON
Json::encode($value, pretty: true); // zwraca czytelniejszy JSON

Przy $asciiSafe ustawionym na true generuje wynik w ASCII, czyli znaki Unicode zastępowane są sekwencjami \uxxxx:

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

Parametr $htmlSafe zapewnia, że wynik nie zawiera znaków o specjalnym znaczeniu w HTML:

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

Przy $forceObjects ustawionym na true nawet tablice z kluczami liczbowymi zostaną zakodowane jako obiekty JavaScriptu:

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

Przy błędzie zgłasza Nette\Utils\JsonException.

try {
	$json = Json::encode($value);
} catch (Nette\Utils\JsonException $e) {
	// obsługa wyjątku
}

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

Parsuje string JSON do wartości PHP.

Ustawienie $forceArrays na true wymusza zwracanie tablic zamiast obiektów:

Json::decode('{"variable": true}'); // zwraca obiekt typu stdClass
Json::decode('{"variable": true}', forceArrays: true); // zwraca tablicę

Przy błędzie zgłasza Nette\Utils\JsonException.

try {
	$value = Json::decode($json);
} catch (Nette\Utils\JsonException $e) {
	// obsługa wyjątku
}

Jak wysłać JSON z presentera?

Możesz użyć metody $this->sendJson($data), którą można wywołać na przykład wewnątrz metody action*(). Zobacz Wysyłanie odpowiedzi.