Munka a NEON-nal
A NEON egy ember által olvasható adatszerializációs nyelv. A Nette-ben konfigurációs fájlokhoz használják. A Nette\Neon\Neon egy statikus osztály a NEON-nal való munkához.
Ismerkedjen meg a NEON formátummal és próbálja ki.
Minden példa feltételezi egy alias létrehozását:
use Nette\Neon\Neon;
Telepítés
A könyvtárat a Composer segítségével töltheti le és telepítheti:
composer require nette/neon
A *.neon
fájlok szintaktikai hibáit a neon-lint
konzol paranccsal ellenőrizheti:
vendor/bin/neon-lint <útvonal>
encode (mixed $value, bool $blockMode=false,
string $indentation="\t"
): string
Visszaadja a $value
értéket NEON formátumba konvertálva. A $blockMode
paraméterként
true
értéket adhat át, ami többsoros kimenetet hoz létre. Az $indentation
paraméter határozza meg
a behúzáshoz használt karaktereket (alapértelmezés szerint tabulátor).
Neon::encode($value); // Visszaadja a $value értéket NEON-ba konvertálva
Neon::encode($value, true); // Visszaadja a $value értéket többsoros NEON-ba konvertálva
Az encode()
metódus hiba esetén Nette\Neon\Exception
kivételt dob.
try {
$neon = Neon::encode($value);
} catch (Nette\Neon\Exception $e) {
// kivétel kezelése
}
decode (string $neon): mixed
Átalakítja a stringet NEON-ból PHP-ra.
Visszaad skalárokat, tömböket, dátumokat DateTimeImmutable objektumként és entitásokat Nette\Neon\Entity objektumként.
Neon::decode('hello: world'); // Visszaadja a ['hello' => 'world'] tömböt
A decode()
metódus hiba esetén Nette\Neon\Exception
kivételt dob.
try {
$value = Neon::decode($neon);
} catch (Nette\Neon\Exception $e) {
// kivétel kezelése
}
decodeFile (string $file): mixed
Átalakítja egy fájl tartalmát NEON-ból PHP-ra és eltávolítja az esetleges BOM-ot.
Neon::decodeFile('config.neon');
A decodeFile()
metódus hiba esetén Nette\Neon\Exception
kivételt dob.