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

GetUserRight

string
CMain::GetUserRight(
 string module_id,
 mixed groups = false,
 string use_default_level = "Y",
 string max_right_for_super_admin = "Y",
 string site_id=false
)

Возвращает право в рамках логики модуля установленное для определённого набора групп (по умолчанию - это группы текущего пользователя).

Как правило в каждом модуле определены свои символы означающие то или иной право, в противном случае используются значения по умолчанию:

  • D - доступ к модулю запрещён
  • R - право на просмотр страниц модуля (без права модификации)
  • W - право на модификацию данных модуля
Установка своего уникального набора прав для каждого модуля осуществляется методом GetModuleRightList класса с именем равным ID модуля. Например для модуля веб-форм, это будет метод form::GetModuleRightList() описаный в файле /bitrix/modules/form/install/index.php. Администрирование прав обычно осуществляется в настройках соответствующего модуля.

Для некоторых модулей (например, "информационные блоки") права устанавливаются индивидуально и к ним данный метод не применим, некоторые модули (например, "компрессия") вовсе не имеют прав доступа.

Примечание. Для любого модуля максимальное право (полный доступ к модулю) всегда обозначается символом W, минимальное право - символом D (доступ к модулю закрыт).

Нестатический метод.

Параметры

ПараметрОписание С версии
module_id ID модуля.
groups Массив групп для которых необходимо определить максимальное право. Если значение - false, то будет взят массив групп текущего пользователя.
Необязательный. По умолчанию - false.
use_default_level Если значение - Y, то для определения максимального уровня прав будет учитываться уровень прав установленный по умолчанию.
Необязательный. По умолчанию - Y.
max_right_for_super_admin Если значение - Y и groups = false, то пользователю входящему в группу администраторов (группа #1) всегда будет возвращаться максимальное право - W, независимо от того какие права установлены в настройках модуля.
Необязательный. По умолчанию - Y.
site_id ID сайта.
Необязательный. По умолчанию - false.
10.0.11

См. также

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

<?
// получим максимальное право доступа к модулю "Веб-формы" для текущего пользователя
if($APPLICATION->GetUserRight("form") <= "D") 
    $APPLICATION->AuthForm("Доступ к модулю запрещён.");
?>


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

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

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

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

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