Model class for the local address book database
| package |
Framework |
|---|---|
| subpackage |
Addressbook |
__construct(object $dbconn, integer $user)
objectInstance of the rcube_db class
integerUser-ID
_count() : integer
integerContacts count
add_to_group( $group_id, $ids) : integer
integerNumber of contacts added
close()
compare_search_value(string $colname, string|array $value, string $search, integer $mode) : boolean
stringData name
string|arrayData value
stringSearch value
integerSearch mode
booleanComparision result
compose_contact_key( $contact, $sort_col)
compose_display_name( $contact, $full_email = false) : string
stringDisplay name
compose_list_name( $contact) : string
This respects the settings parameter how to list conacts.
stringList name
compose_search_name( $contact, $email = null, $name = null, $templ = null) : string
stringDisplay name
convert_db_data( $sql_arr)
convert_save_data( $save_data, $record = array())
count() : \rcube_result_set
create_group( $name) : mixed
mixedFalse on error, array with record props in success
delete( $ids, $force = true)
delete_all(boolean $with_groups = false)
booleanRemove also groups
delete_group( $gid) : boolean
booleanTrue on success, false if no data was changed
fulltext_sql_where( $value, $mode, $col = 'words', $bool = 'AND')
get_col_values( $col, $data, $flat = false) : array
arrayList of column values
get_error() : array
arrayHash array with the following fields: type, message
get_group( $group_id) : array
arrayGroup properties as hash array
get_name()
get_record( $id, $assoc = false) : \rcube_result_set|array
get_record_groups( $id) : array
| since | 0.5-beta |
|---|
arrayList of assigned groups as ID=>Name pairs
get_result() : \rcube_result_set
get_search_set() : mixed
mixedSearch properties used by this class
insert( $save_data, $check = false) : mixed
mixedThe created record ID on success, False on error
insertMultiple( $recset, $check = false) : array
arrayList of created record IDs
list_groups( $search = null, $mode) : array
arrayIndexed list of contact groups, each a hash array
list_records( $cols = null, $subset) : array
arrayIndexed list of contact records, each a hash array
normalize_string( $str) : string
Currently only optimized for Latin-1 characters; to be extended
| deprecated |
since 0.9-beta |
|---|
stringNormalized string
refresh_search() : mixed
mixedNew search set
remove_from_group( $group_id, $ids) : integer
integerNumber of deleted group members
rename_group( $gid, $newname, &$newid) : boolean
booleanNew name on success, false if no data was changed
reset()
search( $fields, $value, $mode, $select = true, $nocount = false, $required = array()) : object
objectrcube_result_set List of contact records and 'count' value
set_error( $type, $message)
set_group( $gid)
set_page( $page)
set_pagesize( $size)
set_search_set( $filter)
set_sort_order(string $sort_col, string $sort_order = null)
stringSort column
stringSort order
undelete( $ids)
unique_groupname(string $name) : string
stringName to check
stringA group name which is unique for the current use
update( $id, $save_cols) : mixed
mixedOn success if ID has been changed returns ID, otherwise True, False on error
validate( &$save_data, $autofix = false) : boolean
If input isn't valid, the message to display can be fetched using get_error()
booleanTrue if input is valid, False if not.
SEPARATOR
ERROR_READ_ONLY
ERROR_NO_CONNECTION
ERROR_VALIDATE
ERROR_SAVING
ERROR_SEARCH
SEARCH_ALL
SEARCH_STRICT
SEARCH_PREFIX
SEARCH_GROUPS
db_name :
db_groups :
db_groupmembers :
vcard_fieldmap :
user_id :
filter :
result :
cache :
table_cols :
fulltext_cols :
primary_key :
name :
readonly :
groups :
undelete :
list_page :
page_size :
group_id :
ready :
coltypes :
date_cols :
export_groups :
searchonly :
sort_col :
sort_order :
error :