EventResult — результат обработчика события

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

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

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

Обработчик события возвращает объект EventResult, чтобы передать тип результата и данные коду, который отправил событие. Этот код получает результаты всех обработчиков методом Event::getResults и решает, что делать дальше, например прервать операцию при ошибке.

Если обработчик вернул не EventResult, а другое значение, класс EventManager создает объект сам. Тип результата при этом UNDEFINED, а возвращенное значение становится данными результата. Класс EventManager не добавляет в список результатов пустые значения null, false, 0, пустую строку и пустой массив.

Обработчики событий ORM возвращают наследника Bitrix\Main\ORM\EventResult.

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

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

Метод Описание С версии
__construct Создает результат с типом, данными, кодом модуля и обработчиком
getType Возвращает тип результата
getParameters Возвращает данные результата
getModuleId Возвращает код модуля обработчика
getHandler Возвращает значение, которое передали в параметре handler конструктора

Метод getResultType устарел. Он продолжает работать и возвращает то же, что getType. Для нового кода используйте getType.

Константы

Константа Значение Описание
UNDEFINED 0 Тип результата не задан. Такой тип получает значение, которое EventManager обернул в EventResult
SUCCESS 1 Обработчик выполнился успешно
ERROR 2 Обработчик вернул ошибку

Класс не проверяет тип и не меняет поведение ядра. Смысл каждого типа определяет код, который отправил событие и читает результаты.

Наследники

Класс Собственные методы
Bitrix\Main\ORM\EventResult setErrors, addError, getErrors, modifyFields, getModified, unsetFields, unsetField, getUnset

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