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

<div class=perex>

NEON est un langage de sérialisation de données facile à lire pour l'humain. Nette l'utilise pour les fichiers de configuration. [api:Nette\Neon\Neon] est une classe statique pour travailler avec NEON.

Faites connaissance avec le [format NEON|format] et [essayez-le |https://fiddle.nette.org/neon/].

</div>

Tous les exemples supposent que l'alias suivant est défini :

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


Installation
------------

Téléchargez et installez le paquet à l'aide de [Composer|best-practices:composer] :

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

Vous pouvez vérifier les erreurs de syntaxe des fichiers `*.neon` avec la commande console `neon-lint` :

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


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

Renvoie `$value` converti en NEON. Vous pouvez passer `true` au paramètre `$blockMode` pour obtenir une sortie sur plusieurs lignes. Le paramètre `$indentation` indique les caractères utilisés pour l'indentation (par défaut la tabulation).

```php
Neon::encode($value); // Returns $value converted to NEON
Neon::encode($value, true); // Returns $value converted to multiline NEON
```

En cas d'erreur, la méthode `encode()` lève `Nette\Neon\Exception`.

```php
try {
	$neon = Neon::encode($value);
} catch (Nette\Neon\Exception $e) {
	// Exception handling
}
```


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

Convertit la chaîne NEON donnée en une valeur PHP.

Renvoie des scalaires, des tableaux, des [dates |format#Dates] sous forme d'objets DateTimeImmutable et des [entités |format#Entités] sous forme d'objets [api:Nette\Neon\Entity].

```php
Neon::decode('hello: world'); // Returns an array ['hello' => 'world']
```

En cas d'erreur, la méthode `decode()` lève `Nette\Neon\Exception`.

```php
try {
	$value = Neon::decode($neon);
} catch (Nette\Neon\Exception $e) {
	// Exception handling
}
```


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

Convertit le contenu d'un fichier de NEON vers PHP et supprime l'éventuel BOM.

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

En cas d'erreur, la méthode `decodeFile()` lève `Nette\Neon\Exception`.


Si vous passez à une version plus récente, consultez la page [mise à niveau |upgrading].