Class Turba_Driver_favourites

Description

Read-only Turba directory driver implementation for favourite recipients. Relies on the contacts/favouriteRecipients API method.

$Horde: turba/lib/Driver/favourites.php,v 1.5.2.3 2008/08/03 16:50:06 jan Exp $

Located in /lib/Driver/favourites.php (line 12)

Turba_Driver
   |
   --Turba_Driver_favourites
Method Summary
 boolean hasPermission (integer $perm)
 void _getAddressBook ()
 void _init ()
 Hash _read (array $criteria,  $ids, array $fields, string $id)
 array _search (array $criteria, array $fields)
Variables
Methods
hasPermission (line 29)

Checks if the current user has the requested permissions on this source.

  • return: True if the user has permission, otherwise false.
boolean hasPermission (integer $perm)
  • integer $perm: The permission to check for.

Redefinition of:
Turba_Driver::hasPermission()
Checks if the current user has the requested permissions on this address book.
_getAddressBook (line 119)
void _getAddressBook ()
_init (line 16)
void _init ()

Redefinition of:
Turba_Driver::_init()
Initialize the driver.
_read (line 99)

Reads the given data from the API method and returns the result's fields.

  • return: containing the search results.
Hash _read (array $criteria,  $ids, array $fields, string $id)
  • array $criteria: Search criteria.
  • string $id: Data identifier.
  • array $fields: List of fields to return.
  • $ids

Redefinition of:
Turba_Driver::_read()
Reads the given data from the address book and returns the results.
_search (line 48)

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.

  • return: Hash containing the search results.
array _search (array $criteria, array $fields)
  • array $criteria: Array containing the search criteria.
  • array $fields: List of fields to return.

Redefinition of:
Turba_Driver::_search()
Searches the address book with the given criteria and returns a filtered list of results. If the criteria parameter is an empty array, all records will be returned.

Inherited Methods

Inherited From Turba_Driver

 Turba_Driver::Turba_Driver()
 Turba_Driver::add()
 Turba_Driver::canAdd()
 Turba_Driver::checkDefaultShare()
 Turba_Driver::count()
 Turba_Driver::createShare()
 Turba_Driver::delete()
 Turba_Driver::deleteAll()
 Turba_Driver::generateUID()
 Turba_Driver::getBlobs()
 Turba_Driver::getContactOwner()
 Turba_Driver::getCountry()
 Turba_Driver::getCriteria()
 Turba_Driver::getFields()
 Turba_Driver::getName()
 Turba_Driver::getObject()
 Turba_Driver::getObjects()
 Turba_Driver::getParams()
 Turba_Driver::hasCapability()
 Turba_Driver::hasPermission()
 Turba_Driver::listTimeObjects()
 Turba_Driver::makeSearch()
 Turba_Driver::removeUserData()
 Turba_Driver::save()
 Turba_Driver::search()
 Turba_Driver::singleton()
 Turba_Driver::toDriver()
 Turba_Driver::toDriverKeys()
 Turba_Driver::toHash()
 Turba_Driver::toTurbaKeys()
 Turba_Driver::tovCard()
 Turba_Driver::_add()
 Turba_Driver::_canAdd()
 Turba_Driver::_delete()
 Turba_Driver::_getContactOwner()
 Turba_Driver::_getTimeObjectTurbaList()
 Turba_Driver::_getTimeObjectTurbaListFallback()
 Turba_Driver::_init()
 Turba_Driver::_makeKey()
 Turba_Driver::_read()
 Turba_Driver::_save()
 Turba_Driver::_search()
 Turba_Driver::_toTurbaObjects()

Documentation generated on Sun, 30 Jan 2011 05:39:23 +0000 by phpDocumentor 1.4.3