Docs For Class abook_hmailserver

Description

hMailserver address book backend written in PHP Pear DB functions.

Located in /plugins/abook_hmailserver/class_db.php (line 33)

addressbook_backend
   |
   --abook_hmailserver_db

Variable Summary

boolean $add_aliases

boolean $add_dlists

string $bname

string $btype

object DB $db

int $db_type

string $domain_name

string|array $dsn

boolean $listing

boolean $writeable

Method Summary

abook_hmailserver_db abook_hmailserver_db (array $params)

boolean add ()

void close ()

string firstname (array $account)

string lastname (array $account)

string listname (array $list)

array list_addr ()

array|boolean lookup (string $nickname)

boolean modify ()

boolean open ()

boolean remove ()

void search (expr $expr)

Variables

boolean $add_aliases = false (line 50)

var: controls inclusion of aliases in address book listing

boolean $add_dlists = false (line 48)

var: controls inclusion of distribution lists in address book listing

string $bname = 'hmailserver_db' (line 37)

var: backend tag

Redefinition of:

addressbook_backend::$bname

string $btype = 'local' (line 35)

var: local address book backend

Redefinition of:

addressbook_backend::$btype

object DB $db = false (line 53)

var: connection handle

int $db_type = 0 (line 56)

var: Database type. 0 - unknown, 1 - mysql. Use strict type checking (===)

string $domain_name = '' (line 46)

string|array $dsn = '' (line 44)

var: DSN for hMailServer database

boolean $listing = true (line 42)

var: flag controls address book listing and wide search

boolean $writeable = false (line 40)

var: flag indicates read-only address book

Redefinition of:

addressbook_backend::$writeable

Inherited Variables

Inherited from addressbook_backend

addressbook_backend::$bnum
addressbook_backend::$error
addressbook_backend::$sname

Methods

Constructor abook_hmailserver_db (line 63)

Constructor function

abook_hmailserver_db abook_hmailserver_db (array $params)

array $params: Check class description for available configuration params.

add (line 536)

Dummy function. Breaks with error, when new address book entry is added.

boolean add ()

Redefinition of:

addressbook_backend::add(): Adds address book entry Dummy function. Always returns false. Real backends should replace it.

close (line 133)

Closes database connection and destroys connection handle

void close ()

firstname (line 143)

Guesses firstname from account's data

string firstname (array $account)

array $account: array with associative results from hm_accounts or hm_aliases table

lastname (line 159)

Guesses lastname from account's data

string lastname (array $account)

array $account

listname (line 171)

string listname (array $list)

array $list

list_addr (line 420)

List all addresses

array list_addr ()

Redefinition of:

addressbook_backend::list_addr(): Lists all address book entries stored in backend Dummy function. Always returns false. Real backends should replace it.

lookup (line 309)

Lookup by nickname

return: array with address book data, empty array=no such entry or boolean false on error

array|boolean lookup (string $nickname)

string $nickname

Redefinition of:

addressbook_backend::lookup(): Look for exact address book entry match Dummy function. Always returns false. Real backends should replace it.

modify (line 552)

Dummy function. Breaks with error on address book entry modification.

boolean modify ()

Redefinition of:

addressbook_backend::modify(): Modifies address book entry Dummy function. Always returns false. Real backends should replace it.

open (line 93)

Open's connection to database

return: true on success, false on failure

boolean open ()

remove (line 544)

Dummy function. Breaks with error on address book entry deletion.

boolean remove ()

Redefinition of:

addressbook_backend::remove(): Deletes address book entries Dummy function. Always returns false. Real backends should replace it.

search (line 185)

Search address function

void search (expr $expr)

expr $expr: string search expression

Redefinition of:

addressbook_backend::search(): Search address book backend for expression Dummy function. Always returns false. Real backends should replace it.

Inherited Methods

Inherited From addressbook_backend

addressbook_backend::add()
addressbook_backend::fullname()
addressbook_backend::list_addr()
addressbook_backend::lookup()
addressbook_backend::modify()
addressbook_backend::remove()
addressbook_backend::search()
addressbook_backend::set_error()