(PHP 5 >= 5.2.0, PHP 7, PHP 8, PECL json >= 1.2.0)
json_encode — Возвращает JSON-представление данных
Функция возвращает строку, которая содержит JSON-представление значения value. Функция рекурсивно сериализует значение параметра, если параметр — массив (array) или объект (object).
По умолчанию функция включит в результирующую строку только открытые свойства, если значение, которое сериализует функция, — объект. Чтобы создать альтернативу внутренней сериализации и самому управлять тем, как значения объекта сериализуются в JSON, в классе реализуют интерфейс JsonSerializable.
На кодирование влияет параметр flags, а кодирование значений float зависит от значения директивы serialize_precision.
value Параметр value — значение, которое закодирует функция. Разрешены все типы, кроме resource.
Функция работает только с кодировкой UTF-8.
Замечание:
PHP реализует расширенный набор JSON, который описывает исходный стандарт » RFC 7159.
flags Битовая маска, которую составили из значений JSON_FORCE_OBJECT, JSON_HEX_QUOT, JSON_HEX_TAG, JSON_HEX_AMP, JSON_HEX_APOS, JSON_INVALID_UTF8_IGNORE, JSON_INVALID_UTF8_SUBSTITUTE, JSON_NUMERIC_CHECK, JSON_PARTIAL_OUTPUT_ON_ERROR, JSON_PRESERVE_ZERO_FRACTION, JSON_PRETTY_PRINT, JSON_UNESCAPED_LINE_TERMINATORS, JSON_UNESCAPED_SLASHES, JSON_UNESCAPED_UNICODE, JSON_THROW_ON_ERROR. Значение этих констант объясняет страница JSON-констант.
depthУстанавливает максимальную глубину. Значение параметра должно быть больше нуля.
Функция возвращает строку (string) в формате JSON или false, если возникла ошибка.
| Версия | Описание |
|---|---|
| 7.3.0 | Добавлена константа JSON_THROW_ON_ERROR для параметра flags. |
| 7.2.0 | Добавлены константы JSON_INVALID_UTF8_IGNORE и JSON_INVALID_UTF8_SUBSTITUTE для параметра flags. |
| 7.1.0 | Добавлена константа JSON_UNESCAPED_LINE_TERMINATORS для параметра flags. |
| 7.1.0 | При кодировании чисел с плавающей точкой (float) вместо значения директивы precision функция учитывает значение директивы serialize_precision. |
Пример #1 Пример использования функции json_encode()
<?php
$arr = array('a' => 1, 'b' => 2, 'c' => 3, 'd' => 4, 'e' => 5);
echo json_encode($arr);
?>Результат выполнения приведённого примера:
{"a":1,"b":2,"c":3,"d":4,"e":5}Пример #2 Пример использования функции json_encode() с опциями
<?php
$a = array('<foo>', "'bar'", '"baz"', '&blong&', "\xc3\xa9");
echo "Обычно: ", json_encode($a), "\n";
echo "Теги: ", json_encode($a, JSON_HEX_TAG), "\n";
echo "Апострофы: ", json_encode($a, JSON_HEX_APOS), "\n";
echo "Кавычки: ", json_encode($a, JSON_HEX_QUOT), "\n";
echo "Амперсанды: ", json_encode($a, JSON_HEX_AMP), "\n";
echo "Юникод: ", json_encode($a, JSON_UNESCAPED_UNICODE), "\n";
echo "Все: ", json_encode($a, JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_QUOT | JSON_HEX_AMP | JSON_UNESCAPED_UNICODE), "\n\n";
$b = array();
echo "Отображение пустого массива как массива: ", json_encode($b), "\n";
echo "Отображение неассоциативного массива как объекта: ", json_encode($b, JSON_FORCE_OBJECT), "\n\n";
$c = array(array(1,2,3));
echo "Отображение неассоциативного массива как массива: ", json_encode($c), "\n";
echo "Отображение неассоциативного массива как объекта: ", json_encode($c, JSON_FORCE_OBJECT), "\n\n";
$d = array('foo' => 'bar', 'baz' => 'long');
echo "Ассоциативный массив всегда отображается как объект: ", json_encode($d), "\n";
echo "Ассоциативный массив всегда отображается как объект: ", json_encode($d, JSON_FORCE_OBJECT), "\n\n";
?>Результат выполнения приведённого примера:
Обычно: ["<foo>","'bar'","\"baz\"","&blong&","\u00e9"] Теги: ["\u003Cfoo\u003E","'bar'","\"baz\"","&blong&","\u00e9"] Апострофы: ["<foo>","\u0027bar\u0027","\"baz\"","&blong&","\u00e9"] Кавычки: ["<foo>","'bar'","\u0022baz\u0022","&blong&","\u00e9"] Амперсанды: ["<foo>","'bar'","\"baz\"","\u0026blong\u0026","\u00e9"] Юникод: ["<foo>","'bar'","\"baz\"","&blong&","é"] Все: ["\u003Cfoo\u003E","\u0027bar\u0027","\u0022baz\u0022","\u0026blong\u0026","é"] Отображение пустого массива как массива: [] Отображение неассоциативного массива как объекта: {} Отображение неассоциативного массива как массива: [[1,2,3]] Отображение неассоциативного массива как объекта: {"0":{"0":1,"1":2,"2":3}} Ассоциативный массив всегда отображается как объект: {"foo":"bar","baz":"long"} Ассоциативный массив всегда отображается как объект: {"foo":"bar","baz":"long"}Пример #3 Пример использования опции JSON_NUMERIC_CHECK
<?php
echo "Строки, которые содержат числа, преобразовываются в числа" . PHP_EOL;
$numbers = array('+123123', '-123123', '1.2e3', '0.00001');
var_dump(
$numbers,
json_encode($numbers, JSON_NUMERIC_CHECK)
);
echo "Строки, которые содержат некорректно заданные числа" . PHP_EOL;
$strings = array('+a33123456789', 'a123');
var_dump(
$strings,
json_encode($strings, JSON_NUMERIC_CHECK)
);
?>Вывод приведённого примера будет похож на:
Строки, которые содержат числа, преобразовываются в числа array(4) { [0]=> string(7) "+123123" [1]=> string(7) "-123123" [2]=> string(5) "1.2e3" [3]=> string(7) "0.00001" } string(28) "[123123,-123123,1200,1.0e-5]" Строки, которые содержат некорректно заданные числа array(2) { [0]=> string(13) "+a33123456789" [1]=> string(4) "a123" } string(24) "["+a33123456789","a123"]"Пример #4 Пример с последовательными индексами, которые начинаются с нуля, и непоследовательными индексами массивов
<?php
echo "Последовательный массив" . PHP_EOL;
$sequential = array("foo", "bar", "baz", "blong");
var_dump(
$sequential,
json_encode($sequential)
);
echo PHP_EOL . "Непоследовательный массив" . PHP_EOL;
$nonsequential = array(1 => "foo", 2 => "bar", 3 => "baz", 4 => "blong");
var_dump(
$nonsequential,
json_encode($nonsequential)
);
echo PHP_EOL . "Последовательный массив с одним удалённым индексом" . PHP_EOL;
unset($sequential[1]);
var_dump(
$sequential,
json_encode($sequential)
);
?>Результат выполнения приведённого примера:
Последовательный массив array(4) { [0]=> string(3) "foo" [1]=> string(3) "bar" [2]=> string(3) "baz" [3]=> string(5) "blong" } string(27) "["foo","bar","baz","blong"]" Непоследовательный массив array(4) { [1]=> string(3) "foo" [2]=> string(3) "bar" [3]=> string(3) "baz" [4]=> string(5) "blong" } string(43) "{"1":"foo","2":"bar","3":"baz","4":"blong"}" Последовательный массив с одним удалённым индексом array(3) { [0]=> string(3) "foo" [2]=> string(3) "baz" [3]=> string(5) "blong" } string(33) "{"0":"foo","2":"baz","3":"blong"}"Пример #5 Пример использования опции JSON_PRESERVE_ZERO_FRACTION
<?php
var_dump(json_encode(12.0, JSON_PRESERVE_ZERO_FRACTION));
var_dump(json_encode(12.0));
?>Результат выполнения приведённого примера:
string(4) "12.0" string(2) "12"
Замечание:
Функция json_last_error() помогает определить точную причину ошибки, если возникла ошибка кодирования.
Замечание:
Функция кодирует ключи как строковые и для каждой пары ключ-значение указывает ключи явным образом, если при кодировании массива ключи нарушают непрерывную числовую последовательность, которая начинается с 0.
Замечание:
Как и эталонный JSON-кодировщик, функция json_encode() сгенерирует JSON в виде простого значения, а не объекта или массива, если входное значение параметра
value— string, int, float или bool. Декодеры будут принимать эти значения как корректный JSON, но часть декодеров не примет, потому что спецификация в этом отношении неоднозначна.Заключение: проверяйте, правильно ли JSON-декодер обрабатывает вывод, который генерирует функция json_encode().