Nette Documentation Preview

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

<div class=perex>

NEON es un lenguaje de serialización de datos legible por humanos. En Nette se usa para los 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://fiddle.nette.org/neon/].

</div>

Todos los ejemplos dan por hecho que se ha definido el siguiente alias:

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


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

Descargue e instale el paquete con [Composer|best-practices:composer]:

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

Puede comprobar si hay errores de sintaxis en los archivos `*.neon` con el comando de consola `neon-lint`:

```shell
vendor/bin/neon-lint [--debug] <ruta>
```


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

Devuelve `$value` convertido a NEON. Al parámetro `$blockMode` puede pasarle `true` para crear una salida multilínea. El parámetro `$indentation` indica los caracteres que se usan para la indentación (de forma predeterminada, el 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 la excepción
}
```


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

Convierte la cadena NEON dada a un valor de PHP.

Devuelve escalares, arrays, [fechas |format#Fechas] 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 la excepción
}
```


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.


Si está actualizando a una versión más reciente, vea la página de [actualización |upgrading].

Nette NEON

NEON es un lenguaje de serialización de datos legible por humanos. En Nette se usa para los 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 dan por hecho que se ha definido el siguiente alias:

use Nette\Neon\Neon;

Instalación

Descargue e instale el paquete con Composer:

composer require nette/neon

Puede comprobar si hay errores de sintaxis en los archivos *.neon con el comando de consola neon-lint:

vendor/bin/neon-lint [--debug] <ruta>

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

Devuelve $value convertido a NEON. Al parámetro $blockMode puede pasarle true para crear una salida multilínea. El parámetro $indentation indica los caracteres que se usan para la indentación (de forma predeterminada, el 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 la excepción
}

decode(string $input): mixed

Convierte la cadena NEON dada a un valor de 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 la excepción
}

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.

Si está actualizando a una versión más reciente, vea la página de actualización.