Model class to access an LDAP directories
| package |
Framework |
|---|---|
| subpackage |
LDAP |
__construct(array $p)
arrayLDAP connection properties
set_debug(boolean $dbg = true)
booleanTrue if LDAP commands should be logged
set_config(mixed $opt, mixed $val = null)
mixedOption name as string or hash array with multiple options
mixedOption value
set_cache($cache_engine)
set_vlv_page(\number $page, \number $size = 10)
\numberPage number to list (starting at 1)
\numberNumber of entries to display on one page
connect($host = null)
sasl_bind(string $authc, string $pass, string $authz = null) : boolean
stringAuthentication user
stringBind password
stringAutorization user
booleanTrue on success, False on error
bind(string $dn, string $pass) : boolean
stringBind DN
stringBind password
booleanTrue on success, False on error
close()
get_result() : object
objectrcube_ldap_result Result object
get_entry(string $dn) : array
stringRecord identifier
arrayHash array
search(string $base_dn, string $filter = '', string $scope = 'sub', array $attrs = array('dn'), array $prop = array(), boolean $count_only = false) : mixed
stringThe base DN to query
stringThe LDAP filter for search
stringThe LDAP scope (list|sub|base)
arrayList of entry attributes to read
arrayHash array with query configuration properties:
booleanSet to true if only entry count is requested
mixedrcube_ldap_result object or number of entries (if count_only=true) or false on error
modify(string $dn, $parms, int $mode = 255)
stringEntry DN
intUpdate mode (UPDATE_MOD_ADD | UPDATE_MOD_DELETE | UPDATE_MOD_REPLACE)
add($dn, $entry)
| see | \ldap_add() |
|---|---|
delete($dn)
| see | \ldap_delete() |
|---|---|
mod_replace($dn, $entry)
| see | \ldap_mod_replace() |
|---|---|
mod_add($dn, $entry)
| see | \ldap_mod_add() |
|---|---|
mod_del($dn, $entry)
| see | \ldap_mod_del() |
|---|---|
rename($dn, $newrdn, $newparent = null, $deleteoldrdn = true)
| see | \ldap_rename() |
|---|---|
list_entries($dn, $filter, $attributes = array('dn'))
| see | \ldap_list() \ldap_get_entries() |
|---|---|
read_entries($dn, $filter, $attributes = null)
| see | \ldap_read() \ldap_get_entries() |
|---|---|
scope2func(string $scope, string &$ns_function = null) : string
stringThe LDAP scope (sub|base|list)
stringFunction to be used for numSubOrdinates queries
stringPHP function to be used to query directory
scopeint2str($scope)
escape_value(string $val) : string
stringValue to quote
stringThe escaped value
escape_dn(string $dn) : string
stringDN value o quote
stringThe escaped value
normalize_result(array $result) : array
arrayLDAP result set fetched with ldap_get_entries()
arrayHash array with normalized entries, indexed by their DNs
normalize_entry(array $entry) : array
arrayAttributes array as retrieved from ldap_get_attributes() or ldap_get_entries()
arrayHash array with attributes as keys
_vlv_set_controls($sort, $list_page, $page_size, $search = null)
_attr_name($namev)
quote_string(string $str, bool $dn = false) : string
stringAttribute value
boolTrue if the attribute is a DN
stringQuoted string
_debug($str)
_vlv_search($sort, $search)
_find_vlv($base_dn, $filter, $scope, $sort_attrs = null) : string
stringSort attribute or False if no match
_read_vlv_config()
_vlv_ber_encode($offset, $rpp, $search = '') : string
stringBER encoded option value
_sort_ber_encode($sortcols) : string
stringBER encoded option value
_ber_addseq($str, $identifier)
_ber_encode_int($offset)
_string2hex($str)
UPDATE_MOD_ADD
UPDATE_MOD_DELETE
UPDATE_MOD_REPLACE
UPDATE_MOD_FULL
conn :
vlv_active :
cache :
config :
attributes :
entries :
result :
debug :
list_page :
page_size :
vlv_config :