Event::add — Перевести событие в состояние ожидания

Назначение Event::add

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

Чем отличается Event::add

Эта страница описывает член add класса Event, а не одноимённую процедурную функцию. В исходной сигнатуре зафиксированы модификаторы: public. Входной контракт: необязательные $timeout; объявленный результат — bool.

Смысловое направление Event::add

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

Сигнатура Event::add

Структурная запись: public bool Event::add(float $timeout = значение по умолчанию). В ней 1 параметр: необязательные $timeout. Результат объявлен как bool; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры Event::add

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

Контроль входных данных для Event::add

1) float $timeout — необязательный: зафиксируйте единицу измерения и поведение для нуля, отрицательного и предельного значения.

Результат Event::add

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

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

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

Интеграция Event::add в проект

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

Диагностика Event::add

Сначала запишите точную сигнатуру public bool Event::add(float $timeout = значение по умолчанию) и фактические типы переданных значений. Затем проверьте состояние экземпляра Event непосредственно перед методом Event::add. Если результат неожиданен, сравните его тип с bool и воспроизведите вызов на минимальном входе без подавления предупреждений. После исправления повторите штатный и граничный сценарии, чтобы исключить маскировку ошибки случайным успешным результатом.

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

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

Когда выбирать Event::add

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

Сравнение Event::add с соседними API

Для Event::add базовый ориентир: перевести событие в состояние ожидания; необязательные $timeout; результат bool. Совпадение имени add не делает методы взаимозаменяемыми: Event::add принадлежит Event, а EventBuffer::add — EventBuffer. Сначала определите фактический тип объекта. Сопоставление с опубликованными соседями: EventBuffer::add: добавляет данные в конец буфера событий; вход — обязательные $data; результат — bool. Event::del: перевести событие в пассивное состояние; вход — аргументов нет; результат — bool. Event::signal: создаёт объект события сигнала; вход — обязательные $base, $signum, $cb; необязательные $arg; результат — Event. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

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

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

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