The Turba_Driver:: class provides a common abstracted interface to the various directory search drivers. It includes functions for searching, adding, removing, and modifying directory entries.
$Horde: turba/lib/Driver.php,v 1.57.2.101 2011-01-17 13:59:05 jan Exp $
Located in /lib/Driver.php (line 13)
Class | Description |
---|---|
![]() |
Read-only Turba directory driver implementation for favourite recipients. Relies on the contacts/favouriteRecipients API method. |
![]() |
Read-only Turba_Driver implementation for creating a Horde_Group based address book. |
![]() |
Turba directory driver implementation for an IMSP server. |
![]() |
Horde Turba driver for the Kolab IMAP Server. |
![]() |
Turba directory driver implementation for PHP's LDAP extension. |
![]() |
Null Turba directory driver. |
![]() |
Turba directory driver implementation for Horde Preferences - very simple, lightweight container. |
![]() |
The Turba_Driver:: class provides a common abstracted interface to the various directory search drivers. It includes functions for searching, adding, removing, and modifying directory entries. |
![]() |
Turba directory driver implementation for virtual address books. |
![]() |
Turba directory driver implementation for PHP's PEAR database abstraction layer. |
The name of a field to use as an alternative to the name field if that one is empty.
Array of fields to search "approximately" (@see config/sources.php.dist).
List of all fields that can be accessed in the backend (excludes composite attributes, etc.).
The name of a field to store contact list names in if not the default.
Hash describing the mapping between Turba attributes and driver-specific fields.
The internal name of this source.
Array of fields that must match exactly.
Hash with all tabs and their fields.
The symbolic title of this source.
What can this backend do?
Hold the value for the owner of this address book.
Number of contacts in this source.
Hash holding the driver's additional parameters.
Constructs a new Turba_Driver object.
Adds a new entry to the contact source.
Returns ability of the backend to add new contacts.
Check if the passed in share is the default share for this source.
Returns the number of contacts of the current user in this address book.
Creates a new Horde_Share for this source type.
Deletes the specified entry from the contact source.
Deletes all contacts from an address book.
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.
Returns the attributes that are blob types.
Return the owner to use when searching or creating contacts in this address book.
Returns the (localized) country name.
Returns the criteria available for this source except '__key'.
Returns all non-composite fields for this source. Useful for importing and exporting data, etc.
Return the name of this address book.
(This is the key into the cfgSources array)
Retrieves one object from the source.
Retrieves a set of objects from the source.
Returns the current driver's additional parameters.
Checks if this backend has a certain capability.
Checks if the current user has the requested permissions on this address book.
Returns a list of birthday or anniversary hashes from this source for a certain period.
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.
Remove all entries owned by the specified user.
Modifies an existing entry in the contact source.
Searches the source based on the provided criteria.
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()
Translates a single Turba attribute to the driver-specific counterpart. The translation is based on the contents of $this->map. This ignores composite fields.
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.
Function to convert a Horde_iCalendar_vcard object into a Turba Object Hash with Turba attributes suitable as a parameter for add().
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.
Exports a given Turba_Object as an iCalendar vCard.
Adds the specified contact to the SQL database.
Deletes the specified contact from the SQL database.
Default implementation for obtaining a Turba_List to get TimeObjects out of.
Default implementation for obtaining a Turba_List to get TimeObjects out of.
Initialize the driver.
Creates an object key for a new object.
Reads the given data from the address book and returns the results.
Saves the specified object in the SQL database.
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.
Takes an array of object hashes and returns a Turba_List containing the correct Turba_Objects
Documentation generated on Sun, 30 Jan 2011 05:39:22 +0000 by phpDocumentor 1.4.3