Получение дополнительных данных для списка элементов

Выборка связанных данных без запросов в цикле и получение сразу только нужных данных

Выполняя даже простые задачи, имеет смысл помнить об эффективности вашего алгоритма.

Получение данных через API чаще всего создаёт запросы к базе данных. Запросы — это затратная операция, которую нужно стремиться минимизировать, несмотря на развитый механизм кеширования в компонентах.

Для исследования темы используем полезнейший инструмент "Отладка". Он покажет количество запросов, которые создаёт компонент.

Посмотрим на работу компонента news.list, выводящего список элементов в простом шаблоне:

Он генерирует всего 4 запроса:

Это часто применяемый компонент для вывода списка чего угодно, хранимого в информационном блоке: статей, обратной связи, обращений и т.д. На его примере и посмотрим на добор данных для элементов в списке.

Для простоты и наглядности используем "старое" API.

Предположим, есть инфоблок с дополнительными данными, "Обзоры". У каждого обзора создано поле для связи с новостями, множественное.

При получении данных для списка элементов типичная ошибка выглядит так, "решение в лоб": в result_modifier.php в цикле по списку элементов с помощью GetList получить связанные элементы.

foreach ($arResult["ITEMS"] as $key => $arItem)
{
    $arResult["ITEMS"][$key]["EXTRA"] = [];
    $res = CIBlockElement::GetList(
        ["ID" => "ASC"],
        [
            "IBLOCK_ID" => ID_IBLOCK_EXTRA, 
            "ACTIVE" => "Y", 
            "PROPERTY_NEWS" => $arItem["ID"]
        ],
        false,
        false,
        [
            "ID", 
            "IBLOCK_ID", 
            "NAME", 
        ]
    );
    while ($row = $res->GetNext())
    {
        $arResult["ITEMS"][$key]["EXTRA"][] = $row;
    }
}

В шаблоне возле текста анонса добавить вывод

<?if(count($arItem["EXTRA"]) > 0):?>
    <p>Дополнительные материалы:</p>
    <ul>
    <?foreach($arItem["EXTRA"] as $key => $itemExtra ):?>
        <li><?=$itemExtra["NAME"]?> </li>
    <?endforeach;?>
    </ul>
<?endif?>

Получится вот так:

Можно увидеть, что запросов стало 16, время на их исполнение заметно увеличилось, и это всего на 10 новостей в списке и простейшем доборе данных. Чем больше элементов выводится, чем больше данных нужно, тем больше будет запросов и затраты времени на выполнение.

Для бОльшей наглядности добавим условие: не все обзоры нужно выводить. Например, нужны только те, у которых в дополнительном поле указан пользователь — автор, у которого пользовательское поле флаг "Проверен" активно. В примере используем двух авторов, один из них с нужным флажком.

Это значит, что в списке новостей должен быть выведен только "Обзор 1" у трех новостей.

Если продолжать решать задачу "в лоб", то получится еще один цикл с запросом, генерируемым GetByID внутри ранее созданного цикла:

foreach ($arResult["ITEMS"] as $key => $arItem)
{
    $arResult["ITEMS"][$key]["EXTRA"] = [];
    $res = CIBlockElement::GetList(
        ["ID" => "ASC"],
        [
            "IBLOCK_ID" => ID_IBLOCK_EXTRA,
            "ACTIVE" => "Y",
            "PROPERTY_NEWS" => $arItem["ID"]
        ],
        false,
        false,
        [
            "ID",
            "IBLOCK_ID",
            "NAME",
            "PROPERTY_AUTHOR",
        ]
    );
    while ($row = $res->GetNext())
    {
        $rsUser = CUser::GetByID($row['PROPERTY_AUTHOR_VALUE']);
        if ($arUser = $rsUser->GetNext())
        {
            if($arUser["UF_VERIFIED"])
            {
                $arResult["ITEMS"][$key]["EXTRA"][] = $row;
            }
        }
    }
}

Это решение уже даст 30 запросов:

Кроме того, если у обзоров автор будет повторяться (что ожидаемо), то будут повторяться одинаковые запросы на получение данных, которые уже пришли в PHP, что совсем не оптимально. А если автор не подходит под условие, то его обзоры вовсе не нужно было отбирать изначально.