Nette Documentation Preview

syntax 
Работа с JSON
*************

.[perex]
[api:Nette\Utils\Json] - статический класс с функциями для кодирования и декодирования формата JSON. Он устраняет уязвимости разных версий PHP и при ошибках выбрасывает исключения.


Установка:

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

Во всех примерах предполагается, что определён такой псевдоним класса:

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


Использование
=============


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

Преобразует `$value` в формат JSON.

Установка `$pretty` в `true` форматирует JSON для лучшей читаемости и наглядности:

```php
Json::encode($value); // возвращает JSON
Json::encode($value, pretty: true); // возвращает более читаемый JSON
```

При `$asciiSafe`, установленном в `true`, порождается вывод в ASCII, то есть символы Unicode заменяются последовательностями `\uxxxx`:

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

Параметр `$htmlSafe` гарантирует, что вывод не содержит символов, имеющих специальное значение в HTML:

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

При `$forceObjects`, установленном в `true`, даже массивы с числовыми ключами будут закодированы как объекты JavaScript:

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

При ошибке выбрасывает `Nette\Utils\JsonException`.

```php
try {
	$json = Json::encode($value);
} catch (Nette\Utils\JsonException $e) {
	// Обработка исключения
}
```


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

Разбирает строку JSON в значение PHP.

Установка `$forceArrays` в `true` заставляет возвращать массивы вместо объектов:

```php
Json::decode('{"variable": true}'); // возвращает объект типа stdClass
Json::decode('{"variable": true}', forceArrays: true); // возвращает массив
```

При ошибке выбрасывает `Nette\Utils\JsonException`.

```php
try {
	$value = Json::decode($json);
} catch (Nette\Utils\JsonException $e) {
	// Обработка исключения
}
```


Как отправить JSON из презентера?
=================================

Вы можете использовать метод `$this->sendJson($data)`, который можно вызвать, например, внутри метода `action*()`. См. [Отправка ответа |application:presenters#Отправка ответа].

Работа с JSON

Nette\Utils\Json – статический класс с функциями для кодирования и декодирования формата JSON. Он устраняет уязвимости разных версий PHP и при ошибках выбрасывает исключения.

Установка:

composer require nette/utils

Во всех примерах предполагается, что определён такой псевдоним класса:

use Nette\Utils\Json;

Использование

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

Преобразует $value в формат JSON.

Установка $pretty в true форматирует JSON для лучшей читаемости и наглядности:

Json::encode($value); // возвращает JSON
Json::encode($value, pretty: true); // возвращает более читаемый JSON

При $asciiSafe, установленном в true, порождается вывод в ASCII, то есть символы Unicode заменяются последовательностями \uxxxx:

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

Параметр $htmlSafe гарантирует, что вывод не содержит символов, имеющих специальное значение в HTML:

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

При $forceObjects, установленном в true, даже массивы с числовыми ключами будут закодированы как объекты JavaScript:

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

При ошибке выбрасывает Nette\Utils\JsonException.

try {
	$json = Json::encode($value);
} catch (Nette\Utils\JsonException $e) {
	// Обработка исключения
}

decode (string $json, bool $forceArrays=false): mixed

Разбирает строку JSON в значение PHP.

Установка $forceArrays в true заставляет возвращать массивы вместо объектов:

Json::decode('{"variable": true}'); // возвращает объект типа stdClass
Json::decode('{"variable": true}', forceArrays: true); // возвращает массив

При ошибке выбрасывает Nette\Utils\JsonException.

try {
	$value = Json::decode($json);
} catch (Nette\Utils\JsonException $e) {
	// Обработка исключения
}

Как отправить JSON из презентера?

Вы можете использовать метод $this->sendJson($data), который можно вызвать, например, внутри метода action*(). См. Отправка ответа.