Правильная работа с Bitrix\Main\Result для обработки ошибок
Проблема
Многие разработчики до сих пор возвращают булевы значения или массивы из своих методов, игнорируя стандартный класс Bitrix\Main\Result. Это приводит к неединообразной обработке ошибок, усложняет отладку и делает код несовместимым с современным API Битрикс.
Решение
Класс Result предоставляет стандартизированный способ возврата результатов операций с возможностью передачи ошибок и данных.
Базовое использование
use Bitrix\Main\Result;
use Bitrix\Main\Error;
function processOrder(int $orderId): Result
{
$result = new Result();
// Проверка существования заказа
if (!$order = getOrder($orderId)) {
$result->addError(new Error('Заказ не найден', 'ORDER_NOT_FOUND'));
return $result;
}
// Проверка статуса
if ($order['STATUS'] === 'PAID') {
$result->addError(new Error('Заказ уже оплачен', 'ORDER_ALREADY_PAID'));
return $result;
}
// Успешная обработка
$result->setData([
'order_id' => $orderId,
'amount' => $order['PRICE'],
'timestamp' => time()
]);
return $result;
}
Проверка результата
$result = processOrder(123);
if ($result->isSuccess()) {
$data = $result->getData();
echo "Заказ обработан: " . $data['order_id'];
} else {
// Получение всех ошибок
foreach ($result->getErrors() as $error) {
echo $error->getCode() . ': ' . $error->getMessage();
}
// Или только первой ошибки
$error = $result->getError();
echo $error->getMessage();
// Или всех сообщений одним массивом
$messages = $result->getErrorMessages();
}
Добавление множественных ошибок
function validateOrderData(array $data): Result
{
$result = new Result();
$errors = [];
if (empty($data['email'])) {
$errors[] = new Error('Email обязателен', 'EMAIL_REQUIRED');
}
if (empty($data['phone'])) {
$errors[] = new Error('Телефон обязателен', 'PHONE_REQUIRED');
}
if (!empty($errors)) {
$result->addErrors($errors);
}
return $result;
}
Передача ошибок между методами
function createUser(array $userData): Result
{
$result = new Result();
// Валидация
$validationResult = validateUserData($userData);
if (!$validationResult->isSuccess()) {
$result->addErrors($validationResult->getErrors());
return $result;
}
// Создание пользователя
// ...
return $result;
}
Дополнительные данные в ошибках
$error = new Error(
'Недостаточно товара на складе',
'INSUFFICIENT_STOCK',
['available' => 5, 'requested' => 10] // customData
);
// Получение дополнительных данных
$customData = $error->getCustomData();
echo "Доступно: " . $customData['available'];
Итог
Использование Result делает код предсказуемым, упрощает обработку ошибок и соответствует стандартам Битрикс. Все современные модули (Sale, Catalog, CRM) используют этот подход.