PHP Interface Horde_Kolab_Server_Interface, horde

Author: Gunnar Wrobel ([email protected])

Public Methods

Method	Description
add ( Horde_Kolab_Server_Object_Interface $object, array $data ) : null	Add new object data.
connectGuid ( string $guid = '', string $pass = '' ) : NULL.	Connect to the server.
delete ( string $guid ) : null	Delete an object.
find ( string $query, array $params = [] ) : Horde_Kolab_Server_Result	Finds object data matching a given set of criteria.
findBelow ( string $query, string $parent, array $params = [] ) : Horde_Kolab_Server_Result	Finds all object data below a parent matching a given set of criteria.
getBaseGuid ( ) : string	Get the base GUID of this server
getGuid ( ) : string	Get the current GUID
getParentGuid ( string $guid ) : string	Get the parent GUID of this object.
getSchema ( ) : array	Return the database schema description.
read ( string $guid ) : array	Low level access to reading object data.
readAttributes ( string $guid, array $attrs ) : array	Low level access to reading some object attributes.
rename ( string $guid, string $new ) : null	Rename an object.
save ( Horde_Kolab_Server_Object_Interface $object, array $data ) : null	Modify existing object data.

Add new object data.

public add ( Horde_Kolab_Server_Object_Interface $object, array $data ) : null
$object	Horde_Kolab_Server_Object_Interface	The object to be added.
$data	array	The attributes of the object to be added.
return	null

Connect to the server.

public connectGuid ( string $guid = '', string $pass = '' ) : NULL.
$guid	string	The global unique id of the user.
$pass	string	The password.
return	NULL.

Delete an object.

public delete ( string $guid ) : null
$guid	string	The GUID of the object to be deleted.
return	null

Finds object data matching a given set of criteria.

public find ( string $query, array $params = [] ) : Horde_Kolab_Server_Result
$query	string	The LDAP search query
$params	array	Additional search parameters.
return	Horde_Kolab_Server_Result	The result object.

Finds all object data below a parent matching a given set of criteria.

public findBelow ( string $query, string $parent, array $params = [] ) : Horde_Kolab_Server_Result
$query	string	The LDAP search query
$parent	string	The parent to search below.
$params	array	Additional search parameters.
return	Horde_Kolab_Server_Result	The result object.

Get the base GUID of this server

public getBaseGuid ( ) : string
return	string	The base GUID of this server.

Get the current GUID

public getGuid ( ) : string
return	string	The GUID of the currently connected user.

Get the parent GUID of this object.

public getParentGuid ( string $guid ) : string
$guid	string	The GUID of the child.
return	string	the parent GUID of this object.

Return the database schema description.

public getSchema ( ) : array
return	array	The schema.

This function provides direct access to the Server data. Usually you should use


  $object = $server->fetch('a server uid');
  $variable = $object['attribute']

to access object attributes. This is slower but takes special object handling into account (e.g. custom attribute parsing).

public read ( string $guid ) : array
$guid	string	The object to retrieve.
return	array	An array of attributes.

Low level access to reading some object attributes.

Rename an object.

public rename ( string $guid, string $new ) : null
$guid	string	The GUID of the object to be renamed.
$new	string	The new GUID of the object.
return	null

Modify existing object data.

public save ( Horde_Kolab_Server_Object_Interface $object, array $data ) : null
$object	Horde_Kolab_Server_Object_Interface	The object to be modified.
$data	array	The attributes of the object to be stored.
return	null

public readAttributes ( string $guid, array $attrs ) : array
$guid	string	The object to retrieve.
$attrs	array	Restrict to these attributes.
return	array	An array of attributes.