Nette Documentation Preview

syntax
Функції NEON
************

<div class=perex>

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

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

</div>

У наступних прикладах використовуються ці псевдоніми:

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


Встановлення .[#toc-installation]
---------------------------------

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

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

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

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


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

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

```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#Dates] як об'єкти DateTimeImmutable і [сутності |format#Entities] як об'єкти [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}}

Функції NEON

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

Познайомтеся з форматом NEON і спробуйте його в роботі.

У наступних прикладах використовуються ці псевдоніми:

use Nette\Neon\Neon;

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

Завантажте та встановіть пакет за допомогою Composer:

composer require nette/neon

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

vendor/bin/neon-lint <path>

encode(mixed $value, bool $blockMode=false, string $indentation="\t")string

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

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

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

try {
	$neon = Neon::encode($value);
} catch (Nette\Neon\Exception $e) {
	// Обробка виключення
}

decode(string $neon): mixed

Конвертує заданий NEON у значення PHP.

Повертає скаляри, масиви, дату як об'єкти DateTimeImmutable і сутності як об'єкти Nette\Neon\Entity.

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

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

try {
	$value = Neon::decode($neon);
} catch (Nette\Neon\Exception $e) {
	// Обробка виключення
}

decodeFile(string $file)mixed

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

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

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