Docs For Class AddressBook

Class AddressBook

Description

Description | Vars (details) | Methods (details)

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

Description | Vars (details) | Methods (details)

mixed $add_extra_field

mixed $backends

mixed $error

mixed $localbackend

mixed $localbackendname

mixed $numbackends

Method Summary

Description | Vars (details) | Methods (details)

static void full_address ( $row)

AddressBook AddressBook ()

AddressBook __construct ()

void add ( $userdata, $bnum)

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

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

Description | Vars (details) | Methods (details)

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

Description | Vars (details) Methods (details)

static method full_address (line 362 )

static void full_address ( $row)

$row

Constructor AddressBook (line 306 )

Constructor (PHP4 style, kept for compatibility reasons)

AddressBook AddressBook ()

Constructor __construct (line 299 )

Constructor (PHP5 style, required in some future version of PHP)

AddressBook __construct ()

add (line 513 )

void add ( $userdata, $bnum)

$userdata
$bnum

add_backend (line 333 )

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

$backend
$param

get_backend_list (line 314 )

void get_backend_list ([ $type = ''])

$type

list_addr (line 484 )

void list_addr ([ $bnum = -1])

$bnum

lookup (line 446 )

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

$value
$bnum
$field

modify (line 590 )

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

$alias
$userdata
$bnum

remove (line 555 )

void remove ( $alias, $bnum)

$alias
$bnum

search (line 391 )

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

$expression
$bnum

s_search (line 432 )

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

$expression
$bnum

Documentation generated on 2020年1月13日 04:24:13 +0100 by phpDocumentor 1.4.3