MongoDB\BSON\toCanonicalExtendedJSON

(mongodb >=1.3.0)

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

Внимание

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

Описание

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

Метод преобразовывает BSON-строку в представление » в каноническом расширенном JSON-формате. В каноническом формате в ущерб краткости вывода отдают преимущество точности типов. В каноническом формате создают данные вывода, которым доступно преобразование обратно в BSON-формат без потери информации о типе, например, числовые типы останутся дифференцированными.

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

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

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

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

Ошибки

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

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

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

Примеры

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

<?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\toCanonicalExtendedJSON($bson), "\n";
}

?>

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

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

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

MongoDB\BSON\Document::fromJSON() - Создаёт новый экземпляр документа из JSON-строки
MongoDB\BSON\Document::toCanonicalExtendedJSON() - Возвращает Canonical Extended JSON-представление BSON-документа
MongoDB\BSON\fromJSON() - Возвращает BSON-представление JSON-значения
MongoDB\BSON\toRelaxedExtendedJSON() - Возвращает представление BSON-значения в слабом расширенном JSON-формате
» Спецификация формата Extended JSON
» BSON-типы БД MongoDB

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

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

＋Добавить

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

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