Class Horde_Kolab_Server_Object_group

Description

This class provides methods to deal with groups for Kolab.

$Horde: framework/Kolab_Server/lib/Horde/Kolab/Server/Object/group.php,v 1.2.2.5 2009/04/25 08:56:33 wrobel Exp $

Copyright 2008-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

Located in /Kolab_Server/lib/Horde/Kolab/Server/Object/group.php (line 32)

Horde_Kolab_Server_Object
   |
   --Horde_Kolab_Server_Object_group
Direct descendents
Class Description
 class Horde_Kolab_Server_Object_distlist This class provides methods to deal with distribution lists for Kolab.
Variable Summary
Method Summary
 static string|PEAR_Error generateId (array $info)
 static string getFilter ()
 array|PEAR_Error addMember (string $member)
 array|PEAR_Error deleteMember (string $member)
 array|PEAR_Error getMembers ()
 boolean|PEAR_Error isMember (string $member)
 boolean|PEAR_Error save (array $info)
 array|PEAR_Error toHash ([string $attrs = null])
 mixed _derive (string $attr)
Variables
string $sort_by = KOLAB_ATTR_MAIL (line 80)

Sort by this attributes (must be a LDAP attribute).


Redefinition of:
Horde_Kolab_Server_Object::$sort_by
Sort by this attributes (must be a LDAP attribute).
array $_derived_attributes = array(
KOLAB_ATTR_ID,
KOLAB_ATTR_VISIBILITY,
)
(line 51)

Attributes derived from the LDAP values.


Redefinition of:
Horde_Kolab_Server_Object::$_derived_attributes
Attributes derived from the LDAP values.
array $_object_classes = array(
KOLAB_OC_TOP,
KOLAB_OC_KOLABGROUPOFNAMES,
)
(line 70)

The ldap classes for this type of object.


Redefinition of:
Horde_Kolab_Server_Object::$_object_classes
The ldap classes for this type of object.
array $_required_attributes = array(
KOLAB_ATTR_CN,
)
(line 61)

The attributes required when creating an object of this class.


Redefinition of:
Horde_Kolab_Server_Object::$_required_attributes
The attributes required when creating an object of this class.

Redefined in descendants as:
array $_supported_attributes = array(
KOLAB_ATTR_CN,
KOLAB_ATTR_MAIL,
KOLAB_ATTR_MEMBER,
KOLAB_ATTR_DELETED,
)
(line 39)

The attributes supported by this class


Redefinition of:
Horde_Kolab_Server_Object::$_supported_attributes
The LDAP attributes supported by this class.

Inherited Variables

Inherited from Horde_Kolab_Server_Object

Horde_Kolab_Server_Object::$filter
Horde_Kolab_Server_Object::$required_group
Horde_Kolab_Server_Object::$_cache
Horde_Kolab_Server_Object::$_db
Horde_Kolab_Server_Object::$_uid
Methods
static generateId (line 143)

Generates an ID for the given information.

  • return: The ID.
static string|PEAR_Error generateId (array $info)
  • array $info: The data of the object.

Redefinition of:
Horde_Kolab_Server_Object::generateId()
Generates an ID for the given information.
static getFilter (line 105)

Return the filter string to retrieve this object type.

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

Redefined in descendants as:
addMember (line 188)

Add a member to this group.

  • return: True if successful.
array|PEAR_Error addMember (string $member)
  • string $member: The UID of the member to add.
deleteMember (line 210)

Delete a member from this group.

  • return: True if successful.
array|PEAR_Error deleteMember (string $member)
  • string $member: The UID of the member to delete.
getMembers (line 176)

Retrieve the member list for this group.

  • return: The list of members in this group.
array|PEAR_Error getMembers ()
isMember (line 235)

Is the specified UID member of this group?

  • return: True if the UID is a member of the group, false otherwise.
boolean|PEAR_Error isMember (string $member)
  • string $member: The UID of the member to check.
save (line 159)

Saves object information.

  • return: True on success.
boolean|PEAR_Error save (array $info)
  • array $info: The information about the object.

Redefinition of:
Horde_Kolab_Server_Object::save()
Saves object information.
toHash (line 122)

Convert the object attributes to a hash.

  • return: The hash representing this object.
array|PEAR_Error toHash ([string $attrs = null])
  • string $attrs: The attributes to return.

Redefinition of:
Horde_Kolab_Server_Object::toHash()
Convert the object attributes to a hash.
_derive (line 89)

Derive an attribute value.

  • return: The value of the attribute.
mixed _derive (string $attr)
  • string $attr: The attribute to derive.

Redefinition of:
Horde_Kolab_Server_Object::_derive()
Derive an attribute value.

Inherited Methods

Inherited From Horde_Kolab_Server_Object

 Horde_Kolab_Server_Object::Horde_Kolab_Server_Object()
 Horde_Kolab_Server_Object::exists()
 Horde_Kolab_Server_Object::factory()
 Horde_Kolab_Server_Object::generateId()
 Horde_Kolab_Server_Object::get()
 Horde_Kolab_Server_Object::getGroups()
 Horde_Kolab_Server_Object::getServer()
 Horde_Kolab_Server_Object::loadClass()
 Horde_Kolab_Server_Object::save()
 Horde_Kolab_Server_Object::toHash()
 Horde_Kolab_Server_Object::_derive()
 Horde_Kolab_Server_Object::_get()
 Horde_Kolab_Server_Object::_getFn()
 Horde_Kolab_Server_Object::_getUid()
 Horde_Kolab_Server_Object::_read()

Documentation generated on Sun, 30 Jan 2011 05:17:51 +0000 by phpDocumentor 1.4.3