Overview

Packages

  • Horde
    • Data
  • None
  • Turba

Classes

  • Turba
  • Turba_Api
  • Turba_Driver
  • Turba_Driver_Facebook
  • Turba_Driver_Favourites
  • Turba_Driver_Group
  • Turba_Driver_Imsp
  • Turba_Driver_Kolab
  • Turba_Driver_Ldap
  • Turba_Driver_Prefs
  • Turba_Driver_Share
  • Turba_Driver_Sql
  • Turba_Driver_Vbook
  • Turba_Exception
  • Turba_Factory_Driver
  • Turba_Form_AddContact
  • Turba_Form_Contact
  • Turba_Form_ContactBase
  • Turba_Form_CreateAddressBook
  • Turba_Form_DeleteAddressBook
  • Turba_Form_EditAddressBook
  • Turba_Form_EditContact
  • Turba_Form_EditContactGroup
  • Turba_List
  • Turba_LoginTasks_SystemTask_Upgrade
  • Turba_Object
  • Turba_Object_Group
  • Turba_Test
  • Turba_View_Browse
  • Turba_View_Contact
  • Turba_View_DeleteContact
  • Turba_View_Duplicates
  • Turba_View_EditContact
  • Turba_View_List
  • Overview
  • Package
  • Class
  • Tree

Class Turba_Driver_Share

The Turba_Driver:: class provides a common abstracted interface to the various directory search drivers. It includes functions for searching, adding, removing, and modifying directory entries.

Copyright 2009-2012 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.

Turba_Driver implements Countable
Extended by Turba_Driver_Share
Package: Turba
Category: Horde
License: ASL
Author: Chuck Hagenbuch chuck@horde.org
Author: Jon Parise jon@csh.rit.edu
Author: Michael J. Rubinsky mrubinsk@horde.org
Located at Driver/Share.php
Methods summary
public Turba_Driver
# __construct( string $name = '', array $params = array() )

Constructor

Constructor

Parameters

$name
The source name
$params
The parameter array describing the source

Returns

Turba_Driver

Overrides

Turba_Driver::__construct()
public boolean
# hasCapability( string $capability )

Checks if this backend has a certain capability.

Checks if this backend has a certain capability.

Parameters

$capability
The capability to check for.

Returns

boolean
Supported or not.

Overrides

Turba_Driver::hasCapability()
public boolean
# hasPermission( integer $perm )

Checks if the current user has the requested permissions on this address book.

Checks if the current user has the requested permissions on this address book.

Parameters

$perm
The permission to check for.

Returns

boolean
True if the user has permission, otherwise false.

Overrides

Turba_Driver::hasPermission()
public
# getName( )

Return the name of this address book.

Return the name of this address book.

String

Address book name

Overrides

Turba_Driver::getName()
public array
# searchDuplicates( )

Searches the current address book for duplicate entries.

Searches the current address book for duplicate entries.

Duplicates are determined by comparing email and name or last name and first name values.

Returns

array
A hash with the following format: array('name' => array('John Doe' => Turba_List, ...), ...)

Throws

Turba_Exception

Overrides

Turba_Driver::searchDuplicates()
public
# removeUserData( string $user )

Remove all data for a specific user.

Remove all data for a specific user.

Parameters

$user
The user to remove all data for.

Throws

Turba_Exception

Overrides

Turba_Driver::removeUserData()
public array
# getTimeObjectTurbaList( Horde_Date $start, Horde_Date $end, string $field )

Parameters

$start
The starting date.
$end
The ending date.
$field
<p>The address book field containing the timeObject information (birthday, anniversary).</p>

Returns

array
The list of timeobjects

Throws

Turba_Exception

Overrides

Turba_Driver::getTimeObjectTurbaList()
Methods inherited from Turba_Driver
add(), canAdd(), checkDefaultShare(), count(), createShare(), delete(), deleteAll(), fromASContact(), getBlobs(), getContactOwner(), getCriteria(), getFields(), getObject(), getObjects(), getParams(), listTimeObjects(), makeSearch(), save(), search(), setContactOwner(), setSourceName(), toASContact(), toDriver(), toDriverKeys(), toHash(), toTurbaKeys(), tovCard()
Properties inherited from Turba_Driver
$alternativeName, $approximate, $fields, $listNameField, $map, $strict, $tabs, $title
API documentation generated by ApiGen