PHP Class Turba_Driver_Group, horde

Copyright 2010-2016 Horde LLC (http://www.horde.org/) See the enclosed file LICENSE for license information (ASL). If you did did not receive this file, see http://www.horde.org/licenses/apache.
Author: Michael J. Rubinsky ([email protected])
Inheritance: extends Turba_Driver
Exibir arquivo Open project: horde/horde

Public Methods

Method Description
__construct ( string $name = '', array $params = [] ) Constructor function.
hasPermission ( integer $perm ) : boolean Checks if the current user has the requested permissions on this source. This source is always read only.

Protected Methods

Method Description
_getAddressBook ( ) TODO
_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.
_search ( array $criteria, array $fields, array $blobFields = [], $count_only = false ) : array Searches the group list with the given criteria and returns a filtered list of results. If the criteria parameter is an empty array, all records will be returned.

Method Details

__construct() public method

Constructor function.
public __construct ( string $name = '', array $params = [] )
$name string Source name
$params array Hash containing additional configuration parameters.

_getAddressBook() protected method

TODO
protected _getAddressBook ( )

_read() protected method

Reads the given data from the address book and returns the results.
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.

_search() protected method

This method 'borrowed' from the favorites driver.
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 A list of fields that contain binary data.
return array Hash containing the search results.

hasPermission() public method

Checks if the current user has the requested permissions on this source. This source is always read only.
public hasPermission ( integer $perm ) : boolean
$perm integer The permission to check for.
return boolean True if the user has permission, otherwise false.