PHP Class Turba_Driver_Vbook, horde

Author: Michael J. Rubinsky ([email protected])

Inheritance: extends Turba_Driver

Public Properties

Property	Type	Description
$searchCriteria	array	The search criteria that defines this virtual address book.
$searchType	string	Search type for this virtual address book.

Property	Type	Description
$_driver	Turba_Driver	The composed driver.

Method	Description
__construct ( $name = '', array $params = [] )
hasPermission ( integer $perm ) : boolean	Check to see if the currently logged in user has requested permissions.

Method	Description
_add ( array $attributes, array $blob_fields = [], array $date_fields = [] )	Adds the specified contact to the addressbook.
_delete ( $object_key, $object_id )	Not supported for virtual address books.
_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.
_read ( string $key, mixed $ids, string $owner, array $fields, array $blobFields = [], array $dateFields = [] ) : array	Reads the requested entries from the underlying source.
_save ( Turba_Object $object )
_search ( array $criteria, array $fields, array $blobFields = [], $count_only = false ) : array	Return all entries matching the combined searches represented by $criteria and the vitural address book's search criteria.

Adds the specified contact to the addressbook.

protected _add ( array $attributes, array $blob_fields = [], array $date_fields = [] )
$attributes	array	The attribute values of the contact.
$blob_fields	array	Fields that represent binary data.
$date_fields	array	Fields that represent dates. @since 4.2.0

Not supported for virtual address books.

Returns a Turba_List object containing $objects filtered by $tags.

protected _filterTags ( array $objects, array $tags, Array $sort_order = null ) : Turba_List
$objects	array	A hash of objects, as returned by self::_search.
$tags	array	An array of tags to filter by.
$sort_order	Array	The sort order to pass to Turba_List::sort. (Unused).
return	Turba_List	The filtered Turba_List object.

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

protected _getContactOwner ( ) : string
return	string

Reads the requested entries from the underlying source.

protected _read ( string $key, mixed $ids, string $owner, array $fields, array $blobFields = [], array $dateFields = [] ) : array
$key	string	The primary key field to use.
$ids	mixed	The ids of the contacts to load.
$owner	string	Only return contacts owned by this user.
$fields	array	List of fields to return.
$blobFields	array	Array of fields containing binary data.
$dateFields	array	Array of fields containing date data. @since 4.2.0
return	array	Hash containing the search results.

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

protected _search ( array $criteria, array $fields, array $blobFields = [], $count_only = false ) : array
$criteria	array	Array containing the search criteria.
$fields	array	List of fields to return
$blobFields	array
return	array	Hash containing the search results.

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

public hasPermission ( integer $perm ) : boolean
$perm	integer	The permissions to check against.
return	boolean	True or False.

The composed driver.

protected Turba_Driver $_driver
return	Turba_Driver

The search criteria that defines this virtual address book.

public array $searchCriteria
return	array

Search type for this virtual address book.

public string $searchType
return	string

public __construct ( $name = '', array $params = [] )
$params	array