Class JHelperUsergroups

Helper to deal with user groups.

Final
Package: Joomla\Libraries\Helper
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Since: 3.6.3
Located at cms/helper/usergroups.php

Methods summary

`public`	# `__construct( array $groups = array(), integer $mode = JHelperUsergroups::MODE_INSTANCE )` Constructor Constructor Parameters `$groups` `array` - $groups Array of groups `$mode` `integer` - $mode Working mode for this class Since 3.6.3
`public integer`	# `count( )` Count loaded user groups. Count loaded user groups. Returns `integer` Since 3.6.3
`public static JHelperUsergroups`	# `getInstance( )` Get the helper instance. Get the helper instance. Returns `JHelperUsergroups` Since 3.6.3
`public mixed`	# `get( integer $id )` Get a user group by its id. Get a user group by its id. Parameters `$id` `integer` - $id Group identifier Returns `mixed` - stdClass on success. False otherwise Since 3.6.3
`public array`	# `getAll( )` Get the list of existing user groups. Get the list of existing user groups. Returns `array` Since 3.6.3
`public boolean`	# `has( integer $id )` Check if a group is in the list. Check if a group is in the list. Parameters `$id` `integer` - $id Group identifier Returns `boolean` Since 3.6.3
`public integer`	# `total( )` Get total available user groups in database. Get total available user groups in database. Returns `integer` Since 3.6.3
`public mixed`	# `load( integer $id )` Load a group from database. Load a group from database. Parameters `$id` `integer` - $id Group identifier Returns `mixed` Since 3.6.3
`public JHelperUsergroups`	# `loadAll( )` Load all user groups from the database. Load all user groups from the database. Returns `JHelperUsergroups` Since 3.6.3
`public stdClass`	# `populateGroupData( stdClass $group )` Populate data for a specific user group. Populate data for a specific user group. Parameters `$group` `stdClass` - $group Group Returns `stdClass` Since 3.6.3
`public JHelperUsergroups`	# `setGroups( array $groups )` Set the groups to be used as source. Set the groups to be used as source. Parameters `$groups` `array` - $groups Array of user groups. Returns `JHelperUsergroups` Since 3.6.3

Magic methods summary

Constants summary

`integer`	`MODE_SINGLETON`	`1`	# Since 3.6.3 Const integer
`integer`	`MODE_INSTANCE`	`2`	# Since 3.6.3 Const integer

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JHelperUsergroups

Methods summary

Parameters

Since

Returns

Since

Returns

Since

Parameters

Returns

Since

Returns

Since

Parameters

Returns

Since

Returns

Since

Parameters

Returns

Since

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Magic methods summary

Constants summary

Since

Const

Since

Const