Docs For Class Turba_Driver_kolab_wrapper

Description

New 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: Thomas Jarosch <thomas.jarosch@intra2net.com>

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

Turba_Driver_kolab_wrapper
   |
   --Turba_Driver_kolab_wrapper_new

Variable Summary

array $_contacts_cache

Kolab_IMAP $_store

Method Summary

mixed connect ()

string generateUID ()

void _add ( $attributes)

void _convertMembers ( &$attributes)

void _delete ( $object_key, $object_id)

boolean _deleteAll ([ $sourceName = null])

array _doSearch ($criteria $criteria, $fields $glue, &$entries)

array _getAND (array $ids)

Hash _read (string $key, $ids $ids, $fields $fields)

array _removeDuplicated (array $ids)

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

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

array _selectEntries ($test $test, $entries &$entries)

string _store ( $attributes, [ $object_id = null])

Variables

array $_contacts_cache (line 729)

Internal cache of Kronolith_Event_kolab_new. eventID/UID is key

Kolab_IMAP $_store = null (line 736)

Shortcut to the imap connection

Inherited Variables

Inherited from Turba_Driver_kolab_wrapper

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

Methods

connect (line 743)

Connect to the Kolab backend

return: True on success, a PEAR error otherwise

mixed connect ()

Redefinition of:

Turba_Driver_kolab_wrapper::connect(): Connect to the Kolab backend

generateUID (line 1285)

Create an object key for a new object.

return: A unique ID for the new object.

string generateUID ()

_add (line 1092)

Adds the specified object to the Kolab message store.

void _add ( $attributes)

$attributes

_convertMembers (line 1173)

void _convertMembers ( &$attributes)

&$attributes

_delete (line 1203)

Removes the specified object from the Kolab message store.

void _delete ( $object_key, $object_id)

$object_key
$object_id

_deleteAll (line 1248)

Deletes all contacts from a specific address book.

return: True if the operation worked.

boolean _deleteAll ([ $sourceName = null])

$sourceName

_doSearch (line 842)

Applies the filter criteria to a list of entries

return: Array containing the ids of the selected entries

array _doSearch ($criteria $criteria, $fields $glue, &$entries)

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

_getAND (line 960)

Returns only those names that are duplicated in $ids

return: Array containing the 'AND' of all arrays in $ids

array _getAND (array $ids)

array $ids: A nested array of arrays containing names

_read (line 1012)

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

return: containing the search results.

Hash _read (string $key, $ids $ids, $fields $fields)

string $key: The primary key field to use (always 'uid' for Kolab).
$ids $ids: Data identifiers
$fields $fields: List of fields to return.

_removeDuplicated (line 991)

Returns an array with all duplicate names removed.

return: Array containg the 'OR' of all arrays in $ids.

array _removeDuplicated (array $ids)

array $ids: Nested array of arrays containing names.

_save (line 1119)

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

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.

_selectEntries (line 886)

Applies one filter criterium to a list of entries

return: Array containing the ids of the selected entries

array _selectEntries ($test $test, $entries &$entries)

$test $test: Test criterium
$entries &$entries: List of fields to return.

_store (line 1138)

Stores an object in the Kolab message store.

return: The object id, possibly updated.

string _store ( $attributes, [ $object_id = null])

$attributes
$object_id

Inherited Methods

Inherited From Turba_Driver_kolab_wrapper

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