Class Horde_Kolab_Server_Object

Description

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

$Horde: framework/Kolab_Server/lib/Horde/Kolab/Server/Object.php,v 1.2.2.9 2009/04/25 08:56:34 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.php (line 89)


	
			
Direct descendents
Class Description
 class Horde_Kolab_Server_Object_address This class provides methods to deal with global address book entries for Kolab.
 class Horde_Kolab_Server_Object_adminrole This class provides methods to deal with administrator object types.
 class Horde_Kolab_Server_Object_group This class provides methods to deal with groups for Kolab.
 class Horde_Kolab_Server_Object_server This class provides methods to deal with Kolab server configuration.
 class Horde_Kolab_Server_Object_sharedfolder This class provides methods to deal with shared folders entries for Kolab.
 class Horde_Kolab_Server_Object_user This class provides methods to deal with Kolab users stored in the Kolab db.
Variable Summary
Method Summary
 static string|PEAR_Error generateId (array $info)
 static true|PEAR_Error loadClass (mixed $type)
 Horde_Kolab_Server_Object Horde_Kolab_Server_Object (Horde_Kolab_Server &$db, [string $uid = null], [array $data = null])
 NULL exists ()
 Horde_Kolab_Server_Object|PEAR_Error &factory (mixed $type, string $uid, array &$storage, [array $data = null])
 string get (string $attr)
 mixed getGroups ()
 string|PEAR_Error getServer (string $server_type)
 boolean|PEAR_Error save (array $info)
 array|PEAR_Error toHash ([string $attrs = null])
 mixed _derive (string $attr)
 string _get (string $attr, [boolean $single = true])
 string _getFn ()
 string _getUid ()
 NULL _read ()
Variables
string $filter = '' (line 121)

The LDAP filter to retrieve this object type.

string $required_group (line 129)

The group the UID must be member of so that this object really matches this class type. This may not include the root UID.


Redefined in descendants as:
string $sort_by = KOLAB_ATTR_SN (line 166)

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


Redefined in descendants as:
mixed $_cache = false (line 112)

The cached LDAP result

FIXME: Include _ldap here

Kolab_Server $_db (line 96)

Link into the Kolab server.

array $_derived_attributes = array(
KOLAB_ATTR_ID,
)
(line 143)

Attributes derived from the LDAP values.


Redefined in descendants as:
array $_object_classes = array() (line 159)

The ldap classes for this type of object.


Redefined in descendants as:
array $_required_attributes = array() (line 152)

The attributes required when creating an object of this class.


Redefined in descendants as:
array $_supported_attributes = array() (line 136)

The LDAP attributes supported by this class.


Redefined in descendants as:
string $_uid (line 103)

UID of this object on the Kolab server.

Methods
static generateId (line 463)

Generates an ID for the given information.

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

Redefined in descendants as:
static loadClass (line 234)

Attempts to load the concrete Horde_Kolab_Server_Object class based on $type.

  • return: True if successfull.
static true|PEAR_Error loadClass (mixed $type)
  • mixed $type: The type of the Horde_Kolab_Server_Object subclass.
Constructor Horde_Kolab_Server_Object (line 176)

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

Horde_Kolab_Server_Object Horde_Kolab_Server_Object (Horde_Kolab_Server &$db, [string $uid = null], [array $data = null])
  • Horde_Kolab_Server &$db: The link into the Kolab db.
  • string $uid: UID of the object.
  • array $data: A possible array of data for the object
exists (line 259)

Does the object exist?

NULL exists ()
factory (line 208)

Attempts to return a concrete Horde_Kolab_Server_Object instance based on $type.

  • return: The newly created concrete Horde_Kolab_Server_Object instance.
Horde_Kolab_Server_Object|PEAR_Error &factory (mixed $type, string $uid, array &$storage, [array $data = null])
  • mixed $type: The type of the Horde_Kolab_Server_Object subclass to return.
  • string $uid: UID of the object
  • array &$storage: A link to the Kolab_Server class handling read/write.
  • array $data: A possible array of data for the object
get (line 286)

Get the specified attribute of this object

  • return: the value of this attribute
string get (string $attr)
  • string $attr: The attribute to read
getGroups (line 435)

Get the groups for this object

  • return: An array of group ids or a PEAR Error in case of an error.
mixed getGroups ()

Redefined in descendants as:
getServer (line 449)

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

This method can be used to encapsulate multidomain support.

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

Redefined in descendants as:
save (line 487)

Saves object information.

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

Redefined in descendants as:
toHash (line 388)

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.

Redefined in descendants as:
_derive (line 358)

Derive an attribute value.

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

Redefined in descendants as:
_get (line 339)

Get the specified attribute of this object

  • return: the value of this attribute
string _get (string $attr, [boolean $single = true])
  • string $attr: The attribute to read
  • boolean $single: Should a single value be returned or are multiple values allowed?
_getFn (line 422)

Get the "first name" attribute of this object

FIXME: This should get refactored to be combined with the Id value.

  • return: the "first name" of this object
string _getFn ()
_getUid (line 410)

Get the UID of this object

  • return: the UID of this object
string _getUid ()
_read (line 273)

Read the object into the cache

NULL _read ()

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