PHP Класс 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.
Автор: Michael J. Rubinsky ([email protected])
Наследование: extends Turba_Driver
Показать файл Открыть проект

Открытые свойства

Свойство Тип Описание
$searchCriteria array The search criteria that defines this virtual address book.
$searchType string Search type for this virtual address book.

Защищенные свойства (Protected)

Свойство Тип Описание
$_driver Turba_Driver The composed driver.

Открытые методы

Метод Описание
__construct ( $name = '', array $params = [] )
hasPermission ( integer $perm ) : boolean Check to see if the currently logged in user has requested permissions.

Защищенные методы

Метод Описание
_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.

Описание методов

__construct() публичный Метод

См. также: Turba_Driver::__construct
public __construct ( $name = '', array $params = [] )
$params array

_add() защищенный Метод

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() защищенный Метод

Not supported for virtual address books.
См. также: Turba_Driver::_delete
protected _delete ( $object_key, $object_id )

_filterTags() защищенный Метод

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).
Результат Turba_List The filtered Turba_List object.

_getContactOwner() защищенный Метод

Return the owner to use when searching or creating contacts in this address book.
protected _getContactOwner ( ) : string
Результат string

_read() защищенный Метод

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
Результат array Hash containing the search results.

_save() защищенный Метод

См. также: Turba_Driver::_save
protected _save ( Turba_Object $object )
$object Turba_Object

hasPermission() публичный Метод

Check to see if the currently logged in user has requested permissions.
public hasPermission ( integer $perm ) : boolean
$perm integer The permissions to check against.
Результат boolean True or False.

Описание свойств

$_driver защищенное свойство

The composed driver.
protected Turba_Driver $_driver
Результат Turba_Driver

$searchCriteria публичное свойство

The search criteria that defines this virtual address book.
public array $searchCriteria
Результат array

$searchType публичное свойство

Search type for this virtual address book.
public string $searchType
Результат string