Docs For Class JLDAP

Description

LDAP client class

since: 1.1
author: Samuel Moffatt <[email protected]>

Located in /connector/ldap.php (line 20)

Variable Summary

string $base_dn

string $host

boolean $negotiate_tls

boolean $no_referrals

string $password

int $port

string $search_string

string $username

string $users_dn

boolean $use_ldapV3

string $_dn

mixed $_resource

Method Summary

JLDAP JLDAP ([object An $configObj = null])

boolean bind ([string $username = null], [string $password = null])

void close ()

boolean connect ()

string getDN ()

string ipToNetAddress (string $ip)

array search (array $filters, [string $dnoverride = null])

void setDN (string $username)

Variables

string $base_dn = null (line 30)

var: Base DN (e.g. o=MyDir)

string $host = null (line 24)

var: Hostname of LDAP server

boolean $negotiate_tls = null (line 45)

var: Negotiate TLS (encrypted communications)

boolean $no_referrals = null (line 42)

var: No referrals (server transfers)

string $password = null (line 52)

var: Password to connect to server

int $port = null (line 27)

var: Port of LDAP server

string $search_string = null (line 36)

var: Search String

string $username = null (line 49)

var: Username to connect to server

string $users_dn = null (line 33)

var: User DN (e.g. cn=Users,o=MyDir)

boolean $use_ldapV3 = null (line 39)

var: Use LDAP Version 3

string $_dn = null (line 59)

var: Current DN

mixed $_resource = null (line 56)

var: LDAP Resource Identifier

Methods

Constructor JLDAP (line 66)

Constructor

access: public

JLDAP JLDAP ([object An $configObj = null])

object An $configObj: object of configuration variables

bind (line 148)

Binds to the LDAP directory

return: Result
access: public

boolean bind ([string $username = null], [string $password = null])

string $username: The username
string $password: The password

close (line 116)

Close the connection

access: public

void close ()

connect (line 84)

Connect to server

return: True if successful
access: public

boolean connect ()

getDN (line 137)

return: The current dn
access: public

string getDN ()

ipToNetAddress (line 212)

Converts a dot notation IP address to net address (e.g. for Netware, etc)

return: Net address
access: public

string ipToNetAddress (string $ip)

string $ip: IP Address (e.g. xxx.xxx.xxx.xxx)

search (line 168)

Perform an LDAP search

return: Multidimensional array of results
access: public

array search (array $filters, [string $dnoverride = null])

array $filters: Search Filters (array of strings)
string $dnoverride: DN Override

setDN (line 125)

Sets the DN with some template replacements

access: public

void setDN (string $username)

string $username: The username