Praca z NEON
************

<div class=perex>

NEON jest czytelnym dla człowieka językiem serializacji danych. Jest on używany w Nette do plików konfiguracyjnych. [api:Nette\Neon\Neon] jest statyczną klasą do pracy z NEONem.

Poznaj [format NEON |format] i [wypróbuj go |https://ne-on.org].

</div>

Wszystkie przykłady zakładają utworzony alias:

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


Instalacja .[#toc-installation]
-------------------------------

Pobierz i zainstaluj bibliotekę za pomocą [Composera |best-practices:composer]:

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

Możesz sprawdzić błędy składni w plikach `*.neon` używając polecenia konsoli `neon-lint`:

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


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

Zwraca `$value` przekonwertowany na NEON. Możesz przekazać true jako parametr `$blockMode`, aby utworzyć wyjście wieloliniowe. Parametr `$indentation` określa znaki używane do wcięć (domyślnie jest to tabulator).

```php
Neon::encode($value); // Zwraca $value przekonwertowaną na NEON
Neon::encode($value, true); // Zwraca $value przekonwertowaną na wielowierszowy NEON
```

Metoda `encode()` rzuca `Nette\Neon\Exception` na błąd.

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


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

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

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

```php
Neon::decode('hello: world'); // Vrátí pole ['hello' => 'world']
```

Metoda `decode()` rzuca `Nette\Neon\Exception` na błąd.

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


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

Konwertuje zawartość pliku z NEON na PHP i usuwa wszelkie BOM.

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

Metoda `decodeFile()` rzuca `Nette\Neon\Exception` na błąd.


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