EventManager — обработчики событий

Пространство имен: Bitrix\Main

Модуль: main — подключать отдельно не нужно

Доступно с версии: 12.0.7

Когда использовать

Класс EventManager связывает события с обработчиками. Объект класса один на запрос, его возвращает getInstance.

Обработчик подключают одним из двух способов:

  • на время запроса — методом addEventHandler, например в init.php или include.php модуля,
  • постоянно — методом registerEventHandler в установщике модуля.

Постоянную регистрацию класс хранит в базе данных, пока ее не удалит unRegisterEventHandler.

Методы без суффикса Compatible передают обработчику объект события Bitrix\Main\Event. Методы с суффиксом Compatible передают значения параметров события отдельными аргументами, как требуют события классического ядра, например OnBeforeUserAdd.

Аналог в классическом API — функции AddEventHandler, RemoveEventHandler, RegisterModuleDependences, UnRegisterModuleDependences и GetModuleEvents.

Подробнее — в статье События.

Методы класса

Методы делятся на четыре группы по назначению.

Объект класса

Метод Описание С версии
getInstance Возвращает объект класса
setInstance Заменяет объект класса

Обработчики на время запроса

Метод Описание С версии
addEventHandler Добавляет обработчик, который получает объект события
addEventHandlerCompatible Добавляет обработчик, который получает параметры события отдельными аргументами
removeEventHandler Удаляет обработчик, добавленный в текущем запросе, по ключу

Постоянная регистрация

Метод Описание С версии
registerEventHandler Сохраняет обработчик в базе данных, обработчик получает объект события
registerEventHandlerCompatible Сохраняет обработчик в базе данных, обработчик получает параметры события отдельными аргументами
unRegisterEventHandler Удаляет регистрацию обработчика из базы данных
clearLoadedHandlers Сбрасывает кеш обработчиков из базы данных

Поиск и отправка

Метод Описание С версии
findEventHandlers Возвращает обработчики события
send Вызывает обработчики события

Смотрите также