Usergroup Model

Usergroups are simple categorization tools for members. They provide little power independently, but can be used by other applications and within Hero with great purpose. For example, subscriptions promote users to usergroups that can be used to determine a user's access to content.

Initialization

$this->load->model('users/usergroup_model');
// methods at $this->usergroup_model->x();

Method Reference

int new_group (string $name)

Create a new usergroup.

Arguments:

• $name - The usergroup name

boolean update_group (int $group_id , string $name)

Update an existing usergroup's name.

boolean make_default (int $group_id)

Make this usergroup the default usergroup - the group that new registrations are automatically placed into.

boolean delete_group (int $group_id)

Delete a user group. All users will be removed from this group (though they will obviously not be deleted).

int get_default ()

Get the ID of the default usergroup.

array get_group (int $group_id)

Retrieve an array for a usergroup, containing the group's id and name.

array get_usergroups ([array $filters = array()])

Retrieve an array of usergroup(s) with their respective ids and names.

Possible filters:

• id (to retrieve just one group)