MongoDB\Driver\ClientEncryption::addKeyAltName — Добавляет альтернативное имя к документу с ключом

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

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

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

Эта страница описывает член addKeyAltName класса MongoDB\Driver\ClientEncryption, а не одноимённую процедурную функцию. В исходной сигнатуре зафиксированы модификаторы: final, public. Входной контракт: обязательные $keyId, $keyAltName; объявленный результат — object|null.

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

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

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

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

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

Порядок и роли аргументов по сигнатуре: 1. $keyId — MongoDB\BSON\Binary, обязателен; 2. $keyAltName — string, обязателен.

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

1) MongoDB\BSON\Binary $keyId — обязательный: разведите пустую строку, штатное значение и ввод с неожиданной кодировкой или длиной. 2) string $keyAltName — обязательный: разведите пустую строку, штатное значение и ввод с неожиданной кодировкой или длиной.

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

MongoDB\Driver\ClientEncryption::addKeyAltName объявляет результат типа object|null. В результате MongoDB\Driver\ClientEncryption::addKeyAltName присутствует null. Обрабатывайте его отдельной веткой и не используйте нестрогое сравнение, если другие допустимые значения могут быть пустыми.

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

Подготовьте объект MongoDB\Driver\ClientEncryption в минимально допустимом состоянии. Сначала выполните контрольный вызов с обязательным набором MongoDB\BSON\Binary $keyId, string $keyAltName. Необязательных аргументов в этой сигнатуре нет, поэтому меняйте только состояние окружения. Для профиля «хранилище данных» важно явно контролировать соединение, транзакцию и кодировку; негативный сценарий должен проверить пустой результат, отказ соединения и повтор операции.

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

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

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

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

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

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

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

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

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

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

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

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

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