com_event_sink — Связать сообщения объекта COM с объектом PHP

Назначение com_event_sink

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

Чем отличается com_event_sink

Это процедурная функция раздела «com». Её отличают имя com_event_sink, контракт «обязательные $variant, $sink_object; необязательные $sink_interface» и объявленный результат bool; эти три признака нужно сверять вместе при выборе похожего API.

Смысловое направление com_event_sink

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

Сигнатура com_event_sink

Структурная запись: bool com_event_sink(variant $variant, object $sink_object, array|string|null $sink_interface = null). В ней 3 параметра: обязательные $variant, $sink_object; необязательные $sink_interface. Результат объявлен как bool; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры com_event_sink

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

Контроль входных данных для com_event_sink

1) variant $variant — обязательный: передавайте значение точного объявленного типа и добавьте отдельный тест для доменной границы. 2) object $sink_object — обязательный: проверьте ожидаемый класс, состояние объекта и несовместимую реализацию. 3) array|string|null $sink_interface — необязательный: разведите тесты для пустого набора, одного элемента и неоднородных значений.

Результат com_event_sink

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

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

Убедитесь, что раздел «com» доступен в целевой сборке PHP. Сначала выполните контрольный вызов с обязательным набором variant $variant, object $sink_object. Затем отдельно добавьте необязательные параметры array|string|null $sink_interface=null, чтобы увидеть влияние значений по умолчанию. Для профиля «метаданные и объектная модель» важно не подменять проверку контракта предположением о конкретной реализации; негативный сценарий должен проверить наследование, недоступный член и различия модификаторов.

Интеграция com_event_sink в проект

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

Диагностика com_event_sink

Сначала запишите точную сигнатуру bool com_event_sink(variant $variant, object $sink_object, array|string|null $sink_interface = null) и фактические типы переданных значений. Затем подтвердите загрузку расширения «com» в той же среде, где выполняется com_event_sink. Если результат неожиданен, сравните его тип с bool и воспроизведите вызов на минимальном входе без подавления предупреждений. После исправления повторите штатный и граничный сценарии, чтобы исключить маскировку ошибки случайным успешным результатом.

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

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

Когда выбирать com_event_sink

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

Сравнение com_event_sink с соседними API

Для com_event_sink базовый ориентир: связать сообщения объекта com с объектом php; обязательные $variant, $sink_object; необязательные $sink_interface; результат bool. Сопоставление с опубликованными соседями: com_print_typeinfo: печатает определение класса php для интерфейса, наследующего idispatch; вход — обязательные $variant; необязательные $dispatch_interface, $display_sink; результат — bool. com_message_pump: обработка сообщений com, пришедших не позднее timeoutms миллисекунд после её запуска; вход — необязательные $timeout_milliseconds; результат — bool. com_get_active_object: вернуть дескриптор на уже запущенный экземпляр объекта com; вход — обязательные $prog_id; необязательные $codepage; результат — variant. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

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

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

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