• Home
  • Turba_Driver_Favourites

PHP Class Turba_Driver_Favourites, 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: Jan Schneider ([email protected])
Inheritance: extends Turba_Driver
Datei anzeigen Open project: horde/horde

Public Methods

Method Description
hasPermission ( integer $perm ) : boolean Checks if the current user has the requested permissions on this source.
removeUserData ( string $user ) : boolean Always returns true because the driver is read-only and there is nothing to remove.

Protected Methods

Method Description
_getAddressBook ( ) TODO
_match ( array $contact, array $val ) : boolean Returns whether a contact matches some criteria.
_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 favourites 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

_getAddressBook() protected method

TODO
protected _getAddressBook ( )

_match() protected method

Returns whether a contact matches some criteria.
protected _match ( array $contact, array $val ) : boolean
$contact array A contact hash.
$val array Some matching criterion, see _search().
return boolean True if the contact matches.

_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

Searches the favourites 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.
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.
public hasPermission ( integer $perm ) : boolean
$perm integer The permission to check for.
return boolean True if the user has permission, otherwise false.

removeUserData() public method

Always returns true because the driver is read-only and there is nothing to remove.
public removeUserData ( string $user ) : boolean
$user string The user's data to remove.
return boolean Always true.