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

GetUserRole

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

mixed
CSocNetUserToGroup::GetUserRole(
	int userID,
	mixed groupID
);

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

Параметры

Параметр Описание С версии
userID Код пользователя.
groupID Код группы, либо (с версии 8.6.4) массив кодов групп.

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

Если в параметре groupID передано скалярное значение, то возвращается одно из следующих значений:
SONET_ROLES_MODERATOR - пользователь является модератором группы (E),
SONET_ROLES_USER - пользователь является членом группы(K),
SONET_ROLES_BAN - пользователь в черном списке группы (T),
SONET_ROLES_REQUEST - направлен запрос на вступление в группу (Z),
SONET_ROLES_OWNER - пользователь является владельцем группы (A),
false - пользователь не связан с данной группой.

Если (с версии 8.6.4) в параметре groupID передан массив кодов групп, то возвращается ассоциативный массив, ключами для которого являются коды групп, а значения соответствуют вышеописанной логике.

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

Возвращает значение констант - $Role вернет "E", т.е. значение SONET_ROLES_MODERATOR.

<? 
	// $UserID - модератор группы $GroupID
	$Role=CSocNetUserToGroup::GetUserRole($UserID,$GroupID);
	echo $Role;
?>


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

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

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

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

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2024, «1С-Битрикс», 2024
Наверх