Docs For Class Turba_Driver_kolab_wrapper

Description

Horde Turba driver for the Kolab IMAP Server.

See the enclosed file LICENSE for license information (ASL). If you did not receive this file, see http://www.horde.org/licenses/asl.php.

author: Gunnar Wrobel <wrobel@pardus.de>
author: Stuart Binge <omicron@mighty.co.za>

Located in /lib/Driver/kolab.php (line 280)

Turba_Driver_kolab_wrapper
   |
   --Turba_Driver_kolab_wrapper_old

Method Summary

void _add ( $attributes)

void _buildContact ()

void _createContact ( &$xml, $attributes)

void _delete ( $object_key, $object_id)

boolean _deleteAll ([ $sourceName = null])

Hash _read ($criteria $criteria, $id $id_list, $fields $fields)

string _save ( $object_key, $object_id, $attributes)

Hash _search ($criteria $criteria, $fields $fields)

void _setAddress ( $type, &$address, $attributes)

void _setPhone ( $type, &$phone, $attributes)

Variables

Inherited Variables

Inherited from Turba_Driver_kolab_wrapper

Turba_Driver_kolab_wrapper::$_addressbook
Turba_Driver_kolab_wrapper::$_connected
Turba_Driver_kolab_wrapper::$_kolab

Methods

_add (line 584)

Adds the specified object to the Kolab message store.

void _add ( $attributes)

$attributes

_buildContact (line 282)

void _buildContact ()

_createContact (line 387)

void _createContact ( &$xml, $attributes)

&$xml
$attributes

_delete (line 604)

Removes the specified object from the Kolab message store.

void _delete ( $object_key, $object_id)

$object_key
$object_id

_deleteAll (line 623)

Deletes all contacts from a specific address book.

return: True if the operation worked.

boolean _deleteAll ([ $sourceName = null])

$sourceName

_read (line 547)

Read the given data from the Kolab message store and returns the result's fields.

return: containing the search results.

Hash _read ($criteria $criteria, $id $id_list, $fields $fields)

$criteria $criteria: Search criteria.
$id $id_list: Data identifier.
$fields $fields: List of fields to return.

_save (line 643)

Updates an existing object in the Kolab message store.

return: The object id, possibly updated.

string _save ( $object_key, $object_id, $attributes)

$object_key
$object_id
$attributes

_search (line 489)

Searches the Kolab message store with the given criteria and returns a filtered list of results. If the criteria parameter is an empty array, all records will be returned.

return: containing the search results.

Hash _search ($criteria $criteria, $fields $fields)

$criteria $criteria: Array containing the search criteria.
$fields $fields: List of fields to return.

_setAddress (line 368)

void _setAddress ( $type, &$address, $attributes)

$type
&$address
$attributes

_setPhone (line 355)

void _setPhone ( $type, &$phone, $attributes)

$type
&$phone
$attributes

Inherited Methods

Inherited From Turba_Driver_kolab_wrapper

Turba_Driver_kolab_wrapper::Turba_Driver_kolab_wrapper()
Turba_Driver_kolab_wrapper::connect()