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

<div class=perex>

NEON ist eine für Menschen freundliche Sprache zur Serialisierung von Daten. In Nette wird sie für Konfigurationsdateien verwendet. [api:Nette\Neon\Neon] ist eine statische Klasse für die Arbeit mit NEON.

Lernen Sie das [Format NEON |format] kennen und [probieren Sie es aus |https://fiddle.nette.org/neon/].

</div>

Alle Beispiele setzen voraus, dass folgender Alias definiert ist:

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


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

Das Paket laden und installieren Sie mit [Composer |best-practices:composer]:

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

Auf Syntaxfehler in `*.neon`-Dateien können Sie mit dem Konsolenbefehl `neon-lint` prüfen:

```shell
vendor/bin/neon-lint [--debug] <path>
```


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

Gibt `$value` in NEON umgewandelt zurück. Dem Parameter `$blockMode` können Sie `true` übergeben, um eine mehrzeilige Ausgabe zu erzeugen. Der Parameter `$indentation` gibt die Zeichen an, die zur Einrückung verwendet werden (Standard ist der Tabulator).

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

Die Methode `encode()` wirft im Fehlerfall eine `Nette\Neon\Exception`.

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


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

Wandelt den angegebenen NEON-String in einen PHP-Wert um.

Gibt Skalare, Arrays, [Datumsangaben |format#Datumsangaben] als DateTimeImmutable-Objekte und [Entities |format#Entities] als Objekte vom Typ [api:Nette\Neon\Entity] zurück.

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

Die Methode `decode()` wirft im Fehlerfall eine `Nette\Neon\Exception`.

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


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

Wandelt den Inhalt einer Datei von NEON nach PHP um und entfernt ein eventuelles BOM.

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

Die Methode `decodeFile()` wirft im Fehlerfall eine `Nette\Neon\Exception`.


Wenn Sie auf eine neuere Version aktualisieren, sehen Sie sich die Seite [Upgrade |upgrading] an.