Nette Documentation Preview

syntax
Funções do JSON
***************

.[perex]
[api:Nette\Utils\Json] é uma classe estática com funções de codificação e decodificação JSON. Ela trata de vulnerabilidades em diferentes versões do PHP e lança exceções sobre erros.


Instalação:

```shell
composer require nette/utils
```

Todos os exemplos assumem que a seguinte classe está definida:

```php
use Nette\Utils\Json;
```


Utilização .[#toc-usage]
========================


encode(mixed $value, bool $pretty=false, bool $asciiSafe=false, bool $htmlSafe=false, bool $forceObjects=false): string .[method]
---------------------------------------------------------------------------------------------------------------------------------

Converte `$value` para o formato JSON.

Quando `$pretty` é configurado, ele formata o JSON para facilitar a leitura e a clareza:

```php
Json::encode($value); // devolve JSON
Json::encode($value, pretty: true); // devolve JSON mais claro
```

Quando `$asciiSafe` é definido, gera a saída ASCII, ou seja, substitui os caracteres unicode por seqüências `\uxxxx`:

```php
Json::encode('žluťoučký', asciiSafe: true);
// '"\u017elu\u0165ou\u010dk\u00fd"'
```

O parâmetro `$htmlSafe` garante que a saída não contenha caracteres com significado especial em HTML:

```php
Json::encode('one<two & three', htmlSafe: true);
// '"one\u003Ctwo \u0026 three"'
```

Com `$forceObjects`, mesmo arrays com chaves numéricas serão codificados como objetos JavaScript:

```php
Json::encode(['a', 'b', 'c']);
// '["a","b","c"]'
Json::encode(['a', 'b', 'c'], forceObjects: true);
// '{"0":"a","1":"b","2":"c"}'
```

Ele lança uma exceção de erro em `Nette\Utils\JsonException`.

```php
try {
	$json = Json::encode($value);
catch (Nette\Utils\JsonException $e) {
	// Tratamento de exceções
}
```


decode(string $json, bool $forceArray=false): mixed .[method]
-------------------------------------------------------------

Parses JSON para PHP.

A configuração `$forceArray` força o retorno de matrizes em vez de objetos:

```php
Json::decode('{"variable": true}'); // retorna um objeto do tipo stdClass
Json::decode('{"variable": true}', forceArray: true); // retorna um array
```

Ele lança uma exceção de erro em `Nette\Utils\JsonException`.

```php
try {
	$value = Json::decode($json);
} catch (Nette\Utils\JsonException $e) {
	// Tratamento de exceções
}
```


Como enviar um JSON de um apresentador? .[#toc-how-to-send-a-json-from-a-presenter]
===================================================================================

Você pode usar o método `$this->sendJson($data)`, que pode ser chamado, por exemplo, no método `action*()`, veja [Enviando uma Resposta |application:presenters#Sending a Response].

Funções do JSON

Nette\Utils\Json é uma classe estática com funções de codificação e decodificação JSON. Ela trata de vulnerabilidades em diferentes versões do PHP e lança exceções sobre erros.

Instalação:

composer require nette/utils

Todos os exemplos assumem que a seguinte classe está definida:

use Nette\Utils\Json;

Utilização

encode(mixed $value, bool $pretty=false, bool $asciiSafe=false, bool $htmlSafe=false, bool $forceObjects=false)string

Converte $value para o formato JSON.

Quando $pretty é configurado, ele formata o JSON para facilitar a leitura e a clareza:

Json::encode($value); // devolve JSON
Json::encode($value, pretty: true); // devolve JSON mais claro

Quando $asciiSafe é definido, gera a saída ASCII, ou seja, substitui os caracteres unicode por seqüências \uxxxx:

Json::encode('žluťoučký', asciiSafe: true);
// '"\u017elu\u0165ou\u010dk\u00fd"'

O parâmetro $htmlSafe garante que a saída não contenha caracteres com significado especial em HTML:

Json::encode('one<two & three', htmlSafe: true);
// '"one\u003Ctwo \u0026 three"'

Com $forceObjects, mesmo arrays com chaves numéricas serão codificados como objetos JavaScript:

Json::encode(['a', 'b', 'c']);
// '["a","b","c"]'
Json::encode(['a', 'b', 'c'], forceObjects: true);
// '{"0":"a","1":"b","2":"c"}'

Ele lança uma exceção de erro em Nette\Utils\JsonException.

try {
	$json = Json::encode($value);
catch (Nette\Utils\JsonException $e) {
	// Tratamento de exceções
}

decode(string $json, bool $forceArray=false)mixed

Parses JSON para PHP.

A configuração $forceArray força o retorno de matrizes em vez de objetos:

Json::decode('{"variable": true}'); // retorna um objeto do tipo stdClass
Json::decode('{"variable": true}', forceArray: true); // retorna um array

Ele lança uma exceção de erro em Nette\Utils\JsonException.

try {
	$value = Json::decode($json);
} catch (Nette\Utils\JsonException $e) {
	// Tratamento de exceções
}

Como enviar um JSON de um apresentador?

Você pode usar o método $this->sendJson($data), que pode ser chamado, por exemplo, no método action*(), veja Enviando uma Resposta.