JSON-nal való munka

A Nette\Utils\Json egy statikus osztály a JSON formátum kódolására és dekódolására szolgáló funkciókkal. Kezeli a különböző PHP verziók sebezhetőségeit és kivételeket dob hibák esetén.

Telepítés:

composer require nette/utils

Minden példa feltételezi a létrehozott aliast:

use Nette\Utils\Json;

Használat

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

Átalakítja a $value-t JSON formátumba.

Ha a $pretty be van állítva, a JSON-t formázza a könnyebb olvashatóság és áttekinthetőség érdekében:

Json::encode($value); // JSON-t ad vissza
Json::encode($value, pretty: true); // áttekinthetőbb JSON-t ad vissza

Az $asciiSafe esetén a kimenetet ASCII-ben generálja, azaz a unicode karaktereket \uxxxx szekvenciákra cseréli:

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

A $htmlSafe paraméter biztosítja, hogy a kimenet ne tartalmazzon olyan karaktereket, amelyeknek speciális jelentésük van a HTML-ben:

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

A $forceObjects paraméterrel a numerikus kulcsokkal rendelkező tömbök is JavaScript objektumként lesznek kódolva:

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

Hiba esetén Nette\Utils\JsonException kivételt dob.

try {
	$json = Json::encode($value);
} catch (Nette\Utils\JsonException $e) {
	// Kivétel kezelése
}

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

Feldolgozza a JSON-t PHP-ba.

A $forceArray beállítás kikényszeríti a tömbök visszaadását objektumok helyett:

Json::decode('{"variable": true}'); // stdClass típusú objektumot ad vissza
Json::decode('{"variable": true}', forceArrays: true); // tömböt ad vissza

Hiba esetén Nette\Utils\JsonException kivételt dob.

try {
	$value = Json::decode($json);
} catch (Nette\Utils\JsonException $e) {
	// Kivétel kezelése
}

Hogyan küldjünk JSON-t a presenterből?

Erre használható a $this->sendJson($data) metódus, amelyet például az action*() metódusban hívhatunk meg, lásd Válasz küldése.