Result — результат ORM-выборки

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

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

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

Метод getList таблицы ORM и метод exec объекта Query возвращают объект Result. Объект читает строки выборки тремя способами.

  • Методы fetch и fetchAll возвращают строки массивами.
  • Метод fetchObject возвращает строку объектом ORM, например EO_User.
  • Метод fetchCollection возвращает все строки коллекцией объектов.

Класс наследует DB\Result и оборачивает результат запроса к базе данных. Большинство методов передают вызов этому результату. Собственная логика класса — чтение объектов, общий реестр объектов и скрытие служебных полей.

Все способы читают строки из одного курсора. Если вызвать fetchObject, а затем fetch, метод fetch вернет следующую строку. Исключение — запрос с обратной связью OneToMany или ManyToMany. После первого fetchObject такой результат содержит готовые объекты, и смешивать способы чтения нельзя.

Подробнее — в статьях Выборка данных, Объекты и Коллекции.

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

Метод Описание С версии
__construct Создает результат по запросу и результату базы данных
fetch Возвращает следующую строку массивом
fetchAll Возвращает все оставшиеся строки массивом
fetchRaw Возвращает следующую строку без преобразований
fetchObject Возвращает следующую строку объектом ORM
fetchCollection Возвращает все оставшиеся строки коллекцией объектов
getIterator Возвращает итератор для foreach
setIdentityMap Задает реестр объектов
getIdentityMap Возвращает реестр объектов
setHiddenObjectFields Задает поля, которые нужны объекту, но скрыты в массиве
getSelectedRowsCount Возвращает число строк в выборке
setCount Задает общее число строк
getCount Возвращает общее число строк без учета limit
getFields Возвращает описание колонок результата
getResource Возвращает результат драйвера базы данных
getTrackerQuery Возвращает сведения о запросе для отслеживания
getConverters Возвращает функции преобразования значений
setConverters Задает функции преобразования значений
setSerializedFields Задает колонки с сериализованными значениями
setReplacedAliases Задает переименование колонок
addReplacedAliases Добавляет переименование колонок
addFetchDataModifier Добавляет функцию, которая меняет строку

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