Класс MongoDB\BSON\Binary

(mongodb >=1.0.0)

Введение

Тип BSON для бинарных данных (т.е. массива байт). Бинарные значения также имеют подтип, обозначающий, какой тип данных содержится в массиве байт. Подтипы с нуля до 127 предопределены или зарезервированы. Подтипы с 128-255 задаются пользователем.

Обзор классов

final class MongoDB\BSON\Binary implements MongoDB\BSON\BinaryInterface, MongoDB\BSON\Type, Serializable, JsonSerializable, Stringable {

/* Константы */

const int TYPE_GENERIC = 0;

const int TYPE_FUNCTION = 1;

const int TYPE_OLD_BINARY = 2;

const int TYPE_OLD_UUID = 3;

const int TYPE_UUID = 4;

const int TYPE_MD5 = 5;

const int TYPE_ENCRYPTED = 6;

const int TYPE_COLUMN = 7;

const int TYPE_SENSITIVE = 8;

const int TYPE_USER_DEFINED = 128;

/* Методы */

final public __construct(string $data, int $type = MongoDB\BSON\Binary::TYPE_GENERIC)

final public getData(): string

final public getType(): int

final public jsonSerialize(): mixed

final public serialize(): string

final public __toString(): string

final public unserialize(string $data): void

}

Предопределённые константы

MongoDB\BSON\Binary::TYPE_GENERIC

Бинарные данные

MongoDB\BSON\Binary::TYPE_FUNCTION

Функция

MongoDB\BSON\Binary::TYPE_OLD_BINARY

Бинарные данные (объявлена устаревшей, используйте MongoDB\BSON\Binary::TYPE_GENERIC)

MongoDB\BSON\Binary::TYPE_OLD_UUID

Универсальный уникальный идентификатор (объявлена устаревшей. Используйте MongoDB\BSON\Binary::TYPE_UUID). При использовании этого типа, бинарные данные должны быть длиной 16 байт.

Исторически другие значения кодированные этим типов, но другими драйверами, базируются на других конвенциях (например, разный тип порядка байт), что делает его непереносимым. Драйвер PHP не применяет каких-либо обработок для данных этого типа.

MongoDB\BSON\Binary::TYPE_UUID

Универсальный уникальный идентификатор. При использовании этого типа, бинарные данные должны быть длиной 16 байт » RFC 4122.

MongoDB\BSON\Binary::TYPE_MD5

Хеш MD5. При использовании этого типа, бинарные данные должны быть длиной 16 байт.

MongoDB\BSON\Binary::TYPE_ENCRYPTED

Зашифрованное значение. Этот подтип используется для шифрования на стороне клиента.

MongoDB\BSON\Binary::TYPE_COLUMN

Данные столбца. Подтип используется для коллекций временных рядов.

MongoDB\BSON\Binary::TYPE_SENSITIVE

Конфиденциальные данные. Подтип используется для конфиденциальных данных, которые по возможности должны быть исключены из логирования на стороне сервера.

MongoDB\BSON\Binary::TYPE_USER_DEFINED

Пользовательский тип. В то время как типы с 0 по 127 предопределены, либо зарезервированы, типы со 128 по 255 могут использоваться для чего угодно.

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

Версия	Описание
PECL mongodb 1.17.0	Добавлен тип `MongoDB\BSON\Binary::TYPE_SENSITIVE`.
PECL mongodb 1.12.0	Реализует интерфейс Stringable для PHP 8.0+. Добавлен тип `MongoDB\BSON\Binary::TYPE_COLUMN`.
PECL mongodb 1.7.0	Добавлен тип `MongoDB\BSON\Binary::TYPE_ENCRYPTED`.
PECL mongodb 1.3.0	Реализует интерфейс MongoDB\BSON\BinaryInterface.
PECL mongodb 1.2.0	Реализует интерфейсы Serializable и JsonSerializable.

Содержание

MongoDB\BSON\Binary::__construct — Создаёт новый Binary
MongoDB\BSON\Binary::getData — Возвращает данные Binary
MongoDB\BSON\Binary::getType — Возвращает тип Binary
MongoDB\BSON\Binary::jsonSerialize — Возвращает представление, которое можно преобразовать в JSON
MongoDB\BSON\Binary::serialize — Сериализует Binary
MongoDB\BSON\Binary::__toString — Возвращает данные Binary
MongoDB\BSON\Binary::unserialize — Десериализует Binary

add a note

User Contributed Notes

There are no user contributed notes for this page.