Class Turba_Driver_group

Description

Read-only Turba_Driver implementation for creating a Horde_Group based address book.

$Horde: turba/lib/Driver/group.php,v 1.2.2.1 2007/12/20 14:34:30 jan Exp $

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

Turba_Driver
   |
   --Turba_Driver_group
Method Summary
 Turba_Driver_group Turba_Driver_group (array $params)
 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
Constructor Turba_Driver_group (line 21)

Constructor function.

Turba_Driver_group Turba_Driver_group (array $params)
  • array $params: Array of parameters for this driver. Basically, just passes the group id.
hasPermission (line 42)

Checks if the current user has the requested permissions on this source. This source is always read only.

  • 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 133)
void _getAddressBook ()
_init (line 29)

Initialize the group driver.

void _init ()

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

Read the data from the address book.

Again, this method taken from the favorites driver.

  • 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 66)

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.

This method 'borrowed' from the favorites driver.

  • 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