Добавить обработчик в режиме совместимости EventManager::addEventHandlerCompatible
Модуль: main — подключать отдельно не нужно
Метод EventManager::addEventHandlerCompatible добавляет обработчик события до конца текущего запроса. В отличие от addEventHandler, обработчик получает не объект события, а значения его параметров отдельными аргументами. Такой формат нужен для событий классического ядра, например OnBeforeUserAdd.
Функция AddEventHandler классического API вызывает этот метод.
Сигнатура метода в классе Bitrix\Main\EventManager:
public function addEventHandlerCompatible($fromModuleId, $eventType, $callback, $includeFile = false, $sort = 100)
Параметры
Обязательные параметры обозначены *
| Параметр | Тип | Описание |
|---|---|---|
| fromModuleId* | string |
Задает код модуля, который отправляет событие |
| eventType* | string |
Задает имя события. Регистр не важен |
| callback* | callable |
Задает обработчик |
| includeFile | string, false |
Задает полный путь к файлу, который метод send подключит перед вызовом обработчика, если файл существует. По умолчанию — false |
| sort | int |
Задает порядок вызова. Метод send вызывает обработчик с меньшим значением раньше. По умолчанию — 100 |
Типы в таблице описывают назначение аргументов. Сигнатура PHP не объявляет их.
Возвращаемое значение
Метод возвращает целочисленный ключ обработчика для removeEventHandler.
Особенности
Метод send передает обработчику значения параметров события по порядку, обработчик не получает ключи параметров.
Примеры
Пример. Код добавляет обработчик, который получает код и сортировку единицы измерения отдельными аргументами:
<?php
use Bitrix\Main\Event;
use Bitrix\Main\EventManager;
require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';
EventManager::getInstance()->addEventHandlerCompatible(
'main',
'OnDemoUnitCreate',
function ($code, $sort)
{
echo $code . ' ' . $sort;
}
);
(new Event('main', 'OnDemoUnitCreate', ['code' => 'kg', 'sort' => 100]))->send();
Код выведет kg 100.
У функции AddEventHandler другой порядок необязательных параметров: сначала сортировка, затем путь к файлу.
Пример. Функция AddEventHandler добавляет такой же обработчик:
<?php
use Bitrix\Main\Event;
require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';
AddEventHandler(
'main',
'OnDemoUnitCreate',
function ($code, $sort)
{
echo $code . ' ' . $sort;
}
);
(new Event('main', 'OnDemoUnitCreate', ['code' => 'kg', 'sort' => 100]))->send();
Код выведет kg 100.