UserGroupsHelper
用于处理用户组的帮助器。
final
| since |
3.6.3 |
|---|---|
| package |
Joomla CMS |
方法
__construct
构造函数
__construct(mixed||string|int groups = [], mode = self::MODE_INSTANCE) :
| since |
3.6.3 |
|---|
参数
- groups
array<string|int, mixed>用户组数组- mode
int该类的运行模式
响应
mixed
count
统计加载的用户组数量。
count() :
| since |
3.6.3 |
|---|
响应
int
get
根据 ID 获取用户组。
get( id) :
| since |
3.6.3 |
|---|
参数
- id
int组标识符
响应
mixed成功时为 stdClass。否则为 false
getAll
获取现有用户组列表。
getAll() : mixed||string|int
| since |
3.6.3 |
|---|
响应
array<string|int, mixed>
getInstance
获取帮助器实例。
getInstance() :
static
| since |
3.6.3 |
|---|
响应
self
has
检查列表中是否存在某个组。
has( id) :
| since |
3.6.3 |
|---|
参数
- id
int组标识符
响应
bool
isSingleton
检查此实例是否为单例。
isSingleton() :
| since |
3.6.3 |
|---|
响应
bool
load
从数据库加载一个组。
load( id) :
| since |
3.6.3 |
|---|
参数
- id
int组标识符
响应
mixed
loadAll
从数据库加载所有用户组。
loadAll() :
| since |
3.6.3 |
|---|
响应
self
populateGroupData
填充特定用户组的数据。
populateGroupData(\stdClass group) : \stdClass
| since |
3.6.3 |
|---|
参数
- group
stdClass组
响应
stdClass
populateGroupsData
填充组的额外信息。
populateGroupsData() : mixed||string|int
| since |
3.6.3 |
|---|
响应
array<string|int, mixed>
setGroups
设置用作来源的用户组。
setGroups(mixed||string|int groups) :
| since |
3.6.3 |
|---|
参数
- groups
array<string|int, mixed>用户组数组。
响应
self
total
获取数据库中可用的用户组总数。
total() :
| since |
3.6.3 |
|---|
响应
int
常量
MODE_SINGLETON
表示当前帮助器实例是单例实例。
| 值 | 1 |
|---|---|
| since |
3.6.3 |
类型
int
MODE_INSTANCE
表示当前帮助器实例是独立类实例。
| 值 | 2 |
|---|---|
| since |
3.6.3 |
类型
int
属性
groups
可用的用户组
| since |
3.6.3 |
|---|
类型
array<string|int, mixed>
mode
该类工作的模式：单例或标准实例
| since |
3.6.3 |
|---|
类型
int
total
可用的组总数
| since |
3.6.3 |
|---|
类型
int