Документация для разработчиков
Темная тема

GetList

CDBResult
CSearchStatistic::GetList( array arOrder = false, array arFilter = false, array arSelect = false, array bGroup = false );

Метод возвращает список поисковых фраз. Метод статический.

Параметры метода

Параметр Описание
arOrder Массив, содержащий признак сортировки в виде наборов "название поля"=>"направление". Название поля может принимать значение названия любого из полей объекта поисковой статистики. Необязательный параметр.

Значение по умолчанию - false - означает, что результат отсортирован не будет.
arFilter Массив, содержащий фильтр в виде наборов "название поля"=>"значение фильтра". Название поля может принимать значение названия любого из полей объекта поисковой статистики. Необязательный параметр.

Значение по умолчанию - false - означает, что результат отфильтрован не будет.
arSelect Массив, содержащий поля для выборки. Можно указать только те поля, которые необходимы. Необязательный параметр.

Значение по умолчанию - false - означает, что будут возвращены все поля основной таблицы запроса.
bGroup Массив полей, по которым группируются поисковые фразы. Массив имеет вид:
array("название_поля1", "название_поля2", . . .)
В качестве "название_поляN" может стоять любое поле объекта поисковой статистики. Необязательный параметр.
Если массив пустой, то метод вернет число записей, удовлетворяющих фильтру. При bGroup = true в arOrder можно передать COUNT для сортировки по количеству.

Значение по умолчанию - false - означает, что результат группироваться не будет.

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

Возвращается результат запроса типа CDBResult. При выборке из результата методами класса CDBResult становятся доступными поля, перечисленные в параметре arSelect.



© «Битрикс», 2001-2024, «1С-Битрикс», 2024