Roundcube Framework
Back to top  

rcube_ldap_generic

Extends \Net_LDAP3

Model class to access an LDAP directories

package

Framework
subpackage

LDAP

Methods

__construct

__construct( $config = null)

Arguments

$config

add

add( $dn,  $entry)
deprecated

Arguments

$dn

$entry

Establish a connection to the LDAP server

connect( $host = null)

Arguments

$host

delete

delete( $dn)
deprecated

Arguments

$dn

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

fulltext_search_filter(string $value,  $attributes, integer $mode = 1) : string
static

Arguments

$value

string

Search value

$attributes

$mode

integer

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

Response

string

LDAP filter

Get a specific LDAP entry, identified by its DN

get_entry(string $dn, array $attributes = array()) : array

Arguments

$dn

string

Record identifier

$attributes

array

Attributes to return

Response

array

Hash array

Returns the last LDAP error occurred

get_error() : mixed

Response

mixed

Error message string or null if no error occurred

Wrapper for ldap_list() + ldap_get_entries()

list_entries( $dn,  $filter,  $attributes = array('dn'))
see \ldap_list() \ldap_get_entries()

Arguments

$dn

$filter

$attributes

Prints debug/error info to the log

log( $level,  $msg)

Arguments

$level

$msg

Wrapper for ldap_mod_add()

mod_add( $dn,  $entry)
see \ldap_mod_add()

Arguments

$dn

$entry

Wrapper for ldap_mod_del()

mod_del( $dn,  $entry)
see \ldap_mod_del()

Arguments

$dn

$entry

Wrapper for ldap_mod_replace()

mod_replace( $dn,  $entry)
see \ldap_mod_replace()

Arguments

$dn

$entry

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

normalize_entry(array $entry, boolean $flat = false) : array
static

Arguments

$entry

array

Attributes array as retrieved from ldap_get_attributes() or ldap_get_entries()

$flat

boolean

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

Response

array

Hash array with attributes as keys

Wrapper for ldap_read() + ldap_get_entries()

read_entries( $dn,  $filter,  $attributes = null)
see \ldap_read() \ldap_get_entries()

Arguments

$dn

$filter

$attributes

Wrapper for ldap_rename()

rename( $dn,  $newrdn,  $newparent = null,  $deleteoldrdn = true)
see \ldap_rename()

Arguments

$dn

$newrdn

$newparent

$deleteoldrdn

scope2func

scope2func( $scope,  &$ns_function = null)
static
deprecated

Arguments

$scope

$ns_function

set_cache

set_cache( $cache_engine)
deprecated

Arguments

$cache_engine

set_config

set_config( $opt,  $val = null)
deprecated

Arguments

$opt

$val

set_debug

set_debug( $dbg = true)
deprecated

Arguments

$dbg

Properties

private properties

cache :

Type(s)

attributes

attributes :

Type(s)

error

error :

Type(s)