GetList
Описание и параметры
CDBResult
CSocNetUserRelations::GetList(
array arOrder = array("ID" => "DESC"),
array arFilter = array(),
array arGroupBy = false,
array arNavStartParams = false,
array arSelectFields = array()
);
Метод возвращает список связей между пользователями в соответствии с фильтром. Метод статический.
Параметры
| Параметр | Описание | С версии |
|---|---|---|
| arOrder | Порядок сортировки возвращаемого списка, заданный в виде массива. Ключами в массиве являются поля для сортировки, а значениями - ASC/DESC - порядок сортировки. | |
| arFilter | Массив, задающий фильтр на возвращаемый список. Ключами в массиве являются названия полей, а значениями - их значения. | |
| arGroupBy | Массив, задающий группировку результирующего списка. Если параметр содержит массив названий полей, то по этим полям будет произведена группировка. Если параметр содержит пустой массив, то метод вернет количество записей, удовлетворяющих фильтру. По умолчанию параметр равен false - не группировать. | |
| arNavStartParams | Массив, задающий условия выбора для организации постраничной навигации. | |
| arSelectFields | Массив, задающий выбираемые поля. Содержит список полей, которые должны быть возвращены методом. Если массив пустой, то выбираются поля ID, FIRST_USER_ID, SECOND_USER_ID, RELATION, DATE_CREATE, DATE_UPDATE, MESSAGE, INITIATED_BY. В массиве допустимы любые поля из списка полей. |
Возвращаемое значение
Метод возвращает объект типа CDBResult, содержащий записи, удовлетворяющие условию выборки.
Список полей
ID - код связи,
FIRST_USER_ID - код первого пользователя,
SECOND_USER_ID - код второго пользователя,
RELATION - тип связи: SONET_RELATIONS_FRIEND - пользователи являются друзьями, SONET_RELATIONS_REQUEST - один из пользователей направил другому предложение дружбы, SONET_RELATIONS_BAN - один из пользователей внес другого в черный список,
DATE_CREATE - дата создания связи,
DATE_UPDATE - дата последнего изменения связи,
MESSAGE - сообщение от инициатора связи,
INITIATED_BY - флаг, кем инициирована связь: F - первым пользователем, S - вторым,
FIRST_USER_NAME - имя первого пользователя,
FIRST_USER_LAST_NAME - фамилия первого пользователя,
FIRST_USER_SECOND_NAME - отчество первого пользователя,
FIRST_USER_LOGIN - логин первого пользователя,
FIRST_USER_EMAIL - E-Mail первого пользователя,
FIRST_USER_PERSONAL_PHOTO - код фотографии первого пользователя,
FIRST_USER_LID - сайт первого пользователя,
SECOND_USER_NAME - имя второго пользователя,
SECOND_USER_LAST_NAME - фамилия второго пользователя,
SECOND_USER_SECOND_NAME - отчество второго пользователя,
SECOND_USER_LOGIN - логин второго пользователя,
SECOND_USER_EMAIL - E-Mail второго пользователя,
SECOND_USER_PERSONAL_PHOTO - код фотографии второго пользователя,
SECOND_USER_LID - сайт второго пользователя,
RAND - случайное число.