Class Horde_Kolab_Server_Object_user

Description

This class provides methods to deal with Kolab users stored in the Kolab db.

$Horde: framework/Kolab_Server/lib/Horde/Kolab/Server/Object/user.php,v 1.2.2.12 2009/04/25 12:34:52 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/user.php (line 33)

Horde_Kolab_Server_Object
   |
   --Horde_Kolab_Server_Object_user
Variable Summary
Method Summary
 static string|PEAR_Error generateId (array $info)
 Horde_Kolab_Server_Object_user Horde_Kolab_Server_Object_user (Horde_Kolab_Server &$db, [string $dn = null], [array $data = null])
 string getFilter ()
 mixed|PEAR_Error getGroupAddresses ()
 mixed|PEAR_Error getGroups ()
 string getServer (string $server_type)
 boolean|PEAR_Error save (array $info)
 array|PEAR_Error toHash ([string $attrs = null])
 mixed _derive (string $attr)
Variables
array $_derived_attributes = array(
KOLAB_ATTR_ID,
KOLAB_ATTR_USERTYPE,
KOLAB_ATTR_LNFN,
KOLAB_ATTR_FNLN,
)
(line 62)

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_INETORGPERSON,
KOLAB_OC_KOLABINETORGPERSON,
KOLAB_OC_HORDEPERSON,
)
(line 87)

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_SN,
KOLAB_ATTR_GIVENNAME,
KOLAB_ATTR_USERPASSWORD,
KOLAB_ATTR_MAIL,
KOLAB_ATTR_HOMESERVER,
)
(line 74)

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.
array $_supported_attributes = array(
KOLAB_ATTR_SN,
KOLAB_ATTR_CN,
KOLAB_ATTR_GIVENNAME,
KOLAB_ATTR_FN,
KOLAB_ATTR_SID,
KOLAB_ATTR_USERPASSWORD,
KOLAB_ATTR_MAIL,
KOLAB_ATTR_DELETED,
KOLAB_ATTR_IMAPHOST,
KOLAB_ATTR_FREEBUSYHOST,
KOLAB_ATTR_HOMESERVER,
KOLAB_ATTR_KOLABDELEGATE,
KOLAB_ATTR_IPOLICY,
KOLAB_ATTR_FBFUTURE,
)
(line 40)

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::$sort_by
Horde_Kolab_Server_Object::$_cache
Horde_Kolab_Server_Object::$_db
Horde_Kolab_Server_Object::$_uid
Methods
static generateId (line 275)

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.
Constructor Horde_Kolab_Server_Object_user (line 102)

Initialize the Kolab Object. Provide either the UID or a LDAP search result.

Horde_Kolab_Server_Object_user Horde_Kolab_Server_Object_user (Horde_Kolab_Server &$db, [string $dn = null], [array $data = null])
  • Horde_Kolab_Server &$db: The link into the Kolab db.
  • string $dn: UID of the object.
  • array $data: A possible array of data for the object
getFilter (line 154)

The LDAP filter to retrieve this object type

string getFilter ()
getGroupAddresses (line 211)

Get the group mail addresses for this object

  • return: An array of group addresses, false if no groups were found.
mixed|PEAR_Error getGroupAddresses ()
getGroups (line 200)

Get the groups for this object

  • return: An array of group ids, false if no groups were found.
mixed|PEAR_Error getGroups ()

Redefinition of:
Horde_Kolab_Server_Object::getGroups()
Get the groups for this object
getServer (line 225)

Returns the server url of the given type for this user.

This method is used to encapsulate multidomain support.

  • return: The server url or empty on error.
string getServer (string $server_type)
  • string $server_type: The type of server URL that should be returned.

Redefinition of:
Horde_Kolab_Server_Object::getServer()
Returns the server url of the given type for this user.
save (line 311)

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 181)

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 131)

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:23:00 +0000 by phpDocumentor 1.4.3