Добавить ошибку ErrorCollection::setError

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

Метод ErrorCollection::setError добавляет в коллекцию один объект Error. Без ключа метод добавляет ошибку в конец, с ключом — заменяет элемент под этим ключом.

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

public function setError(Error $error, $offset = null)

Параметры

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

Параметр Тип Описание
error* Bitrix\Main\Error Задает ошибку
offset int, string, null Задает ключ элемента. По умолчанию — null, метод добавляет ошибку в конец

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

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

Метод ничего не возвращает.

Примеры

Пример. Код собирает ошибки проверки и выводит их число:

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

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

$fields = ['CODE' => '', 'SORT' => 'abc'];
$errors = new ErrorCollection();

if ($fields['CODE'] === '')
{
    $errors->setError(new Error('Unit code is required', 'UNIT_CODE_EMPTY'));
}
if (!is_numeric($fields['SORT']))
{
    $errors->setError(new Error('Sort must be a number', 'UNIT_SORT_INVALID'));
}

echo count($errors);

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