Arbeiten mit JSON

Nette\Utils\Json ist eine statische Klasse mit Funktionen zum Kodieren und Dekodieren des JSON-Formats. Sie behandelt Schwachstellen verschiedener PHP-Versionen und löst bei Fehlern Ausnahmen aus.

Installation:

composer require nette/utils

Alle Beispiele setzen voraus, dass der folgende Alias definiert wurde:

use Nette\Utils\Json;

Verwendung

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

Konvertiert $value in das JSON-Format.

Bei Einstellung $pretty formatiert es JSON für leichtere Lesbarkeit und Übersichtlichkeit:

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

Mit $asciiSafe = true wird eine reine ASCII-Ausgabe erzeugt, d.h. Unicode-Zeichen werden als \uxxxx-Sequenzen kodiert:

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 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"}'

Bei einem Fehler wird eine Nette\Utils\JsonException ausgelöst.

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

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

Parst JSON in PHP.

Die Einstellung $forceArray erzwingt die Rückgabe von Arrays anstelle von Objekten:

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

Bei einem Fehler wird eine Nette\Utils\JsonException ausgelöst.

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

Wie sendet man JSON von einem Presenter?

Dazu kann die Methode $this->sendJson($data) verwendet werden, die beispielsweise in einer action*()-Methode aufgerufen werden kann, siehe Antwort senden.