Создать событие Event::__construct
Модуль: main — подключать отдельно не нужно
Конструктор Event::__construct создает событие. Конструктор только сохраняет аргументы, а метод send вызывает обработчики.
Сигнатура метода в классе Bitrix\Main\Event:
public function __construct($moduleId, $type, $parameters = array(), $filter = null)
Параметры
Обязательные параметры обозначены *
| Параметр | Тип | Описание |
|---|---|---|
| moduleId* | string |
Задает код модуля, который отправляет событие, например main или vendor.units. Класс EventManager сравнивает код с кодами обработчиков без учета регистра |
| type* | string |
Задает имя события, например OnUnitAdd. Класс EventManager сравнивает имя с именами обработчиков без учета регистра |
| parameters | array или \Closure |
Задает параметры события массивом или замыканием, которое вернет массив. Событие вызывает замыкание при первом обращении к параметрам, в том числе при записи. По умолчанию — пустой массив |
| filter | string, array или null |
Задает коды модулей, обработчики которых нужно вызвать. По умолчанию — null, событие вызывает все обработчики |
Типы в таблице описывают назначение аргументов. Сигнатура PHP не объявляет их.
Исключения
| Исключение | Когда возникает |
|---|---|
Bitrix\Main\ArgumentTypeException |
Аргумент parameters — не массив и не замыкание |
Примеры
Пример. Код создает событие модуля, отправляет его и выводит число результатов:
<?php
use Bitrix\Main\Event;
use Bitrix\Main\EventManager;
use Bitrix\Main\EventResult;
require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';
EventManager::getInstance()->addEventHandler(
'vendor.units',
'OnUnitAdd',
static function (Event $event)
{
return new EventResult(EventResult::SUCCESS);
}
);
$event = new Event('vendor.units', 'OnUnitAdd', ['code' => 'kg']);
$event->send();
echo count($event->getResults());
Код выведет 1.
Смотрите также
Была ли статья полезна?
Предыдущая
Следующая