Docs For Class AddressBook

Class AddressBook

Description

This is the main address book class that connect all the backends and provide services to the functions above.

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

Variable Summary

mixed $add_extra_field

mixed $backends

mixed $error

mixed $localbackend

mixed $localbackendname

mixed $numbackends

Method Summary

AddressBook AddressBook ()

void add ( $userdata, $bnum)

void add_backend ( $backend, [ $param = ''])

void full_address ( $row)

void get_backend_list ([ $type = ''])

void list_addr ([ $bnum = -1])

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

void modify ( $alias, $userdata, $bnum)

void remove ( $alias, $bnum)

void search ( $expression, [ $bnum = -1])

void s_search ( $expression, [ $bnum = -1])

Variables

mixed $add_extra_field = false (line 294)

mixed $backends = array() (line 289)

mixed $error = '' (line 291)

mixed $localbackend = 0 (line 292)

mixed $localbackendname = '' (line 293)

mixed $numbackends = 0 (line 290)

Methods

Constructor AddressBook (line 297)

AddressBook AddressBook ()

add (line 504)

void add ( $userdata, $bnum)

$userdata
$bnum

add_backend (line 324)

void add_backend ( $backend, [ $param = ''])

$backend
$param

full_address (line 353)

void full_address ( $row)

$row

get_backend_list (line 305)

void get_backend_list ([ $type = ''])

$type

list_addr (line 475)

void list_addr ([ $bnum = -1])

$bnum

lookup (line 437)

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

$value
$bnum
$field

modify (line 586)

void modify ( $alias, $userdata, $bnum)

$alias
$userdata
$bnum

remove (line 551)

void remove ( $alias, $bnum)

$alias
$bnum

search (line 382)

void search ( $expression, [ $bnum = -1])

$expression
$bnum

s_search (line 423)

void s_search ( $expression, [ $bnum = -1])

$expression
$bnum

Documentation generated on Thu, 23 May 2013 04:21:28 +0200 by phpDocumentor 1.4.3