Добавить обработчик строки Result::addFetchDataModifier

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

Метод Result::addFetchDataModifier добавляет функцию, которая меняет строку целиком. Метод fetch вызывает функцию для каждой строки после преобразования значений. Функция нужна, например, чтобы добавить в строку вычисляемое значение. Метод вызывает DB\Result::addFetchDataModifier.

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

public function addFetchDataModifier($fetchDataModifier)

Параметры

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

Параметр Тип Описание
fetchDataModifier* callable Задает функцию. Функция принимает строку массивом и возвращает измененную строку. Функция может менять строку по ссылке и ничего не возвращать

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

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

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

Исключения

Исключение Когда возникает
Bitrix\Main\ArgumentException Аргумент — не функция

Особенности

Функция получает строку до того, как fetch уберет служебные поля. Поэтому в строке могут быть колонки вида UALIAS_0.

Примеры

Пример. Код добавляет в строку подпись языка:

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

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

$result = LanguageTable::getList(['select' => ['LID', 'NAME'], 'filter' => ['=LID' => 'en']]);
$result->addFetchDataModifier(
    static function (array $row): array
    {
        $row['LABEL'] = $row['NAME'] . ' (' . $row['LID'] . ')';
        return $row;
    }
);

echo $result->fetch()['LABEL'];

Код выведет English (en).

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