Nette Documentation Preview

syntax
Nette NEON
**********

<div class=perex>

NEON es un lenguaje legible por humanos para la serialización de datos. Se utiliza en Nette para archivos de configuración. [api:Nette\Neon\Neon] es una clase estática para trabajar con NEON.

Familiarícese con el [formato NEON|format] y [pruébelo |https://ne-on.org].

</div>

Todos los ejemplos asumen que se ha creado un alias:

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


Instalación
-----------

Descargue e instale la biblioteca usando [Composer|best-practices:composer]:

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

Puede verificar los errores de sintaxis en los archivos `*.neon` usando el comando de consola `neon-lint`:

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


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

Devuelve `$value` convertido a NEON. Como parámetro `$blockMode`, puede pasar true, lo que creará una salida multilínea. El parámetro `$indentation` especifica los caracteres utilizados para la indentación (el valor predeterminado es tabulador).

```php
Neon::encode($value); // Devuelve $value convertido a NEON
Neon::encode($value, true); // Devuelve $value convertido a NEON multilínea
```

El método `encode()` lanza `Nette\Neon\Exception` en caso de error.

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


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

Convierte una cadena de NEON a PHP.

Devuelve escalares, arrays, [fechas |format#Fecha] como objetos DateTimeImmutable y [entidades |format#Entidades] como objetos [api:Nette\Neon\Entity].

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

El método `decode()` lanza `Nette\Neon\Exception` en caso de error.

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


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

Convierte el contenido de un archivo de NEON a PHP y elimina cualquier BOM.

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

El método `decodeFile()` lanza `Nette\Neon\Exception` en caso de error.


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

Nette NEON

NEON es un lenguaje legible por humanos para la serialización de datos. Se utiliza en Nette para archivos de configuración. Nette\Neon\Neon es una clase estática para trabajar con NEON.

Familiarícese con el formato NEON y pruébelo.

Todos los ejemplos asumen que se ha creado un alias:

use Nette\Neon\Neon;

Instalación

Descargue e instale la biblioteca usando Composer:

composer require nette/neon

Puede verificar los errores de sintaxis en los archivos *.neon usando el comando de consola neon-lint:

vendor/bin/neon-lint <ruta>

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

Devuelve $value convertido a NEON. Como parámetro $blockMode, puede pasar true, lo que creará una salida multilínea. El parámetro $indentation especifica los caracteres utilizados para la indentación (el valor predeterminado es tabulador).

Neon::encode($value); // Devuelve $value convertido a NEON
Neon::encode($value, true); // Devuelve $value convertido a NEON multilínea

El método encode() lanza Nette\Neon\Exception en caso de error.

try {
	$neon = Neon::encode($value);
} catch (Nette\Neon\Exception $e) {
	// manejo de excepciones
}

decode(string $neon): mixed

Convierte una cadena de NEON a PHP.

Devuelve escalares, arrays, fechas como objetos DateTimeImmutable y entidades como objetos Nette\Neon\Entity.

Neon::decode('hello: world'); // Devuelve el array ['hello' => 'world']

El método decode() lanza Nette\Neon\Exception en caso de error.

try {
	$value = Neon::decode($neon);
} catch (Nette\Neon\Exception $e) {
	// manejo de excepciones
}

decodeFile(string $file)mixed

Convierte el contenido de un archivo de NEON a PHP y elimina cualquier BOM.

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

El método decodeFile() lanza Nette\Neon\Exception en caso de error.