Nette Documentation Preview

syntax
Fonctions NEON
**************

<div class=perex>

NEON est un langage de sérialisation de données convivial. Il est utilisé dans Nette pour les fichiers de configuration. [api:Nette\Neon\Neon] est une classe statique pour travailler avec NEON.

Apprenez à connaître le [format NEON |format] et [essayez-le |https://ne-on.org].

</div>

Les exemples suivants utilisent ces alias :

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


Installation .[#toc-installation]
---------------------------------

Téléchargez et installez le paquet en utilisant [Composer |best-practices:composer]:

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

Vous pouvez vérifier la présence d'erreurs de syntaxe dans les fichiers `*.neon` à l'aide de la commande console `neon-lint`:

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


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

Renvoie `$value` converti en NEON. Comme paramètre `$blockMode` vous pouvez passer true, ce qui créera une sortie multiligne. Le paramètre `$indentation` spécifie les caractères utilisés pour l'indentation (la tabulation par défaut).

```php
Neon::encode($value); // Retourne $value converti en NEON
Neon::encode($value, true); // Retourne $value converti en NEON multiligne
```

La méthode `encode()` lance `Nette\Neon\Exception` en cas d'erreur.

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


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

Convertit le NEON donné en valeur PHP.

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

```php
Neon::decode('hello: world'); // Retourne un tableau ['hello' => 'world'].
```

La méthode `decode()` renvoie `Nette\Neon\Exception` en cas d'erreur.

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


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

Convertit le contenu du fichier de NEON en PHP et supprime toute nomenclature.

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

La méthode `decodeFile()` renvoie `Nette\Neon\Exception` en cas d'erreur.


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

Fonctions NEON

NEON est un langage de sérialisation de données convivial. Il est utilisé dans Nette pour les fichiers de configuration. Nette\Neon\Neon est une classe statique pour travailler avec NEON.

Apprenez à connaître le format NEON et essayez-le.

Les exemples suivants utilisent ces alias :

use Nette\Neon\Neon;

Installation

Téléchargez et installez le paquet en utilisant Composer:

composer require nette/neon

Vous pouvez vérifier la présence d'erreurs de syntaxe dans les fichiers *.neon à l'aide de la commande console neon-lint:

vendor/bin/neon-lint <path>

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

Renvoie $value converti en NEON. Comme paramètre $blockMode vous pouvez passer true, ce qui créera une sortie multiligne. Le paramètre $indentation spécifie les caractères utilisés pour l'indentation (la tabulation par défaut).

Neon::encode($value); // Retourne $value converti en NEON
Neon::encode($value, true); // Retourne $value converti en NEON multiligne

La méthode encode() lance Nette\Neon\Exception en cas d'erreur.

try {
	$neon = Neon::encode($value);
} catch (Nette\Neon\Exception $e) {
	// Gestion des exceptions
}

decode(string $neon): mixed

Convertit le NEON donné en valeur PHP.

Renvoie des scalaires, des tableaux, des dates sous forme d'objets DateTimeImmutable, et des entités sous forme d'objets Nette\Neon\Entity.

Neon::decode('hello: world'); // Retourne un tableau ['hello' => 'world'].

La méthode decode() renvoie Nette\Neon\Exception en cas d'erreur.

try {
	$value = Neon::decode($neon);
} catch (Nette\Neon\Exception $e) {
	// Gestion des exceptions
}

decodeFile(string $file)mixed

Convertit le contenu du fichier de NEON en PHP et supprime toute nomenclature.

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

La méthode decodeFile() renvoie Nette\Neon\Exception en cas d'erreur.