Model class to access an LDAP address directory
| package |
Framework |
|---|---|
| subpackage |
Addressbook |
__construct(array $p, boolean $debug = false, string $mail_domain = null)
arrayLDAP connection properties
booleanEnables debug mode
stringCurrent user mail domain name
_attr_name( $namev)
_connect()
_entry_sort_cmp( $a, $b)
_fetch_groups( $search = null, $mode, $vlv_page = null)
_ldap2result( $rec)
_list_group_members( $dn, $entry, $attr, $count) : array
arrayAccumulated group members
_list_group_memberurl( $dn, $entry, $count) : array
arrayAccumulated group members
_map_data( $save_cols)
_map_field( $field)
add_autovalues( &$attrs)
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
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
dn_decode(string $str) : string
stringEncoded HTML identifier string
stringDN string
dn_encode(string $str) : string
stringDN string
stringEncoded HTML identifier string
extended_search(boolean $count = false) : integer|array
booleanReturn count instead of the records
integer|arrayCount of records or the result array (with 'count' item)
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_group_entry( $group_id)
get_group_member_attr( $object_classes = array(), $default = 'member')
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
is_group_entry( $entry)
list_group_members( $dn, $count = false, $entries = null) : array
arrayAccumulated group members
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_debug(boolean $dbg = true)
booleanTrue if LDAP commands should be logged
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)
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.
ERROR_READ_ONLY
ERROR_NO_CONNECTION
ERROR_VALIDATE
ERROR_SAVING
ERROR_SEARCH
SEARCH_ALL
SEARCH_STRICT
SEARCH_PREFIX
SEARCH_GROUPS
primary_key :
groups :
readonly :
ready :
group_id :
coltypes :
export_groups :
ldap :
formats :
prop :
fieldmap :
filter :
sub_filter :
result :
ldap_result :
mail_domain :
debug :
group_types : array
| var |
|---|
array
base_dn :
groups_base_dn :
group_data :
group_search_cache :
cache :
searchonly :
undelete :
list_page :
page_size :
sort_col :
sort_order :
date_cols :
error :