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

<div class=perex>

NEON to czytelny dla człowieka język do serializacji danych. Jest używany w Nette do plików konfiguracyjnych. [api:Nette\Neon\Neon] to statyczna klasa do pracy z NEONem.

Zapoznaj się z [formatem NEON|format] i [wypróbuj go |https://ne-on.org].

</div>

Wszystkie przykłady zakładają utworzony alias:

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


Instalacja
----------

Bibliotekę pobierzesz i zainstalujesz za pomocą narzędzia [Composer|best-practices:composer]:

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

Błędy składni w plikach `*.neon` możesz sprawdzić za pomocą polecenia konsolowego `neon-lint`:

```shell
vendor/bin/neon-lint <ścieżka>
```


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

Zwraca `$value` przekonwertowane na NEON. Jako parametr `$blockMode` możesz przekazać `true`, co utworzy wyjście wieloliniowe. Parametr `$indentation` określa znak używany do wcięcia (domyślnie tabulator).

```php
Neon::encode($value); // Zwraca $value przekonwertowane na NEON
Neon::encode($value, true); // Zwraca $value przekonwertowane na wieloliniowy NEON
```

Metoda `encode()` w przypadku błędu rzuca `Nette\Neon\Exception`.

```php
try {
	$neon = Neon::encode($value);
} catch (Nette\Neon\Exception $e) {
	// obsługa wyjątku
}
```


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

Konwertuje ciąg znaków z NEON do PHP.

Zwraca skalary, tablice, [daty |format#Daty] jako obiekty DateTimeImmutable i [encje |format#Encje] jako obiekty [api:Nette\Neon\Entity].

```php
Neon::decode('hello: world'); // Zwraca tablicę ['hello' => 'world']
```

Metoda `decode()` w przypadku błędu rzuca `Nette\Neon\Exception`.

```php
try {
	$value = Neon::decode($neon);
} catch (Nette\Neon\Exception $e) {
	// obsługa wyjątku
}
```


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

Konwertuje zawartość pliku z NEON do PHP i usuwa ewentualny BOM.

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

Metoda `decodeFile()` w przypadku błędu rzuca `Nette\Neon\Exception`.


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