Roundcube Framework
\

\rcube_ldap_generic

Model class to access an LDAP directories

Summary

Methods
Properties
Constants
__construct()
connect()
log()
get_error()
set_debug()
set_cache()
scope2func()
set_config()
add()
delete()
mod_replace()
mod_add()
mod_del()
rename()
list_entries()
read_entries()
normalize_entry()
fulltext_search_filter()
No public properties found
No constants found
No protected methods found
$cache
$attributes
$error
N/A
No private methods found
No private properties found
N/A

Properties

$cache

$cache

private properties

$attributes

$attributes

$error

$error

Methods

__construct()

__construct(array  $config = null) : mixed

Class constructor

Parameters

array $config

Configuration

Returns

mixed —

connect()

connect(mixed  $host = null) : mixed

Establish a connection to the LDAP server

Parameters

mixed $host

Returns

mixed —

log()

log(mixed  $level, mixed  $msg) : mixed

Prints debug/error info to the log

Parameters

mixed $level
mixed $msg

Returns

mixed —

get_error()

get_error() : mixed

Returns the last LDAP error occurred

Returns

mixed —

Error message string or null if no error occurred

set_debug()

set_debug(mixed  $dbg = true) : mixed

Parameters

mixed $dbg

Returns

mixed —

set_cache()

set_cache(mixed  $cache_engine) : mixed

Parameters

mixed $cache_engine

Returns

mixed —

scope2func()

scope2func(mixed  $scope, mixed  $ns_function = null) : mixed

Parameters

mixed $scope
mixed $ns_function

Returns

mixed —

set_config()

set_config(mixed  $opt, mixed  $val = null) : mixed

Parameters

mixed $opt
mixed $val

Returns

mixed —

add()

add(mixed  $dn, mixed  $entry) : mixed

Parameters

mixed $dn
mixed $entry

Returns

mixed —

delete()

delete(mixed  $dn) : mixed

Parameters

mixed $dn

Returns

mixed —

mod_replace()

mod_replace(mixed  $dn, mixed  $entry) : mixed

Wrapper for ldap_mod_replace()

Parameters

mixed $dn
mixed $entry

Returns

mixed —

mod_add()

mod_add(mixed  $dn, mixed  $entry) : mixed

Wrapper for ldap_mod_add()

Parameters

mixed $dn
mixed $entry

Returns

mixed —

mod_del()

mod_del(mixed  $dn, mixed  $entry) : mixed

Wrapper for ldap_mod_del()

Parameters

mixed $dn
mixed $entry

Returns

mixed —

rename()

rename(mixed  $dn, mixed  $newrdn, mixed  $newparent = null, mixed  $deleteoldrdn = true) : mixed

Wrapper for ldap_rename()

Parameters

mixed $dn
mixed $newrdn
mixed $newparent
mixed $deleteoldrdn

Returns

mixed —

list_entries()

list_entries(mixed  $dn, mixed  $filter, mixed  $attributes = ['dn']) : mixed

Wrapper for ldap_list() + ldap_get_entries()

Parameters

mixed $dn
mixed $filter
mixed $attributes

Returns

mixed —

read_entries()

read_entries(mixed  $dn, mixed  $filter, mixed  $attributes = null) : mixed

Wrapper for ldap_read() + ldap_get_entries()

Parameters

mixed $dn
mixed $filter
mixed $attributes

Returns

mixed —

normalize_entry()

normalize_entry(array  $entry, bool  $flat = false) : array

Turn an LDAP entry into a regular PHP array with attributes as keys.

Parameters

array $entry

Attributes array as retrieved from ldap_get_attributes() or ldap_get_entries()
bool $flat

Convert one-element-array values into strings (not implemented)

Returns

array —

Hash array with attributes as keys

fulltext_search_filter()

fulltext_search_filter(string  $value, mixed  $attributes, int  $mode = 1) : string

Compose an LDAP filter string matching all words from the search string in the given list of attributes.

Parameters

string $value

Search value
mixed $attributes

List of LDAP attributes to search
int $mode

Matching mode: 0 - partial (abc), 1 - strict (=), 2 - prefix (abc*)

Returns

string —

LDAP filter