Docs For Class abook

Description

Located in /plugins/abook_extended/class/abook_extended.php (line 14)

addressbook_backend
   |
   --abook_extended

Direct descendents

Class	Description
abook_extended_mdb2	Extended address book backend for MDB2
abook_extended_peardb	Extended address book backend for Pear DB
abook_extended_adodb	Extended address book backend for AdoDB

Variable Summary

string $bname

string $client_charset

string $internal_charset

boolean $listing

integer $notesize

integer $quota

integer $textsize

boolean $writeable

Method Summary

boolean abook_extended (array $param)

boolean add_extended (array $userdata)

bool check_quota ()

boolean check_size (array $userdata)

void convert_charset (mixed $abook_entry, string $input_charset, string $output_charset)

string fullname (string $firstname, string $lastname)

array lookup_extended (alias $alias)

boolean modify_extended (alias $alias, userdata $userdata)

Variables

string $bname = 'abook_extended' (line 16)

var: internal backend name

Redefinition of:

addressbook_backend::$bname

Redefined in descendants as:

string $client_charset = '' (line 19)

var: user's character set

Redefined in descendants as:

abook_extended_adodb::$client_charset

string $internal_charset = '' (line 21)

var: db character set

Redefined in descendants as:

abook_extended_adodb::$internal_charset

boolean $listing = false (line 25)

var: controls address listing

Redefined in descendants as:

integer $notesize = 0 (line 31)

var: comment field size

Redefined in descendants as:

integer $quota = 0 (line 27)

var: address book quota

Redefined in descendants as:

integer $textsize = 0 (line 29)

var: text field size

Redefined in descendants as:

boolean $writeable = false (line 23)

var: controls write access to backend

Redefinition of:

addressbook_backend::$writeable

Redefined in descendants as:

Inherited Variables

Inherited from addressbook_backend

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

Methods

Constructor abook_extended (line 40)

Constructor

boolean abook_extended (array $param)

array $param

add_extended (line 61)

Adds address book entry (extended version)

return: true = success, false = failure, error message is in standard $abook error message buffer.

boolean add_extended (array $userdata)

array $userdata

Redefined in descendants as:

abook_extended_mdb2::add_extended() : Adds address book entry (extended version)
abook_extended_peardb::add_extended() : Adds address book entry (extended version)
abook_extended_adodb::add_extended() : Adds address book entry (extended version)

check_quota (line 79)

Checks address book quotas

return: false if user quota is exceeded

bool check_quota ()

Redefined in descendants as:

abook_extended_mdb2::check_quota() : Checks address book quotas
abook_extended_peardb::check_quota() : Checks address book quotas
abook_extended_adodb::check_quota() : Checks address book quotas

check_size (line 121)

return: true, when entry fits into db fields

boolean check_size (array $userdata)

array $userdata: address book entry

convert_charset (line 104)

void convert_charset (mixed $abook_entry, string $input_charset, string $output_charset)

mixed $abook_entry: one address book entry (array) or string
string $input_charset
string $output_charset

fullname (line 90)

Internal function that creates full name from first and last names

return: full name

string fullname (string $firstname, string $lastname)

string $firstname
string $lastname

Redefinition of:

addressbook_backend::fullname(): Creates full name from given name and surname

lookup_extended (line 51)

Lookup alias (extended version)

return: with address book entry. false on error. empty array, if entry does not exist.

array lookup_extended (alias $alias)

alias $alias: string

Redefined in descendants as:

abook_extended_mdb2::lookup_extended() : Lookup alias (extended version)
abook_extended_peardb::lookup_extended() : Lookup alias (extended version)
abook_extended_adodb::lookup_extended() : Lookup alias (extended version)

modify_extended (line 71)

Modify address (extended version)

boolean modify_extended (alias $alias, userdata $userdata)

alias $alias
userdata $userdata

Redefined in descendants as:

abook_extended_mdb2::modify_extended() : Modify address (extended version)
abook_extended_peardb::modify_extended() : Modify address (extended version)
abook_extended_adodb::modify_extended() : Modify address (extended version)

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()