PHP Class Horde_Group_Stub_Api, horde

Author: Jan Schneider ([email protected])
Datei anzeigen Open project: horde/horde

Protected Properties

Property Type Description
$_groups

Public Methods

Method Description
getGroupMembers ( string $gid, boolean $subGroups = false ) : array Returns a list of all members belonging to a contact group.
getGroupMemberships ( string $user, boolean $parentGroups = false ) : array Returns all contact groups that the specified user is a member of.
getGroupObject ( string $gid ) : array Returns a contact group hash.
getGroupObjects ( ) : array Returns all contact groups.

Method Details

getGroupMembers() public method

Returns a list of all members belonging to a contact group.
public getGroupMembers ( string $gid, boolean $subGroups = false ) : array
$gid string The group identifier
$subGroups boolean Also include members of any subgroups?
return array An array of group members (identified by email address).

getGroupMemberships() public method

Returns all contact groups that the specified user is a member of.
public getGroupMemberships ( string $user, boolean $parentGroups = false ) : array
$user string The user
$parentGroups boolean Include user as a member of the any parent group as well.
return array An array of group identifiers that the specified user is a member of.

getGroupObject() public method

Returns a contact group hash.
public getGroupObject ( string $gid ) : array
$gid string The group identifier.
return array A hash defining the group.

getGroupObjects() public method

Returns all contact groups.
public getGroupObjects ( ) : array
return array A list of group hashes.

Property Details

$_groups protected_oe property

protected $_groups