mixed $coltypes = array('name' => array('limit'=>1),'firstname'=>array('limit'=>1),'surname'=>array('limit'=>1),'email'=>array('limit'=>1)) (line 47)

• access: public

• rcube_contacts::$coltypes
• rcube_ldap::$coltypes
• rcube_ldap_addressbook::$coltypes

mixed $error (line 50)

• access: protected

mixed $group_id = null (line 42)

• access: public

• rcube_contacts::$group_id
• rcube_ldap::$group_id
• rcube_ldap_addressbook::$group_id

mixed $page_size = 10 (line 44)

• access: public

• rcube_contacts::$page_size

mixed $readonly = true (line 38)

• access: public

• rcube_contacts::$readonly
• rcube_ldap::$readonly
• rcube_ldap_addressbook::$readonly

mixed $searchonly = false (line 39)

• access: public

mixed $sort_order = 'ASC' (line 46)

• access: public

static compose_contact_key (line 536)

Create a unique key for sorting contacts

• access: public

• $contact
• $sort_col

static compose_list_name (line 503)

Compose the name to display in the contacts list for the given contact record.

This respects the settings parameter how to list conacts.

• return: List name
• access: public

• array $contact: Hash array with contact data as key-value pairs

add_to_group (line 383)

Add the given contact records the a certain group

• return: Number of contacts added

• string $group_id: Group identifier
• array|string $ids: List of contact identifiers to be added

• rcube_contacts::add_to_group() : Add the given contact records the a certain group
• rcube_ldap::add_to_group() : Add the given contact records the a certain group
• rcube_ldap_addressbook::add_to_group() : Add the given contact records the a certain group

compare_search_value (line 559)

Compare search value with contact data

• return: Comparision result
• access: protected

• string $colname: Data name
• string|array $value: Data value
• string $search: Search value
• int $mode: Search mode

create_group (line 343)

Create a contact group with the given name

• return: False on error, array with record props in success

• string $name: The group name

• rcube_contacts::create_group() : Create a contact group with the given name
• rcube_ldap::create_group() : Create a contact group with the given name
• rcube_ldap_addressbook::create_group() : Create a contact group with the given name

delete_all (line 297)

Mark all records in database as deleted

• rcube_contacts::delete_all() : Remove all records from the database
• rcube_ldap::delete_all() : Remove all contact records
• rcube_ldap_addressbook::delete_all() : Remove all contact records

get_col_values (line 426)

Utility function to return all values of a certain data column either as flat list or grouped by subtype

• return: List of column values

• string $col: Col name
• array $data: Record data array as used for saving
• boolean $flat: True to return one array with all values, False for hash array with values grouped by type

get_group (line 331)

Get group properties such as name and email address(es)

• return: Group properties as hash array

• string $group_id: Group identifier

• rcube_contacts::get_group() : Get group properties such as name and email address(es)
• rcube_ldap::get_group() : Get group properties such as name and email address(es)
• rcube_ldap_addressbook::get_group() : Get group properties such as name and email address(es)

get_record (line 133)

Get a specific contact record

• return: Result object with all record fields or False if not found
• abstract:

• mixed $id: record identifier(s)
• boolean $assoc: True to return record as associative array, otherwise a result set is returned

• rcube_contacts::get_record() : Get a specific contact record
• rcube_ldap::get_record() : Get a specific contact record
• rcube_ldap_addressbook::get_record() : Get a specific contact record

get_result (line 123)

Return the last result set

• return: Current result set or NULL if nothing selected yet
• abstract:

• rcube_contacts::get_result() : Return the last result set
• rcube_ldap::get_result() : Return the last result set
• rcube_ldap_addressbook::get_result() : Return the last result set

insert (line 235)

Create a new contact record

• return: The created record ID on success, False on error

• array $save_data: Assoziative array with save data Keys: Field name with optional section in the form FIELD:SECTION Values: Field value. Can be either a string or an array of strings for multiple values
• boolean $check: True to check for duplicates first

• rcube_contacts::insert() : Create a new contact record
• rcube_ldap::insert() : Create a new contact record
• rcube_ldap_addressbook::insert() : Create a new contact record

list_groups (line 319)

List all active contact groups of this source

• return: Indexed list of contact groups, each a hash array

• string $search: Optional search string to match group name
• int $mode: Matching mode:
  1. - partial (*abc*),
  2. - strict (=),
  3. - prefix (abc*)

• rcube_contacts::list_groups() : List all active contact groups of this source
• rcube_ldap::list_groups() : List all active contact groups of this source
• rcube_ldap_addressbook::list_groups() : List all active contact groups of this source

refresh_search (line 81)

Refresh saved search set after data has changed

• return: New search set

rename_group (line 369)

Rename a specific contact group

• return: New name on success, false if no data was changed

• string $gid: Group identifier
• string $newname: New name to set for this group
• string &$newid: New group identifier (if changed, otherwise don't set)

• rcube_contacts::rename_group() : Rename a specific contact group
• rcube_ldap::rename_group() : Rename a specific contact group
• rcube_ldap_addressbook::rename_group() : Rename a specific contact group

search (line 109)

Search records

• return: List of contact records and 'count' value
• abstract:

• array $fields: List of fields to search in
• string $value: Search value
• int $mode: Matching mode:
  1. - partial (*abc*),
  2. - strict (=),
  3. - prefix (abc*)
• boolean $select: True if results are requested, False if count only
• boolean $nocount: True to skip the count query (select only)
• array $required: List of fields that cannot be empty

• rcube_contacts::search() : Search contacts
• rcube_ldap::search() : Search contacts
• rcube_ldap_addressbook::search() : Search contacts

set_group (line 306)

Setter for the current group

(empty, has to be re-implemented by extending class)

• $gid

• rcube_contacts::set_group() : Setter for the current group
• rcube_ldap::set_group() : Setter for the current group
• rcube_ldap_addressbook::set_group() : Setter for the current group

set_pagesize (line 179)

Set internal page size

• access: public

• number $size: Number of messages to display on one page

• rcube_ldap_addressbook::set_pagesize() : Set internal page size

set_sort_order (line 190)

Set internal sort settings

• string $sort_col: Sort column
• string $sort_order: Sort order

• rcube_ldap::set_sort_order() : Set internal sort settings
• rcube_ldap_addressbook::set_sort_order() : Set internal sort settings

update (line 268)

Update a specific contact record

• return: True on success, False on error

• mixed $id: Record identifier
• array $save_cols: Assoziative array with save data Keys: Field name with optional section in the form FIELD:SECTION Values: Field value. Can be either a string or an array of strings for multiple values

• rcube_contacts::update() : Update a specific contact record
• rcube_ldap::update() : Update a specific contact record
• rcube_ldap_addressbook::update() : Update a specific contact record