PHP Class Horde_Kolab_Server_Object_Groupofnames, horde

Copyright 2008-2016 Horde LLC (http://www.horde.org/) See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
Inheritance: extends Horde_Kolab_Server_Object_Top
显示文件 Open project: horde/horde Class Usage Examples

Public Properties

Property Type Description
$init_attributes array A structure to initialize the attribute structure for this class.

Public Methods

Method Description
addMember ( string $member ) : array | PEAR_Error Add a member to this group.
deleteMember ( string $member ) : array | PEAR_Error Delete a member from this group.
generateId ( array &$info ) : string | PEAR_Error Generates an ID for the given information.
getFilter ( ) : string Return the filter string to retrieve this object type.
getMembers ( ) : array | PEAR_Error Retrieve the member list for this group.
isMember ( string $member ) : boolean | PEAR_Error Is the specified UID member of this group?

Method Details

addMember() public method

Add a member to this group.
public addMember ( string $member ) : array | PEAR_Error
$member string The UID of the member to add.
return array | PEAR_Error True if successful.

deleteMember() public method

Delete a member from this group.
public deleteMember ( string $member ) : array | PEAR_Error
$member string The UID of the member to delete.
return array | PEAR_Error True if successful.

generateId() public method

Generates an ID for the given information.
public generateId ( array &$info ) : string | PEAR_Error
$info array
return string | PEAR_Error The ID.

getFilter() public static method

Return the filter string to retrieve this object type.
public static getFilter ( ) : string
return string The filter to retrieve this object type from the server database.

getMembers() public method

Retrieve the member list for this group.
public getMembers ( ) : array | PEAR_Error
return array | PEAR_Error The list of members in this group.

isMember() public method

Is the specified UID member of this group?
public isMember ( string $member ) : boolean | PEAR_Error
$member string The UID of the member to check.
return boolean | PEAR_Error True if the UID is a member of the group, false otherwise.

Property Details

$init_attributes public_oe static_oe property

A structure to initialize the attribute structure for this class.
public static array $init_attributes
return array