- NAME
- METHODS
- is_active([$status])
- remove([\%terms])
- remove_role([\%terms])
- remove_user([\%terms])
- add_role($role, $blog)
- add_user($user)
- load([\%terms, \%args])
- load_iter([\%terms, \%args])
- save()
- user_count()
- user_iter([\%terms, \%args])
- blog_iter([\%terms, \%args])
- role_iter([\%terms, \%args])
- external_id()
- pack_external_id($id)
- unpack_external_id($id)
- AUTHOR & COPYRIGHT
NAME
MT::Group
METHODS
is_active([$status])
Return true if the group is active. As a side-effect, if an argument is passed to this method, it will be used to set the status before performing the check.
remove([\%terms])
Remove the group. Optionally, remove the group(s) by the given terms.
remove_role([\%terms])
Unlink the group-role association and optionally specify a set of terms by which to restrict the operation.
remove_user([\%terms])
Unlink the group-user association and optionally specify a set of terms by which to restrict the operation.
add_role($role, $blog)
Associate this group with the given role and webblog.
add_user($user)
Associate this group with the given user.
load([\%terms, \%args])
Return a list of groups given optional terms and args selection arguments.
load_iter([\%terms, \%args])
Return an object of loaded groups for usage with iteration.
save()
Save the group! If the status of the group has changed, rebuild the permissions.
user_count()
Return the number of members of the group.
user_iter([\%terms, \%args])
Return an object of group user-members for usage with iteration.
blog_iter([\%terms, \%args])
Return an object of group associated blogs for usage with iteration.
role_iter([\%terms, \%args])
Return an object of group associated roles for usage with iteration.
external_id()
Set the value of the external id for this group.
pack_external_id($id)
This function returns the given id as a hexadecimal string.
unpack_external_id($id)
This function returns the given hexadecimal id as an ordinary string.
AUTHOR & COPYRIGHT
Please see "AUTHOR & COPYRIGHT" in MT.