グループはユーザーをまとめて扱うための手段です。グループは権限や、ユーザーの組織化、絞り込み、その他のプログラム上の機能のために使われます。

Groupオブジェクトの取得

$group = Group::getByID($groupID)

$group = Group::getByName($groupName)

これらのメソッドはGroupオブジェクトを返します。

Groupオブジェクトのメソッド

$members = $group->getGroupMembers($type = null)

グループに属するUserInfoオブジェクトの配列を取得します。An optional type may be specified, but $type will only ever be non-null if you add users to groups programmatically.

$num = $group->getGroupMembersNum($type = null)

全てのUserInfoオブジェクトを取得することなく、グループ内のユーザー総数を取得することができます。

$group->delete()

ユーザーグループを削除します。

$group->getGroupName()

グループ名を返します。

$group->getGroupDescription()

グループの説明を返します。

$group = Group::add($groupName, $groupDescription)

新しいグループを作成します。

$group->update($groupName, $groupDescription)

グループの名前と説明を更新します。


原文:Groups