Перебор ответа от базы данных в старом ядре

Любой запрос к базе данных с использованием Api Битрикса, будь то GetList(), GetByID() или любой другой, в качестве ответа возвращает специальный объект, содержащий данные, выбранные из базы данных. Этот объект, класс CDBResult, у которого, как и любого другого уважающего себя объекта, есть набор методов, с помощью которых можно обращаться к нему ссылка на документацию. С помощью этих методов можно узнать количество выбранных записей, получить постраничную навигацию и другие результаты запроса. Однако нас интересуют методы, с помощью которых можно получать непосредственно сами данные из этого объекта.

Для получения данных из объекта есть три метода:

1. Fetch()
2. GetNext()
3. GetNextElement()

У объекта CDBResultнет метода GetNextElement(), в этой статье мы рассмотрим наследника этого класса, а именно - CIBlockResult. Выбор пал на него по нескольким причинам: во первых, чаще всего вы будете иметь дело с элементами Инфоблоков, где именно этот объект возвращается при запросе методом GetList().  Во-вторых, рассмотрев более частную реализацию объекта, мы охватим и более общий случай.

Что делают методы

// Из одного поля NAME в массиве получили два
$data = [
    'NAME' => 'Функция GetNext',
    '~NAME' => 'Функция GetNext'
]

public function GetNext($bTextHtmlAuto=true, $use_tilda=true)

public function GetNextElement($bTextHtmlAuto=true, $use_tilda=true)

Теперь, досконально зная каждую из трех функций-близнецов, можно определить, когда нужно применять одну, а когда другую.

• Чаще всего применяйте метод GetNext() для получения html-безопасного вида значений полей и ссылок на страницы элементов или разделов инфоблока
• Применяйте метод Fetch(), если вам не нужно ни то, ни другое
• Не применяйте метод GetNextElement(), кроме тех случаев, когда вы на 100% уверены, что нужен именно он

Этот порядок ставит вопрос о том, зачем тогда нужен метод GetNextElement()? Этот метод нужен скорее для максимальный гибкости и настраиваемости, чем для оптимизации и производительности. Он используется в компоненте списка новостей именно для супер-настраиваемости. Создавая свой компонент, скорее всего, вы стремитесь к высокой производительности, поэтому в данном случае этот метод не рекомендуется. Причина заключается в том, что для получения свойств вам придется делать дополнительные запросы в БД, а это совсем не к чему.

Функция Fetch()

• Возвращает ассоциативный массив полей и свойств элемента из выборки, сдвигая указатель в ней на следующий элемент. Либо возвращает false, если элементов больше нет
• Не принимает никаких параметров
• Использовать этот метод следует тогда, когда не нужно html-безопасное преобразование и/или ссылки

Функция GetNext()

• Делает то же, что и Fetch(), дополнительно преобразует поля в html-безопасный вид. Добавляет поля с тильдой (без преобразования к безопасному виду) и преобразует url шаблоны в реальные ссылки, подставляя в них данные
• Принимает два параметра: boolean для включения/выключения преобразования полей в html-безопасный вид и boolean для включения/выключения полей с тильдой
• Чаще всего нужно использовать этот метод

Функция GetNextElement()

• Делает то же, что и GetNext(), только возвращает объект, а не массив, для большей гибкости
• Принимает те же параметры, что и GetNext()
• Применять только в тех случаях, когда нужен именно объект _CIBElement, и больше никогда

Примеры

Чтобы правильно применять эти методы чаще всего нужно использовать цикл while. До тех пор, пока выбранный метод не вернет false.

GetNext()

$items = [];
$dbItems = CIBlockElement::GetList(... Тут параметры ...);
while ($item = $dbItem->GetNext()) {
    // как-то обрабатываем массив $item
    ...
    // формируем итоговый список элементов
    $items[] = $item;
}

Fetch()

$items = [];
$dbItems = CIBlockElement::GetList(... Тут параметры ...);
while ($item = $dbItem->Fetch()) {
    // как-то обрабатываем массив $item
    ...
    // формируем итоговый список элементов
    $items[] = $item;
}

GetNextElement()

while ($item = $dbItem->GetNextElement()) {
  $element = $item->GetFields();
  $element['PROPERTIES'] = $item->GetProperties();
  // как-то обрабатываем массив $element
  ...
  // формируем итоговый список элементов
  $items[] = $element;
}