Result — результат операции

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

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

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

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

Методы, которые сообщают об ошибках через результат, а не через исключение, возвращают объект Result. Объект хранит признак успеха, коллекцию ошибок Error и массив данных. Код, который вызвал метод, проверяет результат методом isSuccess и читает ошибки или данные.

Классы AddResult, UpdateResult и DeleteResult из пространства имен Bitrix\Main\ORM\Data наследуют Result и описывают результаты операций ORM. Валидатор возвращает объект Bitrix\Main\Validation\ValidationResult, тоже наследника Result.

Подробнее — в статье Результаты и ошибки.

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

Метод Описание С версии
__construct Создает успешный результат без ошибок и данных
isSuccess Проверяет, успешна ли операция
addError Добавляет ошибку и делает результат неуспешным
addErrors Добавляет несколько ошибок и делает результат неуспешным, если массив не пустой
getError Возвращает первую ошибку
getErrors Возвращает массив ошибок
getErrorMessages Возвращает массив текстов ошибок
getErrorCollection Возвращает коллекцию ошибок 15.5.9
setData Сохраняет данные результата
getData Возвращает данные результата 14.0.6

Если клонировать объект Result, PHP клонирует и коллекцию ошибок, поэтому ошибки копии не попадают в исходный результат.

Наследники

Класс Собственные методы
Bitrix\Main\ORM\Data\Result getObject, setObject

Наследник Bitrix\Main\ORM\Data\Result переопределяет isSuccess, getErrors и getErrorMessages. Эти методы отмечают, что ошибки прочитаны. Методы getError, getErrorCollection и вызов isSuccess(true) отметку не ставят.

Если код не прочитал ошибки до уничтожения объекта, деструктор выдает предупреждение E_USER_WARNING с текстами ошибок.

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