Event — событие модуля
Пространство имен: Bitrix\Main
Модуль: main — подключать отдельно не нужно
Когда использовать
Класс Event хранит код модуля, имя и параметры события. Модуль создает объект события, чтобы обработчики других модулей могли вмешаться в операцию, и вызывает send. Метод EventManager::send вызывает обработчики, а модуль читает их результаты методом getResults.
Обработчик, который получает объект события, читает параметры методом getParameter и возвращает EventResult. Обработчик в режиме совместимости получает значения параметров отдельными аргументами.
Аналоги в классическом API — функции GetModuleEvents и ExecuteModuleEventEx.
Подробнее — в статье События.
Методы класса
| Метод | Описание | С версии |
|---|---|---|
| __construct | Создает событие с кодом модуля, именем, параметрами и фильтром | |
| getModuleId | Возвращает код модуля события | |
| getEventType | Возвращает имя события | |
| getParameters | Возвращает все параметры | |
| setParameters | Заменяет все параметры | |
| getParameter | Возвращает параметр по ключу | |
| setParameter | Записывает параметр по ключу | |
| getFilter | Возвращает фильтр модулей обработчиков | |
| setFilter | Задает фильтр модулей обработчиков | |
| send | Отправляет событие обработчикам | |
| getSender | Возвращает отправителя события | |
| getResults | Возвращает результаты обработчиков | |
| addResult | Добавляет результат обработчика | |
| getExceptions | Возвращает исключения обработчиков в режиме отладки | |
| addException | Добавляет исключение обработчика | |
| turnDebugOn | Включает режим отладки | |
| isDebugOn | Проверяет, включен ли режим отладки | |
| getDebugInfo | Возвращает отладочные данные | |
| addDebugInfo | Добавляет отладочные данные |
Наследование
Реализации
| Класс | Собственные методы |
|---|---|
| ORM\Event | Методы для событий add, update и delete ORM — getEntity, getErrors, mergeFields, mergeObjectFields. Свой конструктор и метод send, который сначала вызывает одноименный метод класса ORM |
Смотрите также
Была ли статья полезна?
Предыдущая
Следующая