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

<div class=perex>

NEON to przyjazny człowiekowi język serializacji danych. W Nette używany jest do plików konfiguracyjnych. [api:Nette\Neon\Neon] to statyczna klasa do pracy z NEON-em.

Poznaj [format NEON|format] i [wypróbuj go |https://fiddle.nette.org/neon/].

</div>

Wszystkie przykłady zakładają zdefiniowany alias:

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


Instalacja
----------

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

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

Błędy składniowe w plikach `*.neon` możesz sprawdzić poleceniem konsolowym `neon-lint`:

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


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

Zwraca `$value` przekonwertowane na NEON. Parametrowi `$blockMode` możesz przekazać `true`, żeby utworzyć wyjście wieloliniowe. Parametr `$indentation` podaje znaki używane do wcięć (domyślnie tabulator).

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

Metoda `encode()` rzuca przy błędzie `Nette\Neon\Exception`.

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


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

Konwertuje podany ciąg NEON na wartość PHP.

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

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

Metoda `decode()` rzuca przy błędzie `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-a na PHP i usuwa ewentualny BOM.

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

Metoda `decodeFile()` rzuca przy błędzie `Nette\Neon\Exception`.


Jeśli aktualizujesz do nowszej wersji, zajrzyj na stronę [aktualizacji |upgrading].