Получить ошибку по коду Action::getErrorByCode
Модуль: main — подключать отдельно не нужно
Метод Action::getErrorByCode возвращает ошибку действия с указанным кодом. Метод вызывает ErrorCollection::getErrorByCode для списка ошибок действия.
Сигнатура метода в классе Bitrix\Main\Engine\Action:
final public function getErrorByCode($code)
Параметры
Обязательные параметры обозначены *
| Параметр | Тип | Описание |
|---|---|---|
| code* | string или int |
Задает код ошибки |
Типы в таблице описывают назначение аргументов. Сигнатура PHP не объявляет их.
Возвращаемое значение
Метод возвращает объект Error или null, если ошибки с таким кодом нет.
Примеры
Пример. Код выполняет действие и проверяет, есть ли ошибка с кодом UNKNOWN_UNIT:
<?php
use Bitrix\Main\Engine\Action;
use Bitrix\Main\Engine\Controller;
use Bitrix\Main\Error;
require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';
class UnitViewAction extends Action
{
public function run(string $code)
{
if ($code !== 'kg')
{
$this->addError(new Error('Unknown unit', 'UNKNOWN_UNIT'));
}
return null;
}
}
$controller = (new Controller())->setSourceParametersList([['code' => 'lb']]);
$action = new UnitViewAction('view', $controller);
$action->runWithSourceParametersList();
echo $action->getErrorByCode('UNKNOWN_UNIT')?->getMessage() ?? 'No error';
Код выведет Unknown unit.
Смотрите также
Была ли статья полезна?
Предыдущая
Следующая