• Accueil
• Turba_Driver

PHP Class Turba_Driver, horde

Afficher le fichier Open project: horde/horde Class Usage Examples

Méthodes publiques

Свойство	Type	Description
$alternativeName	string	The name of a field to use as an alternative to the name field if that one is empty.
$approximate	array	Array of fields to search "approximately" (@see config/backends.php).
$fields	array	List of all fields that can be accessed in the backend (excludes composite attributes, etc.).
$listNameField	string	The name of a field to store contact list names in if not the default.
$map	array	Hash describing the mapping between Turba attributes and driver-specific fields.
$strict	array	Array of fields that must match exactly.
$tabs	array	Hash with all tabs and their fields.
$title	string	The symbolic title of this source.

Protected Properties

Свойство	Type	Description
$_asMap	array	Mapping of Turba attributes to ActiveSync fields.
$_capabilities	array	What can this backend do?
$_contact_owner	string	Hold the value for the owner of this address book.
$_count	integer	Number of contacts in this source.
$_name	string	The internal name of this source.
$_objectOptions	array	Any additional options passed to Turba_Object constructors.
$_params	array	Hash holding the driver's additional parameters.

Méthodes publiques

Méthode	Description
__construct ( string $name = '', array $params = [] )	Constructs a new Turba_Driver object.
add ( array $attributes ) : string	Adds a new entry to the contact source.
canAdd ( ) : boolean	Returns ability of the backend to add new contacts.
checkDefaultShare ( Horde_Share_Object $share, array $srcconfig ) : boolean	Check if the passed in share is the default share for this source.
count ( ) : integer	Returns the number of contacts of the current user in this address book.
createShare ( string $share_name, array $params ) : Horde_Share	Creates a new Horde_Share for this source type.
delete ( string $object_id, boolean $remove_tags = true )	Deletes the specified entry from the contact source.
deleteAll ( string $sourceName = null )	Deletes all contacts from an address book.
fromASContact ( Horde_ActiveSync_Message_Contact $message ) : array	Convert an ActiveSync contact message into a hash suitable for importing via self::add().
getBlobs ( ) : array	Returns the attributes that are blob types.
getContactOwner ( ) : string	Return the owner to use when searching or creating contacts in this address book.
getCriteria ( ) : array	Returns the criteria available for this source except '__key'.
getDateFields ( ) : array	Returns the attributes that represent dates.
getFields ( ) : array	Returns all non-composite fields for this source. Useful for importing and exporting data, etc.
getName ( )	Return the name of this address book.
getObject ( string $objectId ) : Turba_Object	Retrieves one object from the source.
getObjects ( array $objectIds ) : array	Retrieves a set of objects from the source.
getParams ( ) : array	Returns the current driver's additional parameters.
getTimeObjectTurbaList ( Horde_Date $start, Horde_Date $end, string $field ) : Turba_List	Default implementation for obtaining a Turba_List to get TimeObjects out of.
hasCapability ( string $capability ) : boolean	Checks if this backend has a certain capability.
hasPermission ( integer $perm ) : boolean	Checks if the current user has the requested permissions on this address book.
listTimeObjects ( Horde_Date $start, Horde_Date $end, string $category ) : array	Returns a list of birthday or anniversary hashes from this source for a certain period.
makeSearch ( array $criteria, string $search_type, array $strict, boolean $match_begin = false, array $custom_strict = [] ) : array	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.
removeUserData ( string $user )	Remove all entries owned by the specified user.
save ( Turba_Object $object ) : string	Modifies an existing entry in the contact source.
search ( array $search_criteria, string $sort_order = null, string $search_type = 'AND', array $return_fields = [], array $custom_strict = [], boolean $match_begin = false, boolean $count_only = false ) : mixed	Searches the source based on the provided criteria.
searchDuplicates ( ) : array	Searches the current address book for duplicate entries.
setContactOwner ( string $owner )	Override the contactOwner setting for this driver.
setDefaultShare ( string $share )	Runs any actions after setting a new default tasklist.
setSourceName ( string $name )	Override the name setting for this driver.
synchronize ( mixed $token = false )	Synchronize, if needed.
toASContact ( Turba_Object $object, array $options = [] ) : Horde_ActiveSync_Message_Contact	Convert the contact to an ActiveSync contact message
toDriver ( string $attribute ) : string	Translates a single Turba attribute to the driver-specific counterpart. The translation is based on the contents of $this->map. This ignores composite fields.
toDriverKeys ( array $hash ) : array	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.
toHash ( Horde_Icalendar_Vcard $vcard ) : array	Function to convert a Horde_Icalendar_Vcard object into a Turba Object Hash with Turba attributes suitable as a parameter for add().
toTurbaKeys ( array $entry ) : array	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.
tovCard ( Turba_Object $object, string $version = '2.1', array $fields = null, boolean $skipEmpty = false ) : Horde_Icalendar_Vcard	Exports a given Turba_Object as an iCalendar vCard.

Méthodes protégées

Méthode	Description
_add ( array $attributes, array $blob_fields = [], array $date_fields = [] )	Adds the specified contact to the addressbook.
_canAdd ( ) : boolean	Returns ability of the backend to add new contacts.
_delete ( string $object_key, string $object_id )	Deletes the specified contact from the addressbook.
_deleteAll ( ) : array	Deletes all contacts from an address book.
_filterTags ( array $objects, array $tags, Array $sort_order = null ) : Turba_List	Returns a Turba_List object containing $objects filtered by $tags.
_getContactOwner ( ) : string	Return the owner to use when searching or creating contacts in this address book.
_getTimeObjectTurbaListFallback ( Horde_Date $start, Horde_Date $end, string $field ) : Turba_List	Default implementation for obtaining a Turba_List to get TimeObjects out of.
_guessName ( array &$hash )	Helper function for guessing name parts from a single name string.
_hasValEnum ( array $valEnum, string $type ) : boolean	Returns whether a ValEnum entry from a DevInf object contains a certain type.
_init ( )	Initialize the driver.
_makeKey ( array $attributes ) : string	Creates an object key for a new object.
_makeUid ( ) : string	Creates an object UID for a new object.
_read ( string $key, mixed $ids, string $owner, array $fields, array $blobFields = [], array $dateFields = [] ) : array	Reads the given data from the address book and returns the results.
_save ( Turba_Object $object ) : string	Saves the specified object in the SQL database.
_search ( array $criteria, array $fields, array $blobFields = [], boolean $count_only = false ) : array	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.
_toTurbaObjects ( array $objects, array $sort_order = null ) : Turba_List	Takes an array of object hashes and returns a Turba_List containing the correct Turba_Objects

Method Details

Property Details