Робота з NEON
*************

<div class=perex>

NEON — це зрозуміла для людини мова серіалізації даних. Вона використовується в Nette для конфігураційних файлів. [api:Nette\Neon\Neon] — це статичний клас для роботи з NEON.

Ознайомтеся з [форматом NEON|format] та [спробуйте його |https://ne-on.org].

</div>

Усі приклади передбачають створений псевдонім:

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


Встановлення
------------

Завантажте та встановіть бібліотеку за допомогою [Composer|best-practices:composer]:

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

Помилки синтаксису у файлах `*.neon` можна перевірити за допомогою консольної команди `neon-lint`:

```shell
vendor/bin/neon-lint <шлях>
```


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

Повертає `$value`, перетворене на NEON. Як параметр `$blockMode` можна передати true, що створить багаторядковий вивід. Параметр `$indentation` визначає символи, що використовуються для відступу (за замовчуванням — табуляція).

```php
Neon::encode($value); // Повертає $value, перетворене на NEON
Neon::encode($value, true); // Повертає $value, перетворене на багаторядковий NEON
```

Метод `encode()` при помилці викидає `Nette\Neon\Exception`.

```php
try {
	$neon = Neon::encode($value);
} catch (Nette\Neon\Exception $e) {
	// обробка винятку
}
```


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

Перетворює рядок з NEON на PHP.

Повертає скаляри, масиви, [дані |format#Дата] як об'єкти DateTimeImmutable та [сутності |format#Сутності] як об'єкти [api:Nette\Neon\Entity].

```php
Neon::decode('hello: world'); // Повертає масив ['hello' => 'world']
```

Метод `decode()` при помилці викидає `Nette\Neon\Exception`.

```php
try {
	$value = Neon::decode($neon);
} catch (Nette\Neon\Exception $e) {
	// обробка винятку
}
```


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

Перетворює вміст файлу з NEON на PHP та видаляє можливий BOM.

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

Метод `decodeFile()` при помилці викидає `Nette\Neon\Exception`.


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