Fonctions NEON

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.