Задать служебные поля Result::setHiddenObjectFields

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

Метод Result::setHiddenObjectFields задает служебные поля результата. Поля нужны fetchObject, но методы fetch и fetchAll убирают их из строк.

Метод Query::exec вызывает его сам. Если в select нет первичного ключа, запрос добавляет его под служебным именем вида UALIAS_0 и передает имя этому методу. Прикладному коду метод не нужен.

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

public function setHiddenObjectFields($hiddenObjectFields)

Параметры

Обязательные параметры обозначены *

Параметр Тип Описание
hiddenObjectFields* string[] Задает имена колонок результата, которые нужно скрыть

Тип в таблице описывает назначение аргумента. Сигнатура PHP не объявляет его.

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

Метод ничего не возвращает.

Особенности

Метод getIterator не убирает служебные поля. В foreach по результату строки содержат их.

Примеры

Пример. Код выбирает язык без первичного ключа и сравнивает fetchAll и foreach:

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

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

$query = ['select' => ['NAME'], 'filter' => ['=LID' => 'en']];

echo implode(',', array_keys(LanguageTable::getList($query)->fetchAll()[0])) . "\n";

foreach (LanguageTable::getList($query) as $row)
{
    echo implode(',', array_keys($row));
}

Код выведет:

NAME
NAME,UALIAS_0

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