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

GetList

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

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

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

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

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

by - поле для сортировки, может принимать значения
    ID - ID сообщения;
    AUTHOR_ID - ID автора сообщения;
    POST_DATE - дата создания сообщения;
    POST_SUBJ - тема сообщения;
    POST_MESSAGE - текст сообщения;
    USER_ID - ID получателя сообщения (владельца);
    FOLDER_ID - ID папки;
    IS_READ - метка о прочтении сообщения;
    USE_SMILES - метка о разрешении использования смайликов как рисунков;
    AUTHOR_NAME - имя автора сообщения;

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

Необязательный. По умолчанию равен Array("ID"=>"ASC")
arFilterмассив вида array("фильтруемое поле"=>"значения фильтра" [, ...])
"фильтруемое поле" может принимать значения
    ID - ID сообщения;
    AUTHOR_ID - ID автора сообщения;
    POST_SUBJ - тема сообщения;
    POST_MESSAGE - текст сообщения;
    USER_ID - ID получателя сообщения (владельца);
    FOLDER_ID - ID папки;
    IS_READ - метка о прочтении сообщения;

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

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

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

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

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



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