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

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 - случайное число.

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



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

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

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

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

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
0
Владимир Кулаев
Код
define("SONET_RELATIONS_FRIEND", "F"; 
define("SONET_RELATIONS_REQUEST", "Z"; 
define("SONET_RELATIONS_BAN", "B";

Выведем всех друзей пользователя с ID=3434
$arFilter = array("USER_ID" => 3434, 'RELATION' => 'F');

$dbUser = CSocNetUserRelations::GetList(
    $arOrder,
    $arFilter,
    false,
    false,
    $arSelectFields
);

while ($user = $dbUser->GetNext()):
    echo '<pre>'; print_r($user); echo '</pre>'; //
endwhile;



Дамп


Код
Array( [ID] => 11660 [~ID] => 11660 [FIRST_USER_ID] => 6843 [~FIRST_USER_ID] => 6843 [SECOND_USER_ID] => 6837 [~SECOND_USER_ID] => 6837 [RELATION] => Z [~RELATION] => Z [DATE_CREATE] => 18.10.2013 15:17:39 [~DATE_CREATE] => 18.10.2013 15:17:39 [DATE_UPDATE] => 18.10.2013 15:17:39 [~DATE_UPDATE] => 18.10.2013 15:17:39 [MESSAGE] => [~MESSAGE] => [INITIATED_BY] => F [~INITIATED_BY] => F)Array( [ID] => 8553 [~ID] => 8553 [FIRST_USER_ID] => 2934 [~FIRST_USER_ID] => 2934 [SECOND_USER_ID] => 6837 [~SECOND_USER_ID] => 6837 [RELATION] => F [~RELATION] => F [DATE_CREATE] => 08.08.2013 16:31:30 [~DATE_CREATE] => 08.08.2013 16:31:30 [DATE_UPDATE] => 08.08.2013 16:31:30 [~DATE_UPDATE] => 08.08.2013 16:31:30 [MESSAGE] => [~MESSAGE] => [INITIATED_BY] => S [~INITIATED_BY] => S)Array( [ID] => 8552 [~ID] => 8552 [FIRST_USER_ID] => 6824 [~FIRST_USER_ID] => 6824 [SECOND_USER_ID] => 6837 [~SECOND_USER_ID] => 6837 [RELATION] => F [~RELATION] => F [DATE_CREATE] => 08.08.2013 16:31:30 [~DATE_CREATE] => 08.08.2013 16:31:30 [DATE_UPDATE] => 08.08.2013 16:31:30 [~DATE_UPDATE] => 08.08.2013 16:31:30 [MESSAGE] => [~MESSAGE] => [INITIATED_BY] => S [~INITIATED_BY] => S)
© «Битрикс», 2001-2024, «1С-Битрикс», 2024
Наверх