PHP Class Turba_Driver_Vbook, horde

Copyright 2005-2016 Horde LLC (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/apache.
Author: Michael J. Rubinsky ([email protected])
Inheritance: extends Turba_Driver
Afficher le fichier Open project: horde/horde

Méthodes publiques

Свойство Type Description
$searchCriteria array The search criteria that defines this virtual address book.
$searchType string Search type for this virtual address book.

Protected Properties

Свойство Type Description
$_driver Turba_Driver The composed driver.

Méthodes publiques

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

Méthodes protégées

Méthode 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.

Method Details

__construct() public méthode

See also: Turba_Driver::__construct
public __construct ( $name = '', array $params = [] )
$params array

_add() protected méthode

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

_delete() protected méthode

Not supported for virtual address books.
See also: Turba_Driver::_delete
protected _delete ( $object_key, $object_id )

_filterTags() protected méthode

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).
Résultat Turba_List The filtered Turba_List object.

_getContactOwner() protected méthode

Return the owner to use when searching or creating contacts in this address book.
protected _getContactOwner ( ) : string
Résultat string

_read() protected méthode

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
Résultat array Hash containing the search results.

_save() protected méthode

See also: Turba_Driver::_save
protected _save ( Turba_Object $object )
$object Turba_Object

hasPermission() public méthode

Check to see if the currently logged in user has requested permissions.
public hasPermission ( integer $perm ) : boolean
$perm integer The permissions to check against.
Résultat boolean True or False.

Property Details

$_driver protected_oe property

The composed driver.
protected Turba_Driver $_driver
Résultat Turba_Driver

$searchCriteria public_oe property

The search criteria that defines this virtual address book.
public array $searchCriteria
Résultat array

$searchType public_oe property

Search type for this virtual address book.
public string $searchType
Résultat string