Nette Documentation Preview

syntax
Delo z NEON
***********

<div class=perex>

NEON je človeku razumljiv jezik za serializacijo podatkov. V Nette se uporablja za konfiguracijske datoteke. [api:Nette\Neon\Neon] je statični razred za delo z NEONom.

Spoznajte [format NEON|format] in [ga preizkusite |https://ne-on.org].

</div>

Vsi primeri predpostavljajo ustvarjen alias:

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


Namestitev
----------

Knjižnico prenesete in namestite z orodjem [Composer|best-practices:composer]:

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

Napake v sintaksi v datotekah `*.neon` lahko preverite z ukazom konzole `neon-lint`:

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


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

Vrne `$value`, pretvorjeno v NEON. Kot parameter `$blockMode` lahko predate true, s čimer se ustvari večvrstični izpis. Parameter `$indentation` določa znake, uporabljene za zamik (privzeto je tabulator).

```php
Neon::encode($value); // Vrne $value, pretvorjeno v NEON
Neon::encode($value, true); // Vrne $value, pretvorjeno v večvrstični NEON
```

Metoda `encode()` ob napaki vrže `Nette\Neon\Exception`.

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


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

Pretvori niz iz NEONa v PHP.

Vrne skalarje, polja, [datume|format#datum] kot objekte DateTimeImmutable in [entitete|format#entity] kot objekte [api:Nette\Neon\Entity].

```php
Neon::decode('hello: world'); // Vrne polje ['hello' => 'world']
```

Metoda `decode()` ob napaki vrže `Nette\Neon\Exception`.

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


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

Pretvori vsebino datoteke iz NEONa v PHP in odstrani morebitni BOM.

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

Metoda `decodeFile()` ob napaki vrže `Nette\Neon\Exception`.


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

Delo z NEON

NEON je človeku razumljiv jezik za serializacijo podatkov. V Nette se uporablja za konfiguracijske datoteke. Nette\Neon\Neon je statični razred za delo z NEONom.

Spoznajte format NEON in ga preizkusite.

Vsi primeri predpostavljajo ustvarjen alias:

use Nette\Neon\Neon;

Namestitev

Knjižnico prenesete in namestite z orodjem Composer:

composer require nette/neon

Napake v sintaksi v datotekah *.neon lahko preverite z ukazom konzole neon-lint:

vendor/bin/neon-lint <pot>

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

Vrne $value, pretvorjeno v NEON. Kot parameter $blockMode lahko predate true, s čimer se ustvari večvrstični izpis. Parameter $indentation določa znake, uporabljene za zamik (privzeto je tabulator).

Neon::encode($value); // Vrne $value, pretvorjeno v NEON
Neon::encode($value, true); // Vrne $value, pretvorjeno v večvrstični NEON

Metoda encode() ob napaki vrže Nette\Neon\Exception.

try {
	$neon = Neon::encode($value);
} catch (Nette\Neon\Exception $e) {
	// obdelava izjeme
}

decode(string $neon): mixed

Pretvori niz iz NEONa v PHP.

Vrne skalarje, polja, datume kot objekte DateTimeImmutable in entitete kot objekte Nette\Neon\Entity.

Neon::decode('hello: world'); // Vrne polje ['hello' => 'world']

Metoda decode() ob napaki vrže Nette\Neon\Exception.

try {
	$value = Neon::decode($neon);
} catch (Nette\Neon\Exception $e) {
	// obdelava izjeme
}

decodeFile(string $file)mixed

Pretvori vsebino datoteke iz NEONa v PHP in odstrani morebitni BOM.

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

Metoda decodeFile() ob napaki vrže Nette\Neon\Exception.