/sources/ocf_groups2.php

Description
Functions
ocf_get_group_members_raw (line 70)

Get a list of members in a (or more full details if $non_validated is true).

  • return: The list.
array ocf_get_group_members_raw (GROUP $group_id, [boolean $include_primaries = true], [boolean $non_validated = false], [boolean $include_secondaries = true], [boolean $include_unvalidated_members = true], [?integer $max = NULL], [integer $start = 0])
  • GROUP $group_id: The ID of the group.
  • boolean $include_primaries: Whether to include those in the as a primary member.
  • boolean $non_validated: Whether to include those applied to join the, but not validated in (also causes it to return maps that contain this info).
  • boolean $include_secondaries: Whether to include those in the as a secondary member.
  • boolean $include_unvalidated_members: Whether to include those members who are not validated as site members at all yet (parameter currently ignored).
  • ?integer $max: Return up to this many entries for primary members and this many entries for secondary members and all LDAP members (NULL: no limit, only use no limit if querying very restricted usergroups!)
  • integer $start: Return primary members after this offset and secondary members after this offset
ocf_get_group_members_raw_count (line 31)

Get a count of members in a (or more full details if $non_validated is true).

  • return: The count.
integer ocf_get_group_members_raw_count (GROUP $group_id, [boolean $include_primaries = true], [boolean $non_validated = false], [boolean $include_secondaries = true], [boolean $include_unvalidated_members = true])
  • GROUP $group_id: The ID of the group.
  • boolean $include_primaries: Whether to include those in the as a primary member.
  • boolean $non_validated: Whether to include those applied to join the, but not validated in.
  • boolean $include_secondaries: Whether to include those in the as a secondary member.
  • boolean $include_unvalidated_members: Whether to include those members who are not validated as site members at all yet (parameter currently ignored).

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