Working with NEON
*****************

<div class=perex>

NEON is a human-friendly data serialization language. It is used in Nette for configuration files. [api:Nette\Neon\Neon] is a static class for working with NEON.

Get to know the [NEON format|format] and [try it out |https://ne-on.org].

</div>

All examples assume the following alias is defined:

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


Installation
------------

Download and install the package using [Composer|best-practices:composer]:

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

You can check for syntax errors in `*.neon` files using the `neon-lint` console command:

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


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

Returns `$value` converted to NEON. You can pass `true` to the `$blockMode` parameter to create multiline output. The `$indentation` parameter specifies the characters used for indentation (default is tab).

```php
Neon::encode($value); // Returns $value converted to NEON
Neon::encode($value, true); // Returns $value converted to multiline NEON
```

The `encode()` method throws `Nette\Neon\Exception` on error.

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


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

Converts the given NEON string to a PHP value.

Returns scalars, arrays, [dates |format#Dates] as DateTimeImmutable objects, and [entities |format#Entities] as [api:Nette\Neon\Entity] objects.

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

The `decode()` method throws `Nette\Neon\Exception` on error.

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


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

Converts the contents of a file from NEON to PHP and removes any BOM.

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

The `decodeFile()` method throws `Nette\Neon\Exception` on error.


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