MongoDB\BSON\toJSON

(mongodb >=1.0.0)

MongoDB\BSON\toJSON — Возвращает Legacy Extended JSON-представление BSON-значения

Внимание

Метод УСТАРЕЛ с модуля версии 1.20.0, а в версии 2.0 метод удалили. Вместо этого метода приложениям лучше вызывать метод MongoDB\BSON\Document::toCanonicalExtendedJSON() или MongoDB\BSON\Document::toRelaxedExtendedJSON().

Описание

function MongoDB\BSON\toJSON(string $bson): string

Метод преобразовывает в BSON-строку её представление в формате » Legacy Extended JSON.

Замечание: BSON-данные представляют в ряде JSON-форматов. Метод реализует «строгий режим», который определяется форматом » MongoDB Extended JSON, который заменили каноническими — реализовали в методе MongoDB\BSON\toCanonicalExtendedJSON() — и упрощёнными — в методе MongoDB\BSON\toRelaxedExtendedJSON() — форматами, которые определили » в спецификации Extended JSON.

Внимание

Формат » JSON не поддерживает нечисло NAN и бесконечность INF, а формат Legacy Extended JSON базы данных MongoDB не определяет альтернативное представление для этих значений (библиотека » libbson выведет литералы nan и inf, которые иногда не распознаются, в допустимом JSON-формате). При работе с BSON-форматом, который иногда содержит бесконечные числа, вызывают метод MongoDB\BSON\toCanonicalExtendedJSON() или MongoDB\BSON\toRelaxedExtendedJSON().

Список параметров

bson (string): Значение BSON для преобразования.

Возвращаемые значения

Метод возвращает JSON-значение, в которое преобразовал BSON-значение.

Ошибки

Метод выбрасывает исключение MongoDB\Driver\Exception\UnexpectedValueException, если во входных данных передали больше одного BSON-документа. Возможные причины включают, но не ограничиваются недопустимым BSON-форматом, лишними данными или неожиданной ошибкой » libbson.

Список изменений

Версия	Описание
PECL-модуль mongodb 2.0.0	Функцию удалили.

Примеры

Пример #1 Пример преобразования BSON-значения в Legacy Extended JSON-представление методом MongoDB\BSON\toJSON()

<?php

$documents = [
    ['null' => null],
    ['boolean' => true],
    ['string' => 'foo'],
    ['int32' => 123],
    ['int64' => 4294967295],
    ['double' => 1.0],
    ['nan' => NAN],
    ['pos_inf' => INF],
    ['neg_inf' => -INF],
    ['array' => ['foo', 'bar']],
    ['document' => ['foo' => 'bar']],
    ['oid' => new MongoDB\BSON\ObjectId('56315a7c6118fd1b920270b1')],
    ['dec128' => new MongoDB\BSON\Decimal128('1234.5678')],
    ['binary' => new MongoDB\BSON\Binary('foo', MongoDB\BSON\Binary::TYPE_GENERIC)],
    ['date' => new MongoDB\BSON\UTCDateTime(1445990400000)],
    ['timestamp' => new MongoDB\BSON\Timestamp(1234, 5678)],
    ['regex' => new MongoDB\BSON\Regex('pattern', 'i')],
    ['code' => new MongoDB\BSON\Javascript(
        'function() {
            return 1;
        }'
    )],
    ['code_ws' => new MongoDB\BSON\Javascript(
        'function() {
            return a;
        }',
        ['a' => 1]
    )],
    ['minkey' => new MongoDB\BSON\MinKey],
    ['maxkey' => new MongoDB\BSON\MaxKey],
];

foreach ($documents as $document) {
    $bson = MongoDB\BSON\fromPHP($document);
    echo MongoDB\BSON\toJSON($bson), "\n";
}

?>

Результат выполнения приведённого примера:

{ "null" : null }
{ "boolean" : true }
{ "string" : "foo" }
{ "int32" : 123 }
{ "int64" : 4294967295 }
{ "double" : 1.0 }
{ "nan" : nan }
{ "pos_inf" : inf }
{ "neg_inf" : -inf }
{ "array" : [ "foo", "bar" ] }
{ "document" : { "foo" : "bar" } }
{ "oid" : { "$oid" : "56315a7c6118fd1b920270b1" } }
{ "dec128" : { "$numberDecimal" : "1234.5678" } }
{ "binary" : { "$binary" : "Zm9v", "$type" : "00" } }
{ "date" : { "$date" : 1445990400000 } }
{ "timestamp" : { "$timestamp" : { "t" : 5678, "i" : 1234 } } }
{ "regex" : { "$regex" : "pattern", "$options" : "i" } }
{ "code" : { "$code" : "function() { return 1; }" } }
{ "code_ws" : { "$code" : "function() { return a; }", "$scope" : { "a" : 1 } } }
{ "minkey" : { "$minKey" : 1 } }
{ "maxkey" : { "$maxKey" : 1 } }

Смотрите также

MongoDB\BSON\fromJSON() - Возвращает BSON-представление JSON-значения
MongoDB\BSON\toCanonicalExtendedJSON() - Возвращает Canonical Extended JSON-представление BSON-значения
MongoDB\BSON\toRelaxedExtendedJSON() - Возвращает представление BSON-значения в слабом расширенном JSON-формате
» Формат MongoDB Extended JSON
» BSON-типы БД MongoDB

Нашли ошибку?

Инструкция • Исправление • Сообщение об ошибке

＋Добавить

Примечания пользователей

Пользователи ещё не добавляли примечания для страницы