Docs For Class addressbook

Description

Generic backend that all other backends extend

Located in /functions/addressbook.php (line 641)

Direct descendents

Class	Description
abook_local_file	Backend for address book as a pipe separated file
abook_database	Address book in a database backend
abook_ldap_server	Address book backend for LDAP server

Variable Summary

mixed $bname

mixed $bnum

mixed $btype

mixed $error

mixed $sname

mixed $writeable

Method Summary

void add ( $userdata)

void list_addr ()

void lookup ( $value, [ $field = SM_ABOOK_FIELD_NICKNAME])

void modify ( $alias, $newuserdata)

void remove ( $alias)

void search ( $expression)

void set_error ( $string)

Variables

mixed $bname = 'dummy' (line 645)

Redefined in descendants as:

mixed $bnum = -1 (line 652)

mixed $btype = 'dummy' (line 644)

Redefined in descendants as:

mixed $error = '' (line 653)

mixed $sname = 'Dummy backend' (line 646)

Redefined in descendants as:

abook_ldap_server::$sname

mixed $writeable = false (line 654)

Redefined in descendants as:

abook_local_file::$writeable : Control write access to address book
abook_database::$writeable : Enable/disable writing into address book

Methods

add (line 679)

void add ( $userdata)

$userdata

Redefined in descendants as:

abook_local_file::add() : Add address
abook_database::add() : Add address

list_addr (line 674)

void list_addr ()

Redefined in descendants as:

abook_local_file::list_addr() : List all addresses
abook_database::list_addr() : List all addresses
abook_ldap_server::list_addr() : List all entries present in LDAP server

lookup (line 669)

void lookup ( $value, [ $field = SM_ABOOK_FIELD_NICKNAME])

$value
$field

Redefined in descendants as:

abook_local_file::lookup() : Lookup by the indicated field
abook_database::lookup() : Lookup by the indicated field

modify (line 689)

void modify ( $alias, $newuserdata)

$alias
$newuserdata

Redefined in descendants as:

abook_local_file::modify() : Modify address
abook_database::modify() : Modify address

remove (line 684)

void remove ( $alias)

$alias

Redefined in descendants as:

abook_local_file::remove() : Delete address
abook_database::remove() : Delete address

search (line 664)

void search ( $expression)

$expression

Redefined in descendants as:

abook_local_file::search() : Search the file
abook_database::search() : Search the database
abook_ldap_server::search() : Search the LDAP server

set_error (line 656)

void set_error ( $string)

$string

Class addressbook_backend