MongoDB\Driver\ClientEncryption::createDataKey — Создаёт документ с ключом

Назначение MongoDB\Driver\ClientEncryption::createDataKey

MongoDB\Driver\ClientEncryption::createDataKey: Создаёт документ с ключом. Справочная сущность относится к разделу «mongodb». Используйте её, когда это краткое назначение совпадает с задачей приложения; фактическое поведение подтверждайте сигнатурой и проверочным сценарием ниже.

Чем отличается MongoDB\Driver\ClientEncryption::createDataKey

Эта страница описывает член createDataKey класса MongoDB\Driver\ClientEncryption, а не одноимённую процедурную функцию. В исходной сигнатуре зафиксированы модификаторы: final, public. Входной контракт: обязательные $kmsProvider; необязательные $options; объявленный результат — MongoDB\BSON\Binary.

Смысловое направление MongoDB\Driver\ClientEncryption::createDataKey

Смысловое направление MongoDB\Driver\ClientEncryption::createDataKey — «шифрование». В прикладном коде сохраняйте вместе с результатом только необходимые параметры алгоритма, но не секретный ключ. Контрольный набор для этой операции: проверьте повтор с другим nonce или вектором и отказ на недопустимом ключе. Такой акцент отделяет MongoDB\Driver\ClientEncryption::createDataKey от API с похожей сигнатурой, но противоположным действием или другим жизненным циклом.

Сигнатура MongoDB\Driver\ClientEncryption::createDataKey

Структурная запись: final public MongoDB\BSON\Binary MongoDB\Driver\ClientEncryption::createDataKey(string $kmsProvider, array|null $options = null). В ней 2 параметра: обязательные $kmsProvider; необязательные $options. Результат объявлен как MongoDB\BSON\Binary; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры MongoDB\Driver\ClientEncryption::createDataKey

Порядок и роли аргументов по сигнатуре: 1. $kmsProvider — string, обязателен; 2. $options — array|null, необязателен, default null.

Контроль входных данных для MongoDB\Driver\ClientEncryption::createDataKey

1) string $kmsProvider — обязательный: разведите пустую строку, штатное значение и ввод с неожиданной кодировкой или длиной. 2) array|null $options — необязательный: перечислите разрешённые значения и отдельно проверьте конфликтующую комбинацию.

Результат MongoDB\Driver\ClientEncryption::createDataKey

MongoDB\Driver\ClientEncryption::createDataKey объявляет результат типа MongoDB\BSON\Binary. Результат MongoDB\Driver\ClientEncryption::createDataKey имеет объявленный тип MongoDB\BSON\Binary. После вызова проверяйте именно этот контракт и отдельно фиксируйте документированные ошибочные исходы.

Проверочный сценарий для MongoDB\Driver\ClientEncryption::createDataKey

Подготовьте объект MongoDB\Driver\ClientEncryption в минимально допустимом состоянии. Сначала выполните контрольный вызов с обязательным набором string $kmsProvider. Затем отдельно добавьте необязательные параметры array|null $options=null, чтобы увидеть влияние значений по умолчанию. Для профиля «хранилище данных» важно явно контролировать соединение, транзакцию и кодировку; негативный сценарий должен проверить пустой результат, отказ соединения и повтор операции.

Интеграция MongoDB\Driver\ClientEncryption::createDataKey в проект

Храните подготовку MongoDB\Driver\ClientEncryption и вызов MongoDB\Driver\ClientEncryption::createDataKey в одном понятном жизненном цикле; не скрывайте обязательное состояние объекта в глобальной переменной. Для профиля «хранилище данных» вынесите обработку отказа в одну ветку и добавьте к журналу имя операции, версию PHP и безопасные метаданные входа. Не применяйте оператор @: он скрывает диагностический сигнал, необходимый для разбора сбоя. Повторный вызов разрешайте только после явной проверки, что операция MongoDB\Driver\ClientEncryption::createDataKey не создаёт нежелательный повторный эффект в вашем сценарии.

Диагностика MongoDB\Driver\ClientEncryption::createDataKey

Сначала запишите точную сигнатуру final public MongoDB\BSON\Binary MongoDB\Driver\ClientEncryption::createDataKey(string $kmsProvider, array|null $options = null) и фактические типы переданных значений. Затем проверьте состояние экземпляра MongoDB\Driver\ClientEncryption непосредственно перед методом MongoDB\Driver\ClientEncryption::createDataKey. Документация описывает ошибочный исход: отделите его от корректного пустого значения строгой проверкой и сохраните исходную диагностику. После исправления повторите штатный и граничный сценарии, чтобы исключить маскировку ошибки случайным успешным результатом.

Границы применения

Для категории «хранилище данных» применяйте отдельный негативный тест: проверить пустой результат, отказ соединения и повтор операции. В production-коде важно явно контролировать соединение, транзакцию и кодировку. Исходные предупреждения и примечания не копируются на эту страницу: перед решением, влияющим на совместимость или безопасность, сверяйте поведение в целевой версии PHP.

Когда выбирать MongoDB\Driver\ClientEncryption::createDataKey

Выбор MongoDB\Driver\ClientEncryption::createDataKey оправдан, когда одновременно выполнены три условия: 1) объект действительно относится к MongoDB\Driver\ClientEncryption; 2) сигнатура содержит 2 аргумента: обязательных 1, необязательных 1; 3) вызывающему коду нужен результат MongoDB\BSON\Binary и действие «шифрование». Для профиля «хранилище данных» до интеграции отдельно подтвердите применимость правила: «undefined». Если хотя бы один пункт не выполняется, сравните контракт с MongoDB\Driver\Manager::createClientEncryption: у него другое назначение, владелец или набор входных данных.

Сравнение MongoDB\Driver\ClientEncryption::createDataKey с соседними API

Для MongoDB\Driver\ClientEncryption::createDataKey базовый ориентир: создаёт документ с ключом; обязательные $kmsProvider; необязательные $options; результат MongoDB\BSON\Binary. Сопоставление с опубликованными соседями: MongoDB\Driver\Manager::createClientEncryption: создание нового объекта clientencryption; вход — обязательные $options; результат — MongoDB\Driver\ClientEncryption. MongoDB\Driver\ClientEncryption::rewrapManyDataKey: переворачивает ключи данных; вход — обязательные $filter; необязательные $options; результат — object. MongoDB\Driver\ClientEncryption::getKeyByAltName: получает документ с ключом по альтернативному имени; вход — обязательные $keyAltName; результат — object|null. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

Версии и ограничения

В структурной истории исходной записи отмечены версии: 1.20.0, 1.15.0, 1.10.0. MongoDB\Driver\ClientEncryption::createDataKey сверена по закреплённой ревизии php/doc-ru. Перед обновлением PHP повторите тесты типов, предупреждений и граничных значений для этой сущности. Не переносите выводы между версиями без повторного запуска минимального воспроизводимого примера для MongoDB\Driver\ClientEncryption::createDataKey.

Связанные материалы