Class Turba_Driver_kolab

Description

Horde Turba driver for the Kolab IMAP Server.

Copyright 2004-2009 The Horde Project (http://www.horde.org/)

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

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

Turba_Driver
   |
   --Turba_Driver_kolab
Variable Summary
Method Summary
 void checkDefaultShare ( &$share,  $srcConfig)
 mixed &createShare (array $share_id,  $params)
 string generateUID ()
 void _add ( $attributes)
 void _canAdd ()
 void _delete ( $object_key,  $object_id)
 boolean _deleteAll ([ $sourceName = null])
 boolean _init ()
 string _makeKey (array $attributes)
 array _read (string $key, mixed $ids, string $owner, array $fields)
 string _save ( $object_key,  $object_id,  $attributes)
 Hash _search ($criteria $criteria, $fields $fields)
Variables
mixed $_capabilities = array(
'delete_addressbook' => true,
'delete_all' => true,
)
(line 39)

Redefinition of:
Turba_Driver::$_capabilities
What can this backend do?
Kolab $_kolab = null (line 30)

Our Kolab server connection.

Turba_Driver_kolab_wrapper $_wrapper = null (line 37)

The wrapper to decide between the Kolab implementation

Inherited Variables

Inherited from Turba_Driver

Turba_Driver::$alternativeName
Turba_Driver::$approximate
Turba_Driver::$fields
Turba_Driver::$listNameField
Turba_Driver::$map
Turba_Driver::$name
Turba_Driver::$strict
Turba_Driver::$tabs
Turba_Driver::$title
Turba_Driver::$_contact_owner
Turba_Driver::$_count
Turba_Driver::$_params
Methods
checkDefaultShare (line 184)
void checkDefaultShare ( &$share,  $srcConfig)
  • &$share
  • $srcConfig

Redefinition of:
Turba_Driver::checkDefaultShare()
Check if the passed in share is the default share for this source.
createShare (line 174)

Creates a new Horde_Share

  • return: The share object or PEAR_Error.
  • since: Turba 2.2
mixed &createShare (array $share_id,  $params)
  • array $share_id: The params for the share.
  • $params

Redefinition of:
Turba_Driver::createShare()
Creates a new Horde_Share for this source type.
generateUID (line 157)

Create an object key for a new object.

  • return: A unique ID for the new object.
string generateUID ()

Redefinition of:
Turba_Driver::generateUID()
Generates a universal/unique identifier for a contact. This is NOT something that we expect to be able to parse into an addressbook and a contactId.
_add (line 95)

Adds the specified object to the Kolab message store.

void _add ( $attributes)
  • $attributes

Redefinition of:
Turba_Driver::_add()
Adds the specified contact to the SQL database.
_canAdd (line 103)
  • see: _canAdd()
void _canAdd ()

Redefinition of:
Turba_Driver::_canAdd()
_delete (line 111)

Removes the specified object from the Kolab message store.

void _delete ( $object_key,  $object_id)
  • $object_key
  • $object_id

Redefinition of:
Turba_Driver::_delete()
Deletes the specified contact from the SQL database.
_deleteAll (line 121)

Deletes all contacts from a specific address book.

  • return: True if the operation worked.
boolean _deleteAll ([ $sourceName = null])
  • $sourceName
_init (line 49)

Attempts to open a Kolab Groupware folder.

  • return: True on success, PEAR_Error on failure.
boolean _init ()

Redefinition of:
Turba_Driver::_init()
Initialize the driver.
_makeKey (line 144)

Create an object key for a new object.

  • return: A unique ID for the new object.
string _makeKey (array $attributes)
  • array $attributes: The attributes (in driver keys) of the object being added.

Redefinition of:
Turba_Driver::_makeKey()
Creates an object key for a new object.
_read (line 87)

Read the given data from the Kolab message store and returns the results.

  • return: Hash containing the search results.
array _read (string $key, mixed $ids, string $owner, array $fields)
  • string $key: The primary key field to use.
  • mixed $ids: The ids of the contacts to load.
  • string $owner: Only return contacts owned by this user.
  • array $fields: List of fields to return.

Redefinition of:
Turba_Driver::_read()
Reads the given data from the address book and returns the results.
_save (line 131)

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

Redefinition of:
Turba_Driver::_save()
Saves the specified object in the SQL database.
_search (line 71)

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.

Redefinition of:
Turba_Driver::_search()
Searches the address book with the given criteria and returns a filtered list of results. If the criteria parameter is an empty array, all records will be returned.

Inherited Methods

Inherited From Turba_Driver

 Turba_Driver::Turba_Driver()
 Turba_Driver::add()
 Turba_Driver::canAdd()
 Turba_Driver::checkDefaultShare()
 Turba_Driver::count()
 Turba_Driver::createShare()
 Turba_Driver::delete()
 Turba_Driver::deleteAll()
 Turba_Driver::generateUID()
 Turba_Driver::getBlobs()
 Turba_Driver::getContactOwner()
 Turba_Driver::getCountry()
 Turba_Driver::getCriteria()
 Turba_Driver::getFields()
 Turba_Driver::getName()
 Turba_Driver::getObject()
 Turba_Driver::getObjects()
 Turba_Driver::getParams()
 Turba_Driver::hasCapability()
 Turba_Driver::hasPermission()
 Turba_Driver::listTimeObjects()
 Turba_Driver::makeSearch()
 Turba_Driver::removeUserData()
 Turba_Driver::save()
 Turba_Driver::search()
 Turba_Driver::singleton()
 Turba_Driver::toDriver()
 Turba_Driver::toDriverKeys()
 Turba_Driver::toHash()
 Turba_Driver::toTurbaKeys()
 Turba_Driver::tovCard()
 Turba_Driver::_add()
 Turba_Driver::_canAdd()
 Turba_Driver::_delete()
 Turba_Driver::_getContactOwner()
 Turba_Driver::_getTimeObjectTurbaList()
 Turba_Driver::_getTimeObjectTurbaListFallback()
 Turba_Driver::_init()
 Turba_Driver::_makeKey()
 Turba_Driver::_read()
 Turba_Driver::_save()
 Turba_Driver::_search()
 Turba_Driver::_toTurbaObjects()

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