Class Horde_Kolab_Server_Object_Groupofnames

This class provides methods to deal with groups.

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Horde_Kolab_Server_Object_Groupofnames

Package: Kolab\Server
Category: Kolab
License: LGPL 2.1
Author: Gunnar Wrobel wrobel@pardus.de
Link: http://pear.horde.org/index.php?package=Kolab_Server
Located at Horde/Kolab/Server/Object/Groupofnames.php

Methods summary
`public static string`	# `getFilter( )` Return the filter string to retrieve this object type. Return the filter string to retrieve this object type. Returns `string` The filter to retrieve this object type from the server database. Overrides `Horde_Kolab_Server_Object_Top::getFilter()`
`public string\|PEAR_Error`	# `generateId( array & $info )` Generates an ID for the given information. Generates an ID for the given information. Parameters `$info` $info The data of the object. Returns `string\|PEAR_Error` The ID.
`public array\|PEAR_Error`	# `getMembers( )` Retrieve the member list for this group. Retrieve the member list for this group. Returns `array\|PEAR_Error` The list of members in this group.
`public array\|PEAR_Error`	# `addMember( string $member )` Add a member to this group. Add a member to this group. Parameters `$member` The UID of the member to add. Returns `array\|PEAR_Error` True if successful.
`public array\|PEAR_Error`	# `deleteMember( string $member )` Delete a member from this group. Delete a member from this group. Parameters `$member` The UID of the member to delete. Returns `array\|PEAR_Error` True if successful.
`public boolean\|PEAR_Error`	# `isMember( string $member )` Is the specified UID member of this group? Is the specified UID member of this group? Parameters `$member` The UID of the member to check. Returns `boolean\|PEAR_Error` True if the UID is a member of the group, false otherwise.

Methods inherited from Horde_Kolab_Server_Object_Top
`getActions(), prepareObjectInformation()`

Methods inherited from Horde_Kolab_Server_Object_Base
`__construct(), delete(), exists(), getExternal(), getExternalAttributes(), getGuid(), getInternal(), getInternalAttributes(), readInternal(), save()`

Constants summary
`string`	`OBJECTCLASS_GROUPOFNAMES` The specific object class of this object type The specific object class of this object type	# `'groupOfNames'`
`string`	`ATTRIBUTE_CN` The common name The common name	# `'cn'`
`string`	`ATTRIBUTE_MEMBER` The members of this group The members of this group	# `'member'`

Constants inherited from Horde_Kolab_Server_Object_Top
`OBJECTCLASS_TOP`

Properties summary
`public static array`	`$init_attributes` A structure to initialize the attribute structure for this class. A structure to initialize the attribute structure for this class.	# `array( 'required' => array( self::ATTRIBUTE_CN, self::ATTRIBUTE_MEMBER, ), 'defined' => array( self::ATTRIBUTE_CN, self::ATTRIBUTE_MEMBER, ), 'object_classes' => array( self::OBJECTCLASS_GROUPOFNAMES, ), )`

Properties inherited from Horde_Kolab_Server_Object_Top
`$attributes, $object_classes, $sort_by`

`public static string`	# `getFilter( )` Return the filter string to retrieve this object type. Return the filter string to retrieve this object type. Returns `string` The filter to retrieve this object type from the server database. Overrides `Horde_Kolab_Server_Object_Top::getFilter()`
`public string\|PEAR_Error`	# `generateId( array & $info )` Generates an ID for the given information. Generates an ID for the given information. Parameters `$info` $info The data of the object. Returns `string\|PEAR_Error` The ID.
`public array\|PEAR_Error`	# `getMembers( )` Retrieve the member list for this group. Retrieve the member list for this group. Returns `array\|PEAR_Error` The list of members in this group.
`public array\|PEAR_Error`	# `addMember( string $member )` Add a member to this group. Add a member to this group. Parameters `$member` The UID of the member to add. Returns `array\|PEAR_Error` True if successful.
`public array\|PEAR_Error`	# `deleteMember( string $member )` Delete a member from this group. Delete a member from this group. Parameters `$member` The UID of the member to delete. Returns `array\|PEAR_Error` True if successful.
`public boolean\|PEAR_Error`	# `isMember( string $member )` Is the specified UID member of this group? Is the specified UID member of this group? Parameters `$member` The UID of the member to check. Returns `boolean\|PEAR_Error` True if the UID is a member of the group, false otherwise.