Найти ошибку фильтра по коду Base::getErrorByCode

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

Метод Base::getErrorByCode возвращает первую ошибку фильтра с заданным кодом. Метод входит в интерфейс Bitrix\Main\Errorable и вызывает ErrorCollection::getErrorByCode.

Сигнатура метода в классе Bitrix\Main\Engine\ActionFilter\Base:

final public function getErrorByCode($code)

Параметры

Обязательные параметры обозначены *

Параметр Тип Описание
code* int, string Задает код ошибки. Метод сравнивает коды строго, поэтому '10' и 10 — разные коды

Тип в таблице описывает назначение аргумента. Сигнатура PHP не объявляет его.

Возвращаемое значение

Метод возвращает объект Error или null, если ошибки с таким кодом нет.

Примеры

Пример. Код вызывает обработчик фильтра Csrf для запроса без токена и проверяет, добавил ли фильтр ошибку неверного токена:

<?php
use Bitrix\Main\Engine\ActionFilter\Csrf;
use Bitrix\Main\Event;

require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';

$filter = new Csrf(returnNew: false);
$filter->onBeforeAction(new Event('main', 'OnDemoCheck'));

$error = $filter->getErrorByCode(Csrf::ERROR_INVALID_CSRF);
echo $error === null ? 'No error' : $error->getMessage();

Код выведет Invalid csrf token.

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