Получить коллекцию ошибок Result::getErrorCollection

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

Доступно с версии: 15.5.9

Метод Result::getErrorCollection возвращает коллекцию ошибок результата. Метод коллекции ErrorCollection::getErrorByCode находит в ней ошибку по коду.

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

public function getErrorCollection()

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

Метод возвращает саму коллекцию ошибок результата ErrorCollection, а не ее копию.

Особенности

Ошибка, которую добавили прямо в коллекцию, не меняет isSuccess. Чтобы результат стал неуспешным, добавляйте ошибки методами addError и addErrors.

Примеры

Пример. Код ищет ошибку по коду:

<?php
use Bitrix\Main\Error;
use Bitrix\Main\Result;

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

$result = new Result();
$result->addError(new Error('Unit code is required', 'UNIT_CODE_EMPTY'));

$error = $result->getErrorCollection()->getErrorByCode('UNIT_CODE_EMPTY');
echo $error === null ? 'No error' : $error->getMessage();

Код выведет Unit code is required.

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