Docs For Class abook_extended

Description

Extended address book backend for Pear DB

Located in /plugins/abook_extended/class/abook_extended_peardb.php (line 24)

addressbook_backend
   |
   --abook_extended
      |
      --abook_extended_peardb

Variable Summary

string $bname

string $btype

object Pear $db

string $db_dns

string $db_table

integer $db_type

boolean $listing

integer $notesize

string $owner

integer $quota

string $sname

integer $textsize

boolean $writeable

Method Summary

boolean abook_extended_peardb (array $param)

boolean add (array $userdata)

boolean add_extended (array $userdata)

bool check_quota ()

void close ()

array list_addr ()

array lookup (alias $alias)

array lookup_extended (alias $alias)

boolean modify (alias $alias, userdata $userdata)

boolean modify_extended (alias $alias, userdata $userdata)

boolean open ()

boolean remove (array $alias)

array search (string $expr)

Variables

string $bname = 'abook_extended_peardb' (line 28)

var: internal backend name

Redefinition of:

abook_extended::$bname

string $btype = 'local' (line 26)

var: backend type

Redefinition of:

addressbook_backend::$btype

object Pear $db = false (line 43)

var: DB connection object

string $db_dns = '' (line 33)

var: DNS

string $db_table = 'address' (line 35)

var: db table

integer $db_type = 0 (line 40)

1 - mysql

boolean $listing = false (line 53)

var: controls address listing

Redefinition of:

abook_extended::$listing

integer $notesize = 65536 (line 59)

var: comment field size

Redefinition of:

abook_extended::$notesize

string $owner = '' (line 49)

Address book owner

integer $quota = 0 (line 55)

var: address book quota

Redefinition of:

abook_extended::$quota

string $sname = '' (line 30)

var: displayed backend name

Redefinition of:

addressbook_backend::$sname

integer $textsize = 255 (line 57)

var: text field size

Redefinition of:

abook_extended::$textsize

boolean $writeable = false (line 51)

var: controls write access to backend

Redefinition of:

abook_extended::$writeable

Inherited Variables

Inherited from abook_extended

abook_extended::$client_charset
abook_extended::$internal_charset

Inherited from addressbook_backend

addressbook_backend::$bnum
addressbook_backend::$error

Methods

Constructor abook_extended_peardb (line 68)

Constructor

boolean abook_extended_peardb (array $param)

array $param: address book params

add (line 370)

Adds address book entry

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

boolean add (array $userdata)

array $userdata: array with nickname, firstname, lastname, email and label keys and string values.

Redefinition of:

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

add_extended (line 624)

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: array with nickname, firstname, lastname, email and label keys and string values.

Redefinition of:

abook_extended::add_extended(): Adds address book entry (extended version)

check_quota (line 785)

Checks address book quotas

Address book backend methods that add new address book entries, should add entries only when function returns boolean true.

return: false if user quota is exceeded

bool check_quota ()

Redefinition of:

abook_extended::check_quota(): Checks address book quotas

close (line 174)

Closes db connection and destroys db resource

void close ()

list_addr (line 327)

List all addresses

return: numerical array with address book entries. false on error

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

Lookup alias

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

array lookup (alias $alias)

alias $alias: string

Redefinition of:

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

lookup_extended (line 531)

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

Redefinition of:

abook_extended::lookup_extended(): Lookup alias (extended version)

modify (line 464)

Modify address

boolean modify (alias $alias, userdata $userdata)

alias $alias
userdata $userdata

Redefinition of:

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

modify_extended (line 700)

Modify address (extended version)

boolean modify_extended (alias $alias, userdata $userdata)

alias $alias
userdata $userdata

Redefinition of:

abook_extended::modify_extended(): Modify address (extended version)

open (line 137)

Opens connection to database and sets up database connection options.

return: Connection status. true - connection established, false - connection failed, check abook error message

boolean open ()

remove (line 423)

Deletes address book entries

return: false on error. error message is in standard $abook error buffer.

boolean remove (array $alias)

array $alias: numerical array with deleted nickname values

Redefinition of:

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

search (line 190)

Searches address book

Backend supports only * and ? wildcards. Complex eregs are not supported. Search is case insensitive.

return: numerical array with address book entries. false on error.

array search (string $expr)

string $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 abook_extended

abook_extended::abook_extended()
abook_extended::add_extended()
abook_extended::check_quota()
abook_extended::check_size()
abook_extended::convert_charset()
abook_extended::fullname()
abook_extended::lookup_extended()
abook_extended::modify_extended()

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