Result — результат запроса к базе данных

Пространство имен: Bitrix\Main\DB

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

Доступно с версии: 12.0.7

Когда использовать

Класс Result описывает результат SQL-запроса. Объект возвращает метод Connection::query, создавать его конструктором не нужно. Наследник Bitrix\Main\ORM\Query\Result возвращает getList ORM-классов, поэтому методы Result работают и для результатов ORM.

Строки читают методами fetch и fetchAll или в цикле foreach. При выборке fetch превращает значения дат в объекты Bitrix\Main\Type\Date и Bitrix\Main\Type\DateTime. Метод fetchRaw возвращает строку без преобразований.

Аналог в классическом API — класс CDBResult.

Методы класса

Таблицы ниже группируют методы по задачам.

Чтение строк

Метод Описание С версии
fetch Возвращает следующую строку с преобразованными значениями 14.0.0
fetchAll Возвращает все оставшиеся строки массивом 14.0.0
fetchRaw Возвращает следующую строку без преобразований 15.5.1
getIterator Возвращает итератор для обхода результата в foreach

Сведения о результате

Метод Описание С версии
getSelectedRowsCount Возвращает число строк в результате 14.0.0
getFields Возвращает описание колонок результата объектами полей ORM 14.5.2
getFieldsCount Возвращает число колонок в результате
getLength Возвращает размер последней прочитанной строки в байтах
hasBigFields Проверяет, есть ли в результате колонки больших типов
getResource Возвращает результат запроса драйвера базы данных 14.0.0
getTrackerQuery Возвращает сведения о запросе для отслеживания 14.0.0
setCount Задает общее число строк 15.5.10
getCount Возвращает общее число строк, заданное через setCount 15.5.10

Преобразование строк

Метод Описание С версии
getConverters Возвращает функции преобразования значений колонок
setConverters Задает функции преобразования значений колонок
setSerializedFields Задает колонки, значения которых нужно десериализовать 14.0.0
setReplacedAliases Задает переименование колонок в строке 14.0.0
addReplacedAliases Добавляет переименование колонок к заданному 14.9.2
addFetchDataModifier Добавляет функцию, которая меняет строку при выборке 14.5.1

Наследование

Класс Result реализует интерфейс IteratorAggregate, поэтому объект можно обходить в foreach.

Реализации

Класс Источник данных Собственные методы
MysqliResult Результат запроса MySQL через расширение mysqli Нет
PgsqlResult Результат запроса PostgreSQL Нет
ArrayResult Массив строк, переданный в конструктор Нет
Bitrix\Main\ORM\Query\Result Результат запроса ORM. Передает вызовы объекту Result соединения Методы для работы с объектами ORM

Что реализовать в наследнике

Наследник реализует абстрактные методы getFields и getSelectedRowsCount. Защищенный абстрактный метод fetchRowInternal код приложения не вызывает, но наследник обязан его реализовать. Метод возвращает следующую строку ассоциативным массивом или false, если строк больше нет.

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