Funções NEON
************

<div class=perex>

NEON é uma linguagem de serialização de dados amigável ao ser humano. É utilizada em Nette para arquivos de configuração. [api:Nette\Neon\Neon] é uma classe estática para trabalhar com NEON.

Conheça o [formato NEON |format] e [experimente-o |https://ne-on.org].

</div>

Os exemplos a seguir utilizam estes pseudônimos:

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


Instalação .[#toc-installation]
-------------------------------

Baixe e instale o pacote usando [o Composer |best-practices:composer]:

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

Você pode verificar se há erros de sintaxe nos arquivos `*.neon` usando o comando do console `neon-lint`:

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


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

Retorna `$value` convertido para NEON. Como o parâmetro `$blockMode` você pode passar verdadeiro, o que criará uma saída multilinha. O parâmetro `$indentation` especifica os caracteres usados para indentação (o padrão é tabulação).

```php
Neon::encode($value); // Devolve $value convertido em NEON
Neon::encode($value, true); // Retorna $value convertido em NEON multilinha
```

O método `encode()` lança `Nette\Neon\Exception` sobre erro.

```php
try {
	$neon = Neon::encode($value);
catch (Nette\Neon\Exception $e) {
	// Tratamento de exceções
}
```


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

Converte o valor NEON dado para PHP.

Retorna escalares, arrays, [data |format#dates] como DateTime Objetos imutáveis, e [entidades |format#Entities] como [api:Nette\Neon\Entity] objetos.

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

O método `decode()` lança `Nette\Neon\Exception` sobre erro.

```php
try {
	$value = Neon::decode($neon);
} catch (Nette\Neon\Exception $e) {
	// Tratamento de exceções
}
```


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

Converte o conteúdo do arquivo de NEON para PHP e remove qualquer lista técnica.

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

O método `decodeFile()` lança `Nette\Neon\Exception` sobre erro.


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