Arbeiten mit NEON

Alle Beispiele setzen voraus, dass ein Alias erstellt wurde:

use Nette\Neon\Neon;

Installation

Sie können die Bibliothek mit dem Werkzeug Composer herunterladen und installieren:

composer require nette/neon

Syntaxfehler in *.neon-Dateien können mit dem Konsolenbefehl neon-lint überprüft werden:

vendor/bin/neon-lint <Pfad>

encode (mixed $value, bool $blockMode=false, string $indentation="\t"): string

Gibt $value konvertiert in NEON zurück. Als Parameter $blockMode können Sie true übergeben, wodurch eine mehrzeilige Ausgabe erstellt wird. Der Parameter $indentation gibt die für die Einrückung verwendeten Zeichen an (Standard ist Tabulator).

Neon::encode($value); // Gibt $value konvertiert in NEON zurück
Neon::encode($value, true); // Gibt $value konvertiert in mehrzeiliges NEON zurück

Die Methode encode() löst bei einem Fehler eine Nette\Neon\Exception aus.

try {
	$neon = Neon::encode($value);
} catch (Nette\Neon\Exception $e) {
	// Ausnahmebehandlung
}

decode (string $neon): mixed

Konvertiert eine Zeichenkette von NEON nach PHP.

Gibt Skalare, Arrays, Daten als DateTimeImmutable-Objekte und Entitäten als Nette\Neon\Entity-Objekte zurück.

Neon::decode('hello: world'); // Gibt Array ['hello' => 'world'] zurück

Die Methode decode() löst bei einem Fehler eine Nette\Neon\Exception aus.

try {
	$value = Neon::decode($neon);
} catch (Nette\Neon\Exception $e) {
	// Ausnahmebehandlung
}

decodeFile (string $file): mixed

Konvertiert den Inhalt einer Datei von NEON nach PHP und entfernt einen eventuellen BOM.

Neon::decodeFile('config.neon');

Die Methode decodeFile() löst bei einem Fehler eine Nette\Neon\Exception aus.