Turba directory driver implementation for virtual address books.

Copyright 2005-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.

• author: Michael Rubinsky <mrubinsk@horde.org>
• since: Turba 2.2

Located in /lib/Driver/vbook.php (line 20)

Turba_Driver
   |
   --Turba_Driver_vbook

array $searchCriteria (line 34)

The search criteria that defines this virtual address book.

string $searchType (line 27)

Search type for this virtual address book.

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::$_capabilities
Turba_Driver::$_contact_owner
Turba_Driver::$_count
Turba_Driver::$_params

deleteAll (line 54)

Deletes all contacts from an address book. Not implemented for virtual address books; just returns true so that the address book can be deleted.

• return: True

boolean deleteAll ([ $sourceName = null])

• $sourceName

---

Redefinition of:

Turba_Driver::deleteAll()

Deletes all contacts from an address book.

hasPermission (line 147)

Check to see if the currently logged in user has requested permissions.

• return: True or False.

boolean hasPermission (integer $perm)

• integer $perm: The permissions to check against.

---

Redefinition of:

Turba_Driver::hasPermission()

Checks if the current user has the requested permissions on this address book.

_add (line 119)

Not supported for virtual address books.

void _add ( $attributes)

• $attributes

---

Redefinition of:

Turba_Driver::_add()

Adds the specified contact to the SQL database.

_delete (line 127)

Not supported for virtual address books.

void _delete ( $object_key,  $object_id)

• $object_key
• $object_id

---

Redefinition of:

Turba_Driver::_delete()

Deletes the specified contact from the SQL database.

_getContactOwner (line 42)

Return the owner to use when searching or creating contacts in this address book.

string _getContactOwner ()

---

Redefinition of:

Turba_Driver::_getContactOwner()

_init (line 61)

void _init ()

---

Redefinition of:

Turba_Driver::_init()

Initialize the driver.

_read (line 111)

Reads the requested entries from the underlying source.

• 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 135)

Not supported for virtual address books.

void _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 91)

Return all entries matching the combined searches represented by $criteria and the vitural address book's search criteria.

• return: Hash containing the search results.

array _search (array $criteria, array $fields)

• array $criteria: Array containing the search criteria.
• array $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()