Механизм ResultModifier в 1С-Битрикс: настройка вывода компонента

Расширенные примеры использования модификатора результата

Ниже приведены подробные сценарии с кодом и ожидаемым результатом. Каждый пример демонстрирует типовую задачу и способы ее решения.

Пример 1: Добавление пользовательских свойств (UF) в результат компонента каталога

Задача: в компоненте bitrix:catalog (список элементов) отсутствуют некоторые UF-поля. Через result_modifier.php добавим их.

<?php
if (!defined('B_PROLOG_INCLUDED') || B_PROLOG_INCLUDED!==true) die();

CModule::IncludeModule('iblock');

// Получаем UF-поля для элементов инфоблока
$entityId = 'IBLOCK_' . $arParams['IBLOCK_ID'] . '_SECTION';
$userFields = $GLOBALS['USER_FIELD_MANAGER']->GetUserFields($entityId);

foreach ($arResult['ITEMS'] as &$item) {
    $item['UF_FIELDS'] = [];
    foreach ($userFields as $fieldName => $field) {
        $item['UF_FIELDS'][$fieldName] = $item['PROPERTIES'][$fieldName]['VALUE'] ?? '';
    }
}
unset($item);
?>

Результат: каждый элемент теперь содержит массив UF_FIELDS со значениями пользовательских полей. Вывод в шаблоне:

[ITEM] => [
    [ID] => 123
    [NAME] => Товар
    [UF_FIELDS] => [
        [UF_PRICE] => 2500
        [UF_BRAND] => Sony
    ]
]

Пример 2: Фильтрация элементов по свойству, не доступному в параметрах компонента

Допустим, нужно вывести только те новости, у которых свойство IS_MAIN равно Y. В компоненте bitrix:news.list нет соответствующего фильтра. Модификатор удаляет ненужные элементы:

if (!defined('B_PROLOG_INCLUDED') || B_PROLOG_INCLUDED!==true) die();

foreach ($arResult['ITEMS'] as $key => $item) {
    if ($item['PROPERTIES']['IS_MAIN']['VALUE'] !== 'Y') {
        unset($arResult['ITEMS'][$key]);
    }
}
$arResult['ITEMS'] = array_values($arResult['ITEMS']); // переиндексация

Результат: в массиве остаются только элементы с IS_MAIN = Y. Важно переиндексировать массив, чтобы избежать пропусков ключей.

Пример 3: Добавление постраничной навигации на основе другого запроса

Иногда требуется подмешать в результат компонента собственную пагинацию, например, для элементов из соседнего инфоблока. Используем CPHPOption или прямое создание объекта CDBResult:

if (!defined('B_PROLOG_INCLUDED') || B_PROLOG_INCLUDED!==true) die();

CModule::IncludeModule('iblock');

$nav = new \Bitrix\Main\UI\PageNavigation('nav-clients');
$nav->allowAllRecords(true)->setPageSize(10)->initFromUri();

$query = CIBlockElement::GetList(
    ['SORT' => 'ASC'],
    ['IBLOCK_ID' => 7, 'ACTIVE' => 'Y'],
    false,
    $nav->getNavParams(),
    ['ID', 'NAME', 'PREVIEW_TEXT']
);

$items = [];
while ($el = $query->Fetch()) {
    $items[] = $el;
}
$arResult['ADDITIONAL_ITEMS'] = $items;
$arResult['ADDITIONAL_NAV'] = $nav;

В шаблоне выводится навигация через $arResult['ADDITIONAL_NAV'].

Пример 4: Объединение данных из нескольких копий одного компонента

На странице могут быть два вызова bitrix:news.list с разными фильтрами. Требуется объединить их результаты в один массив. Решение через событие OnBeforeResultModifier с подсчетом вызовов:

$callCounter = 0;

function mergeNewsLists(\Bitrix\Main\Event $event) {
    global $callCounter;
    $params = $event->getParameters();
    $arResult = &$params[1];
    $componentName = $params[0]->getName();
    
    if ($componentName === 'bitrix:news.list') {
        $callCounter++;
        if ($callCounter === 1) {
            // сохраняем первый результат
            $GLOBALS['firstListResult'] = $arResult['ITEMS'];
        } elseif ($callCounter === 2) {
            // сливаем со вторым
            $arResult['ITEMS'] = array_merge($GLOBALS['firstListResult'], $arResult['ITEMS']);
        }
    }
}

Этот подход хрупкий, но демонстрирует возможности событийной модели.

Пример 5: Изменение URL через result_modifier.php для компонента bitrix:menu

Компонент bitrix:menu формирует массив пунктов. Допустим, требуется добавить к ссылкам параметр ?from=menu:

if (!defined('B_PROLOG_INCLUDED') || B_PROLOG_INCLUDED!==true) die();

foreach ($arResult as &$item) {
    if (isset($item['LINK'])) {
        $item['LINK'] .= (strpos($item['LINK'], '?') === false ? '?' : '&') . 'from=menu';
    }
    if (!empty($item['ITEMS'])) {
        // рекурсивный обход подменю
        foreach ($item['ITEMS'] as &$sub) {
            $sub['LINK'] .= (strpos($sub['LINK'], '?') === false ? '?' : '&') . 'from=menu';
        }
        unset($sub);
    }
}
unset($item);

Результат: все ссылки меню будут содержать ?from=menu.

Пример 6: Динамическое добавление блока рекламы в список новостей

Вставить рекламный блок после каждого 3-го элемента. В result_modifier.php модифицируем структуру:

if (!defined('B_PROLOG_INCLUDED') || B_PROLOG_INCLUDED!==true) die();

$newItems = [];
$counter = 0;
foreach ($arResult['ITEMS'] as $item) {
    $newItems[] = $item;
    $counter++;
    if ($counter % 3 === 0) {
        $newItems[] = [
            'TYPE' => 'AD',
            'AD_CODE' => '<div class="ad-banner">Реклама</div>'
        ];
    }
}
$arResult['ITEMS'] = $newItems;

Шаблон проверяет $item['TYPE'] и выводит рекламу.

Все примеры показывают, как гибко можно адаптировать результат работы компонента под конкретные требования. Каждый случай требует понимания структуры $arResult и осторожности при изменении данных, используемых шаблоном.