SplObjectStorage::contains — Проверяет, содержит ли хранилище конкретный объект

Назначение SplObjectStorage::contains

SplObjectStorage::contains: Проверяет, содержит ли хранилище конкретный объект. Справочная сущность относится к разделу «SPL». Используйте её, когда это краткое назначение совпадает с задачей приложения; фактическое поведение подтверждайте сигнатурой и проверочным сценарием ниже.

Чем отличается SplObjectStorage::contains

Эта страница описывает член contains класса SplObjectStorage, а не одноимённую процедурную функцию. В исходной сигнатуре зафиксированы модификаторы: #[\Deprecated], public. Входной контракт: обязательные $object; объявленный результат — bool.

Смысловое направление SplObjectStorage::contains

Смысловое направление SplObjectStorage::contains — «проверка условия». В прикладном коде используйте результат как решение конкретного условия, не как замену валидации всей модели. Контрольный набор для этой операции: проверьте истинный, ложный и некорректный по типу вход. Такой акцент отделяет SplObjectStorage::contains от API с похожей сигнатурой, но противоположным действием или другим жизненным циклом.

Сигнатура SplObjectStorage::contains

Структурная запись: #[\Deprecated] public bool SplObjectStorage::contains(object $object). В ней 1 параметр: обязательные $object. Результат объявлен как bool; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры SplObjectStorage::contains

Порядок и роли аргументов по сигнатуре: 1. $object — object, обязателен. Для SplObjectStorage::contains фиксируйте фактические типы входа в тесте и отдельно проверяйте значения на границе допустимого диапазона.

Контроль входных данных для SplObjectStorage::contains

1) object $object — обязательный: проверьте ожидаемый класс, состояние объекта и несовместимую реализацию.

Результат SplObjectStorage::contains

SplObjectStorage::contains объявляет результат типа bool. SplObjectStorage::contains возвращает логическое значение. Назовите ветви успеха и отказа явно и сохраните контекст входных данных для диагностики отрицательного результата.

Проверочный сценарий для SplObjectStorage::contains

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

Интеграция SplObjectStorage::contains в проект

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

Диагностика SplObjectStorage::contains

Сначала запишите точную сигнатуру #[\Deprecated] public bool SplObjectStorage::contains(object $object) и фактические типы переданных значений. Затем проверьте состояние экземпляра SplObjectStorage непосредственно перед методом SplObjectStorage::contains. Если результат неожиданен, сравните его тип с bool и воспроизведите вызов на минимальном входе без подавления предупреждений. После исправления повторите штатный и граничный сценарии, чтобы исключить маскировку ошибки случайным успешным результатом.

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

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

Когда выбирать SplObjectStorage::contains

Выбор SplObjectStorage::contains оправдан, когда одновременно выполнены три условия: 1) объект действительно относится к SplObjectStorage; 2) сигнатура содержит 1 аргумент: обязательных 1, необязательных 0; 3) вызывающему коду нужен результат bool и действие «проверка условия». Для профиля «коллекции и обход» до интеграции отдельно подтвердите применимость правила: «undefined». Если хотя бы один пункт не выполняется, сравните контракт с SplObjectStorage::offsetExists: у него другое назначение, владелец или набор входных данных.

Сравнение SplObjectStorage::contains с соседними API

Для SplObjectStorage::contains базовый ориентир: проверяет, содержит ли хранилище конкретный объект; обязательные $object; результат bool. Сопоставление с опубликованными соседями: SplObjectStorage::offsetExists: проверяет, существует ли объект в контейнере; вход — обязательные $object; результат — bool. SplFileObject::eof: проверяет, достигнут ли конец файла; вход — аргументов нет; результат — bool. SplHeap::valid: проверяет, содержит ли куча ещё элементы; вход — аргументов нет; результат — bool. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

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

В структурной истории исходной записи отмечены версии: 8.5.0. SplObjectStorage::contains сверена по закреплённой ревизии php/doc-ru. В исходной записи присутствует признак устаревания: проверьте альтернативу перед новым использованием. Не переносите выводы между версиями без повторного запуска минимального воспроизводимого примера для SplObjectStorage::contains.

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