modUser.joinGroup

Последнее обновление not available | История страницы | Улучшить эту страницу | Сообщить о проблеме

Support the team building MODX with a monthly donation.

The budget raised through OpenCollective is transparent, including payouts, and any contributor can apply to be paid for their work on MODX.

Backers

Budget

$194 per month—let's make that $500!

Learn more

modUser::joinGroup¶

Сначала метод ищет группу: если её нет, возвращает false и пишет запись в журнал ошибок. Отсутствующая Role даёт тот же результат. Пустой $roleId оставляет роль на значении по умолчанию для колонки.

По умолчанию $rank равен числу записей членства у пользователя. Существующее членство возвращает true и ничего не меняет, поэтому роль и ранг уже члена не перезаписываются. После успешной вставки из сеанса сбрасываются кэши списков id и имён групп.

Синтаксис¶

boolean joinGroup (mixed $groupId [, mixed $roleId = null [, integer $rank = null]])

$groupId (mixed) Имя (string) или id группы, в которую вступаем.
$roleId (mixed) Имя (string) или id Role, по умолчанию null.
$rank (integer) Ранг членства, по умолчанию null — взять число существующих членств.

Пример¶

$user->joinGroup('staff', 'Member');
$user->joinGroup(5, null, 3);

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