/sources/ocf_groups.php

Description
Functions
get_first_default_group (line 63)

Find the first default group.

  • return: The first default group.
GROUP get_first_default_group ()
init__ocf_groups (line 24)

Standard code module initialisation function.

void init__ocf_groups ()
ocf_ensure_groups_cached (line 97)

Ensure a list of usergroups are cached in memory.

void ocf_ensure_groups_cached (mixed $groups)
  • mixed $groups: The list of usergroups (array) or '*'.
ocf_get_all_default_groups (line 75)

Get a list of the default usergroups (the usergroups a member is put in when they join).

  • return: The list of default IDs.
array ocf_get_all_default_groups ([boolean $include_primary = false])
  • boolean $include_primary: Whether to include the default primary.
ocf_get_best_group_property (line 176)

Get the best value of all values of a property for a list of usergroups.

  • return: The best property value ('best' is dependant on the property we are looking at).
mixed ocf_get_best_group_property (array $groups, ID_TEXT $property)
  • array $groups: The list of usergroups.
  • ID_TEXT $property: The identifier of the property.
ocf_get_group_property (line 150)

Get a certain property of a certain.

  • return: The property value.
mixed ocf_get_group_property (GROUP $group, ID_TEXT $property)
  • GROUP $group: The ID of the group.
  • ID_TEXT $property: The identifier of the property.
ocf_get_members_groups (line 206)

Get a list of the usergroups a member is in (keys say the usergroups, values are irrelevant).

  • return: Reverse list (e.g. array(1=>1,2=>1,3=>1) for someone in (1,2,3)).
array ocf_get_members_groups ([?MEMBER $member_id = NULL], [boolean $skip_secret = false], [boolean $handle_probation = false])
  • ?MEMBER $member_id: The member to find the usergroups of (NULL: current member).
  • boolean $skip_secret: Whether to skip looking at secret usergroups.
  • boolean $handle_probation: Whether to take probation into account
ocf_get_member_best_group_property (line 164)

Get the best value of all values of a property for a member (due to members being in multiple usergroups).

  • return: The property value.
mixed ocf_get_member_best_group_property (MEMBER $member_id, ID_TEXT $property)
  • MEMBER $member_id: The ID of the member.
  • ID_TEXT $property: The identifier of the property.
ocf_nice_get_usergroups (line 45)

Get a nice list for selection from the usergroups.

  • return: The list.
tempcode ocf_nice_get_usergroups ([?AUTO_LINK $it = NULL])
  • ?AUTO_LINK $it: Usergroup selected by default (NULL: no specific default).

Documentation generated on Sun, 02 Jan 2011 23:19:45 +0000 by phpDocumentor 1.4.3