GetList

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

CDBResult
CSocNetUserToGroup::GetList(
	array arOrder = array("ID" => "DESC"),
	array arFilter = array(),
	array arGroupBy = false,
	array arNavStartParams = false,
	array arSelectFields = array()
);

Метод выбирает список отношений между пользователями и группами в соответствии с фильтром. Метод статический.

Параметры

Параметр	Описание
arOrder	Порядок сортировки возвращаемого списка, заданный в виде массива. Ключами в массиве являются поля для сортировки, а значениями - ASC/DESC - порядок сортировки. Допустимые ключи: ID, USER_ID, GROUP_ID, ROLE, DATE_CREATE, DATE_UPDATE, INITIATED_BY_TYPE, INITIATED_BY_USER_ID, GROUP_NAME, GROUP_SITE_ID, GROUP_VISIBLE, GROUP_OWNER_ID, GROUP_OPENED, GROUP_NUMBER_OF_MEMBERS, GROUP_DATE_ACTIVITY, USER_NAME, USER_LAST_NAME, USER_LOGIN, USER_EMAIL, USER_PERSONAL_PHOTO, USER_LID, INITIATED_BY_USER_NAME, INITIATED_BY_USER_LAST_NAME, INITIATED_BY_USER_LOGIN, INITIATED_BY_USER_EMAIL, RAND.
arFilter	Массив, задающий фильтр на возвращаемый список. Ключами в массиве являются названия полей, а значениями - их значения. Допустимые поля: ID, USER_ID, GROUP_ID, ROLE, DATE_CREATE, DATE_UPDATE, INITIATED_BY_TYPE, INITIATED_BY_USER_ID, GROUP_NAME, GROUP_SITE_ID, GROUP_ACTIVE, GROUP_VISIBLE, GROUP_OWNER_ID, GROUP_INITIATE_PERMS, GROUP_OPENED, GROUP_NUMBER_OF_MEMBERS, GROUP_DATE_ACTIVITY, USER_ACTIVE, USER_NAME, USER_LAST_NAME, USER_LOGIN, USER_EMAIL, USER_LID, INITIATED_BY_USER_NAME, INITIATED_BY_USER_LAST_NAME, INITIATED_BY_USER_LOGIN, INITIATED_BY_USER_EMAIL.
arGroupBy	Массив, задающий группировку результирующего списка. Если параметр содержит массив названий полей, то по этим полям будет произведена группировка. Если параметр содержит пустой массив, то метод вернет количество записей, удовлетворяющих фильтру. По умолчанию параметр равен false - не группировать.
arNavStartParams	Массив, задающий условия выбора для организации постраничной навигации.
arSelectFields	Массив, задающий выбираемые поля. Содержит список полей, которые должны быть возвращены методом. Если массив пустой, то выбираются поля: ID, USER_ID, GROUP_ID, ROLE, DATE_CREATE, DATE_UPDATE, INITIATED_BY_TYPE, INITIATED_BY_USER_ID, MESSAGE. В массиве допустимы любые поля из списка полей.

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

Метод возвращает объект типа CDBResult, содержащий записи, удовлетворяющие условию выборки.

Список полей

ID - код записи;
USER_ID - код пользователя;
GROUP_ID - код группы;
ROLE - роль пользователя в группе, значения констант: SONET_ROLES_MODERATOR - модератор, SONET_ROLES_USER - пользователь, SONET_ROLES_BAN - черный список, SONET_ROLES_REQUEST - запрос на вступление, SONET_ROLES_OWNER - владелец;
DATE_CREATE - дата создания записи;
DATE_UPDATE - дата изменения записи;
INITIATED_BY_TYPE - кем инициализирована связь: SONET_INITIATED_BY_USER - пользователем, SONET_INITIATED_BY_GROUP - группой;
INITIATED_BY_USER_ID - код пользователя, инициализировавшего связь;
MESSAGE - сообщение при запросе на создание связи;
GROUP_NAME - название группы;
GROUP_SITE_ID - сайт группы;
GROUP_DESCRIPTION - описание группы;
GROUP_ACTIVE - активность группы;
GROUP_IMAGE_ID - код иконки группы;
GROUP_VISIBLE - видимость группы;
GROUP_OWNER_ID - код пользователя - владельца группы;
GROUP_INITIATE_PERMS - кто может принимать в группу;
GROUP_OPENED - открытость группы;
GROUP_NUMBER_OF_MEMBERS - количество членов группы;
GROUP_DATE_ACTIVITY - дата последней активности в группе;
USER_ACTIVE - активность пользователя;
USER_NAME - имя пользователя;
USER_LAST_NAME - фамилия пользователя;
USER_LOGIN - логин пользователя;
USER_EMAIL - E-Mail пользователя;
USER_PERSONAL_PHOTO - код фотографии пользователя;
USER_LID - сайт пользователя;
INITIATED_BY_USER_NAME - имя пользователя, инициализировавшего связь;
INITIATED_BY_USER_LAST_NAME - фамилия пользователя, инициализировавшего связь;
INITIATED_BY_USER_LOGIN - логин пользователя, инициализировавшего связь;
INITIATED_BY_USER_EMAIL - E-Mail пользователя, инициализировавшего связь;
INITIATED_BY_USER_PHOTO => код фотографии пользователя, инициализировавшего связь;
RAND - случайное число.

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

CDBResult

Примеры использования

<?
$dbRequests = CSocNetUserToGroup::GetList(
	array("USER_LAST_NAME" => "ASC", "USER_NAME" => "ASC"),
	array(
		"GROUP_ID" => $groupId,
		"<=ROLE" => SONET_ROLES_MODERATOR,
		"USER_ACTIVE" => "Y"
	),
	false,
	$arNavParams,
	array("ID", "USER_ID", "DATE_CREATE", "DATE_UPDATE", "USER_NAME", "USER_LAST_NAME", "USER_PERSONAL_PHOTO")
);
while ($arRequests = $dbRequests->GetNext())
{
	. . .
}
?>

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

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

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

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

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.

Наверх