GetList
Описание и параметры
CDBResult
CSocNetMessages::GetList(
array arOrder = array("ID" => "DESC"),
array arFilter = array(),
array arGroupBy = false,
array arNavStartParams = false,
array arSelectFields = array()
);
Метод возвращает список сообщений в соответствии с фильтром. Метод статический.
Параметры
| Параметр | Описание | С версии |
|---|---|---|
| arOrder | Порядок сортировки возвращаемого списка, заданный в виде массива. Ключами в массиве являются поля для сортировки, а значениями - ASC/DESC - порядок сортировки. Допустимые ключи: ID, FROM_USER_ID, TO_USER_ID, DATE_CREATE, DATE_VIEW, MESSAGE_TYPE, FROM_DELETED, TO_DELETED, SEND_MAIL, EMAIL_TEMPLATE, FROM_USER_NAME, FROM_USER_LAST_NAME, FROM_USER_LOGIN, FROM_USER_LID, TO_USER_NAME, TO_USER_LAST_NAME, TO_USER_LOGIN, TO_USER_EMAIL, TO_USER_LID. | |
| arFilter | Массив, задающий фильтр на возвращаемый список. Ключами в массиве являются названия полей, а значениями - их значения. Допустимые поля: ID, FROM_USER_ID, TO_USER_ID, DATE_CREATE, DATE_VIEW, MESSAGE_TYPE, FROM_DELETED, TO_DELETED, SEND_MAIL, EMAIL_TEMPLATE, FROM_USER_NAME, FROM_USER_LAST_NAME, FROM_USER_LOGIN, FROM_USER_LID, TO_USER_NAME, TO_USER_LAST_NAME, TO_USER_LOGIN, TO_USER_EMAIL, TO_USER_LID. | |
| arGroupBy | Массив, задающий группировку результирующего списка. Если параметр содержит массив названий полей, то по этим полям будет произведена группировка. Если параметр содержит пустой массив, то метод вернет количество записей, удовлетворяющих фильтру. По умолчанию параметр равен false - не группировать. | |
| arNavStartParams | Массив, задающий условия выбора для организации постраничной навигации. | |
| arSelectFields | Массив, задающий выбираемые поля. Содержит список полей, которые должны быть возвращены методом. Если массив пустой, то выбираются поля ID, FROM_USER_ID, TO_USER_ID, MESSAGE, DATE_CREATE, DATE_VIEW, MESSAGE_TYPE, FROM_DELETED, TO_DELETED. В массиве допустимы любые поля из списка полей. |
Список полей
ID - идентификатор сообщения,
FROM_USER_ID - код пользователя - отправителя сообщения,
TO_USER_ID - код пользователя - получателя сообщения,
MESSAGE - сообщение,
DATE_CREATE - дата создания сообщения,
DATE_VIEW - дата прочтения,
MESSAGE_TYPE - тип сообщения: SONET_MESSAGE_SYSTEM - системное, SONET_MESSAGE_PRIVATE - пользовательское,
FROM_DELETED - флаг (Y/N) удаления сообщения отправителем,
TO_DELETED - флаг (Y/N) удаления сообщения получателем,
SEND_MAIL - флаг (Y/N) отправки сообщения почтой,
EMAIL_TEMPLATE - почтовый шаблон при помощи которого это сообщение будет отправляться на почту,
FROM_USER_NAME - имя пользователя - отправителя сообщения,
FROM_USER_LAST_NAME - фамилия пользователя - отправителя сообщения,
FROM_USER_LOGIN - логин пользователя - отправителя сообщения,
FROM_USER_PERSONAL_PHOTO - код фотографии пользователя - отправителя сообщения,
FROM_USER_LID - сайт пользователя - отправителя сообщения,
TO_USER_NAME - имя пользователя - получателя сообщения,
TO_USER_LAST_NAME - фамилия пользователя - получателя сообщения,
TO_USER_LOGIN - логин пользователя - получателя сообщения,
TO_USER_EMAIL - E-Mail пользователя - получателя сообщения,
TO_USER_PERSONAL_PHOTO - код фотографии пользователя - получателя сообщения,
TO_USER_LID - сайт пользователя - получателя сообщения.
Возвращаемое значение
Метод возвращает объект типа CDBResult, содержащий записи, удовлетворяющие условию выборки.