string $alternativeName = null (line 80)

The name of a field to use as an alternative to the name field if that one is empty.

array $fields = array() (line 50)

List of all fields that can be accessed in the backend (excludes composite attributes, etc.).

array $map = array() (line 35)

Hash describing the mapping between Turba attributes and driver-specific fields.

array $strict = array() (line 57)

Array of fields that must match exactly.

string $title (line 27)

The symbolic title of this source.

string $_contact_owner = '' (line 108)

Hold the value for the owner of this address book.

array $_params = array() (line 87)

Hash holding the driver's additional parameters.

add (line 766)

Adds a new entry to the contact source.

• return: The new __key value on success, or a PEAR_Error object on failure.

• array $attributes: The attributes of the new object to add.

checkDefaultShare (line 2593)

Check if the passed in share is the default share for this source.

• Horde_Share $share: The share object e
• array $srcconfig: The cfgSource entry for the share (not used in this method, but a child class may need it).
• &$share

• Turba_Driver_imsp::checkDefaultShare() : Check if the passed in share is the default share for this source.
• Turba_Driver_kolab::checkDefaultShare()

createShare (line 2373)

Creates a new Horde_Share for this source type.

• return: The share object or PEAR_Error.
• since: Turba 2.2

• array $params: The params for the share.
• $share_id

• Turba_Driver_imsp::createShare() : Creates a new Horde_Share and creates the address book on the IMSP server.
• Turba_Driver_kolab::createShare() : Creates a new Horde_Share

deleteAll (line 861)

Deletes all contacts from an address book.

• return: True on success, PEAR_Error on failure.

• string $sourceName: The identifier of the address book to delete. If omitted, will clear the current user's 'default' address book for this source type.

• Turba_Driver_vbook::deleteAll() : Deletes all contacts from an address book. Not implemented for virtual address books; just returns true so that the address book can be deleted.

getBlobs (line 148)

Returns the attributes that are blob types.

• return: List of blob attributes in the array keys.

getCountry (line 1873)

Returns the (localized) country name.

• return: The country name or the country code if a name cannot be found.

• string $country: The two-letter country code.

getFields (line 933)

Returns all non-composite fields for this source. Useful for importing and exporting data, etc.

• return: The field list.

getObject (line 741)

Retrieves one object from the source.

• return: The retrieved object.

• string $objectId: The unique id of the object to retrieve.

getParams (line 126)

Returns the current driver's additional parameters.

• return: Hash containing the driver's additional parameters.

hasPermission (line 2322)

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

• return: True if the user has permission, otherwise false.

• integer $perm: The permission to check for.

• Turba_Driver_favourites::hasPermission() : Checks if the current user has the requested permissions on this source.
• Turba_Driver_group::hasPermission() : Checks if the current user has the requested permissions on this source. This source is always read only.
• Turba_Driver_imsp::hasPermission() : Checks if the current user has the requested permission on this source.
• Turba_Driver_null::hasPermission() : Checks if the current user has the requested permissions on this source.
• Turba_Driver_share::hasPermission() : Checks if the current user has the requested permissions on this address book.
• Turba_Driver_vbook::hasPermission() : Check to see if the currently logged in user has requested permissions.

makeSearch (line 271)

Takes a hash of Turba key => search value and return a (possibly nested) array, using backend attribute names, that can be turned into a search by the driver. The translation is based on the contents of $this->map, and includes nested OR searches for composite fields.

• return: An array of search criteria.

• array $hash: Hash of criteria using Turba keys.
• string $search_type: OR search or AND search?
• array $strict: Fields that must be matched exactly.
• boolean $match_begin: Whether to match only at beginning of words.
• $criteria

save (line 877)

Modifies an existing entry in the contact source.

• return: The object id, possibly updated.

• Turba_Object $object: The object to update.

singleton (line 2478)

Attempts to return a reference to a concrete Turba_Driver instance based on the $config array. It will only create a new instance if no Turba_Driver instance with the same parameters currently exists.

This method must be invoked as: $driver = &Turba_Driver::singleton()

• return: The concrete Turba_Driver reference, or a PEAR_Error on error.

• mixed $name: Either a string containing the internal name of this source, or a config array describing the source.

toDriverKeys (line 172)

Translates the keys of the first hash from the generalized Turba attributes to the driver-specific fields. The translation is based on the contents of $this->map.

• return: Translated version of $hash.

• array $hash: Hash using Turba keys.

• Turba_Driver_ldap::toDriverKeys() : Expands the parent->toDriverKeys Function to build composed fields needed for the dn based on the contents of $this->map.

toTurbaKeys (line 438)

Translates a hash from being keyed on driver-specific fields to being keyed on the generalized Turba attributes. The translation is based on the contents of $this->map.

