Проверить, есть ли агрегатная функция ExpressionField::isAggregated

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

Метод ExpressionField::isAggregated проверяет, есть ли в выражении агрегатная функция, например COUNT, SUM или MAX. Если есть, запрос группирует строки по остальным полям select, order и условий HAVING и переносит условия по полю в HAVING. Если такое условие стоит в фильтре с LOGIC => OR, запрос переносит в HAVING весь фильтр.

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

public function isAggregated()

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

Метод возвращает true, если checkAggregation нашел агрегатную функцию в getFullExpression, иначе false. Метод не учитывает функции внутри подзапросов (SELECT ...).

Особенности

  • Метод запоминает результат.
  • Оконные функции с OVER, а также RANK, FIRST, LAST и похожие метод считает агрегатными. Выражение с ними включит автоматическую группировку.
  • Если в buildFrom есть поля, метод работает только после привязки к сущности.

Примеры

Пример. Код проверяет два выражения:

<?php
use Bitrix\Main\Localization\LanguageTable;
use Bitrix\Main\ORM\Fields\ExpressionField;

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

$query = LanguageTable::query()
    ->registerRuntimeField(new ExpressionField('CNT', 'COUNT(*)'))
    ->registerRuntimeField(new ExpressionField('NAME_LEN', 'LENGTH(%s)', 'NAME'));

$entity = $query->getEntity();

var_export([$entity->getField('CNT')->isAggregated(), $entity->getField('NAME_LEN')->isAggregated()]);

Код выведет:

array (
  0 => true,
  1 => false,
)

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