ErrorCollection — коллекция ошибок

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

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

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

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

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

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

Метод Описание С версии
setError Добавляет одну ошибку
add Добавляет несколько ошибок
getErrorByCode Возвращает первую ошибку с заданным кодом

Наследование

Класс наследует Bitrix\Main\Type\Dictionary.

Реализация методов базового класса

Метод Особенность реализации
__construct(?array $values = null) Добавляет переданные ошибки через setError. Если элемент не объект Error, PHP выбрасывает TypeError
offsetSet Запись $collection[] = $error и $collection[$key] = $error добавляет ошибку через setError. Если значение не объект Error, PHP выбрасывает TypeError

Унаследованные методы

Методы get, set, getValues, setValues, clear, toArray, isEmpty, count, jsonSerialize и обход в foreach работают как в классе Bitrix\Main\Type\Dictionary. Метод set с ключом проверяет тип через offsetSet. Методы set с массивом и setValues заменяют содержимое без проверки типа.

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