Arbeiten mit JSON

Nette\Utils\Json ist eine statische Klasse mit Funktionen zum Kodieren und Dekodieren des JSON-Formats. Sie behebt Sicherheitslücken verschiedener PHP-Versionen und wirft im Fehlerfall Exceptions.

Installation:

composer require nette/utils

Alle Beispiele setzen voraus, dass dieser Klassen-Alias definiert ist:

use Nette\Utils\Json;

Verwendung

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

Wandelt $value in das JSON-Format um.

Setzen Sie $pretty auf true, wird das JSON für bessere Lesbarkeit und Übersichtlichkeit formatiert:

Json::encode($value); // gibt JSON zurück
Json::encode($value, pretty: true); // gibt besser lesbares JSON zurück

Mit $asciiSafe auf true erzeugt sie eine ASCII-Ausgabe, Unicode-Zeichen werden also durch Sequenzen \uxxxx ersetzt:

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

Der Parameter $htmlSafe stellt sicher, dass die Ausgabe keine Zeichen enthält, die in HTML eine besondere Bedeutung haben:

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

Mit $forceObjects auf true werden auch Arrays mit numerischen Schlüsseln als JavaScript-Objekte kodiert:

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

Im Fehlerfall wirft sie eine Nette\Utils\JsonException.

try {
	$json = Json::encode($value);
} catch (Nette\Utils\JsonException $e) {
	// Behandlung der Exception
}

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

Parst einen JSON-String in einen PHP-Wert.

Setzen Sie $forceArrays auf true, werden statt Objekten Arrays zurückgegeben:

Json::decode('{"variable": true}'); // gibt ein Objekt vom Typ stdClass zurück
Json::decode('{"variable": true}', forceArrays: true); // gibt ein Array zurück

Im Fehlerfall wirft sie eine Nette\Utils\JsonException.

try {
	$value = Json::decode($json);
} catch (Nette\Utils\JsonException $e) {
	// Behandlung der Exception
}

Wie sendet man JSON aus einem Presenter?

Sie können die Methode $this->sendJson($data) verwenden, die sich zum Beispiel in einer Methode action*() aufrufen lässt. Siehe Senden einer Response.