Получить строку объектом Result::fetchObject

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

Метод Result::fetchObject возвращает следующую строку выборки объектом ORM, например EO_User. Объект содержит значения полей из select, а значения связей — связанными объектами. Объект можно изменить и сохранить методом save.

Сигнатура метода в классе Bitrix\Main\ORM\Query\Result:

final public function fetchObject()

Возвращаемое значение

Метод возвращает объект класса сущности или null, если строк больше нет.

Исключения

Исключение Когда возникает
Bitrix\Main\SystemException Запрос группирует строки, например содержит group или агрегат вместе с обычными полями
Bitrix\Main\SystemException В выборке нет первичного ключа основной или связанной сущности, например select содержит только агрегаты или запрос использует DISTINCT

Особенности

  • При выполнении запрос сам добавляет в select первичные ключи основной и присоединенных сущностей, если их нет. Исключение — запросы с агрегатами и DISTINCT. Методы fetch и fetchAll не показывают эти колонки.
  • Если в запросе — в select, filter или order — есть обратная связь OneToMany или ManyToMany, первый вызов читает все строки и собирает по одному объекту на первичный ключ. Следующие вызовы возвращают готовые объекты. При limit или фильтре по связи коллекция связи может быть неполной.
  • Метод берет объект из реестра getIdentityMap, если объект с тем же первичным ключом там уже есть, в том числе в реестре, общем для нескольких выборок. Значения из строки перезаписывают значения объекта.
  • Метод приводит значения полей-выражений ExpressionField к типу из configureValueType.

Примеры

Пример. Код читает язык объектом:

<?php
use Bitrix\Main\Localization\LanguageTable;

require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';

$language = LanguageTable::getList([
    'select' => ['LID', 'NAME'],
    'filter' => ['=LID' => 'en'],
])->fetchObject();

echo get_class($language) . ' ' . $language->getLid() . ' ' . $language->getName();

Код выведет Bitrix\Main\Localization\EO_Language en English.

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