MongoDB\Driver\WriteResult::getMatchedCount — Возвращает количество документов, которые сервер выбрал для обновления

Назначение MongoDB\Driver\WriteResult::getMatchedCount

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

Чем отличается MongoDB\Driver\WriteResult::getMatchedCount

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

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

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

Сигнатура MongoDB\Driver\WriteResult::getMatchedCount

Структурная запись: final public int MongoDB\Driver\WriteResult::getMatchedCount(). В ней 0 параметров: аргументов нет. Результат объявлен как int; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры MongoDB\Driver\WriteResult::getMatchedCount

MongoDB\Driver\WriteResult::getMatchedCount не принимает аргументов: вызов выполняют с пустым списком параметров.

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

MongoDB\Driver\WriteResult::getMatchedCount не принимает аргументов. Качество вызова определяется состоянием объекта или окружения: зафиксируйте версию PHP, доступность расширения «mongodb» и исходное состояние до выполнения, затем сравните наблюдаемый результат после вызова.

Результат MongoDB\Driver\WriteResult::getMatchedCount

MongoDB\Driver\WriteResult::getMatchedCount объявляет результат типа int. Числовой результат MongoDB\Driver\WriteResult::getMatchedCount имеет тип int. Не назначайте специальный смысл нулю или отрицательному значению, пока он не следует из документированного контракта.

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

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

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

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

Диагностика MongoDB\Driver\WriteResult::getMatchedCount

Сначала запишите точную сигнатуру final public int MongoDB\Driver\WriteResult::getMatchedCount() и фактические типы переданных значений. Затем проверьте состояние экземпляра MongoDB\Driver\WriteResult непосредственно перед методом MongoDB\Driver\WriteResult::getMatchedCount. Документация описывает ошибочный исход: отделите его от корректного пустого значения строгой проверкой и сохраните исходную диагностику. После исправления повторите штатный и граничный сценарии, чтобы исключить маскировку ошибки случайным успешным результатом.

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

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

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

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

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

Для MongoDB\Driver\WriteResult::getMatchedCount базовый ориентир: возвращает количество документов, которые сервер выбрал для обновления; аргументов нет; результат int. Совпадение имени getMatchedCount не делает методы взаимозаменяемыми: MongoDB\Driver\WriteResult::getMatchedCount принадлежит MongoDB\Driver\WriteResult, а MongoDB\Driver\BulkWriteCommandResult::getMatchedCount — MongoDB\Driver\BulkWriteCommandResult. Сначала определите фактический тип объекта. Сопоставление с опубликованными соседями: MongoDB\Driver\BulkWriteCommandResult::getMatchedCount: возвращает количество документов, которые сервер выбрал для обновления; вход — аргументов нет; результат — int. MongoDB\Driver\WriteResult::getModifiedCount: возвращает количество существующих обновлённых документов; вход — аргументов нет; результат — int. MongoDB\Driver\WriteResult::isAcknowledged: возвращает, была ли запись подтверждена; вход — аргументов нет; результат — bool. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

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

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

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