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

GetList

Описание и параметры

CDBResult
GetList(
 [array arOrder [,
 array arFilter [,
 bool bCount ]]]
);

Возвращает список записей по фильтру arFilter, отсортированый в соответствии с arOrder. Метод нестатический.

Параметры функции

ПараметрОписаниеC версии
arOrderМассив вида Array(by1=>order1[, by2=>order2 [, ..]]), где

by - поле для сортировки, может принимать значения
    ID - ID сообщения;
    WORDS - слово;
    PATTERN - шаблон;
    REPLACEMENT - замена;
    DESCRIPTION - описание;
    USE_IT - использовать этот шаблон в фильтре;

order - порядок сортировки, может принимать значения
    ASC - по возрастанию;
    DESC - по убыванию;

Необязательный. По умолчанию равен Array("ID"=>"ASC")
5.1.0
arFilterмассив вида array("фильтруемое поле"=>"значения фильтра" [, ...])
"фильтруемое поле" может принимать значения
    ID - ID сообщения;
    DICTIONARY_ID - ID словаря;
    WORDS - слово;
    PATTERN - шаблон;
    REPLACEMENT - замена;
    DESCRIPTION - описание;
    USE_IT - использовать этот шаблон в фильтре;

фильтруемое поле может содержать перед названием тип проверки фильтра
"!" - не равно
"<" - меньше
"<=" - меньше либо равно
">" - больше
">=" - больше либо равно

Обязательное.
5.1.0
bCountЕсли параметр равен True, то возвращается только количество сообщений, которое соответствует установленному фильтру. Необязательный. По умолчанию равен False. 5.1.0

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

Возвращается объект CDBResult

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



Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2020, «1С-Битрикс», 2020
Наверх