• return: Translated version of $entry.

• array $entry: A hash using driver-specific keys.

_add (line 2549)

Adds the specified contact to the SQL database.

• $attributes

• Turba_Driver_imsp::_add() : Adds the specified object to the IMSP server.
• Turba_Driver_kolab::_add() : Adds the specified object to the Kolab message store.
• Turba_Driver_ldap::_add() : Adds the specified entry to the LDAP directory.
• Turba_Driver_null::_add()
• Turba_Driver_prefs::_add() : Adds the specified object to the preferences.
• Turba_Driver_share::_add() : Adds the specified object to the SQL database.
• Turba_Driver_vbook::_add() : Not supported for virtual address books.
• Turba_Driver_sql::_add() : Adds the specified object to the SQL database.

_delete (line 2557)

Deletes the specified contact from the SQL database.

• $object_key
• $object_id

• Turba_Driver_imsp::_delete() : Deletes the specified object from the IMSP server.
• Turba_Driver_kolab::_delete() : Removes the specified object from the Kolab message store.
• Turba_Driver_ldap::_delete() : Deletes the specified entry from the LDAP directory.
• Turba_Driver_null::_delete()
• Turba_Driver_prefs::_delete() : Deletes the specified object from the preferences.
• Turba_Driver_share::_delete() : Deletes the specified object from the SQL database.
• Turba_Driver_vbook::_delete() : Not supported for virtual address books.
• Turba_Driver_sql::_delete() : Deletes the specified object from the SQL database.

_getTimeObjectTurbaList (line 663)

Default implementation for obtaining a Turba_List to get TimeObjects out of.

• return: A Tubra_List of objects || PEAR_Error

• Horde_Date $start: The starting date.
• Horde_Date $end: The ending date.
• string $field: The address book field containing the timeObject information (birthday, anniversary)

• Turba_Driver_share::_getTimeObjectTurbaList()
• Turba_Driver_sql::_getTimeObjectTurbaList() : Obtain Turba_List of items to get TimeObjects out of.

_init (line 2511)

Initialize the driver.

• Turba_Driver_favourites::_init()
• Turba_Driver_group::_init() : Initialize the group driver.
• Turba_Driver_imsp::_init() : Initialize the IMSP connection and check for error.
• Turba_Driver_kolab::_init() : Attempts to open a Kolab Groupware folder.
• Turba_Driver_ldap::_init()
• Turba_Driver_null::_init()
• Turba_Driver_prefs::_init()
• Turba_Driver_share::_init() : Initialize
• Turba_Driver_vbook::_init()
• Turba_Driver_sql::_init()

_read (line 2541)

Reads the given data from the address book and returns the results.

• return: Hash containing the search results.

• 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.

• Turba_Driver_favourites::_read() : Reads the given data from the API method and returns the result's fields.
• Turba_Driver_group::_read() : Read the data from the address book.
• Turba_Driver_imsp::_read() : Reads the given data from the IMSP server and returns the results.
• Turba_Driver_kolab::_read() : Read the given data from the Kolab message store and returns the results.
• Turba_Driver_ldap::_read() : Reads the LDAP directory for a given element and returns the results.
• Turba_Driver_null::_read()
• Turba_Driver_prefs::_read() : Reads the given data from the preferences and returns the result's fields.
• Turba_Driver_share::_read() : Reads the given data from the address book and returns the results.
• Turba_Driver_vbook::_read() : Reads the requested entries from the underlying source.
• Turba_Driver_sql::_read() : Reads the given data from the SQL database and returns the results.

_search (line 2526)

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.

• return: Hash containing the search results.

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

• Turba_Driver_favourites::_search() : Searches the favourites list with the given criteria and returns a filtered list of results. If the criteria parameter is an empty array, all records will be returned.
• Turba_Driver_group::_search() : Searches the group list with the given criteria and returns a filtered list of results. If the criteria parameter is an empty array, all records will be returned.
• Turba_Driver_imsp::_search() : Returns all entries matching $critera.
• Turba_Driver_kolab::_search() : 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.
• Turba_Driver_ldap::_search() : Searches the LDAP directory with the given criteria and returns a filtered list of results. If no criteria are specified, all records are returned.
• Turba_Driver_null::_search()
• Turba_Driver_prefs::_search() : Returns all entries - searching isn't implemented here for now. The parameters are simply ignored.
• Turba_Driver_share::_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.
• Turba_Driver_vbook::_search() : Return all entries matching the combined searches represented by $criteria and the vitural address book's search criteria.
• Turba_Driver_sql::_search() : Searches the SQL database with the given criteria and returns a filtered list of results. If the criteria parameter is an empty array, all records will be returned.