Nette NEON
**********

<div class=perex>

NEON ist eine für Menschen verständliche Sprache zur Serialisierung von Daten. Sie wird in Nette für Konfigurationsdateien verwendet. [api:Nette\Neon\Neon] ist eine statische Klasse für die Arbeit mit NEON.

Machen Sie sich mit dem [NEON-Format|format] vertraut und [probieren Sie es aus |https://ne-on.org].

</div>

Alle Beispiele setzen voraus, dass ein Alias erstellt wurde:

```php
use Nette\Neon\Neon;
```


Installation
------------

Sie können die Bibliothek mit dem Werkzeug [Composer|best-practices:composer] herunterladen und installieren:

```shell
composer require nette/neon
```

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

```shell
vendor/bin/neon-lint <Pfad>
```


encode(mixed $value, bool $blockMode=false, string $indentation="\t"): string .[method]
---------------------------------------------------------------------------------------

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).

```php
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.

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


decode(string $neon): mixed .[method]
-------------------------------------

Konvertiert eine Zeichenkette von NEON nach PHP.

Gibt Skalare, Arrays, [Daten |format#Datum] als DateTimeImmutable-Objekte und [Entitäten |format#Entitäten] als [api:Nette\Neon\Entity]-Objekte zurück.

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

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

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


decodeFile(string $file): mixed .[method]
-----------------------------------------

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

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

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


{{leftbar: utils:@left-menu}}