1. class
  2. Comodojo
  3. \
  4. Ldaph
  5. \
  6. Ldaph

Ldaph

class Ldaph (View source)

ldaph: poor man's php ldap class

Methods

__construct(string $server, int $port = 389)

Constructor method

Ldaph
base(string $dcs)

Set ldap base

Ldaph
dn(string $dn)

Set ldap distinguished name (used in ldap bind)

Ldaph
version(int $mode = 3)

Set ldap version: 2 or 3 (default)

Ldaph
ssl(bool $mode = true)

Enable/disable ssl for connection

Ldaph
tls(bool $mode = true)

Enable/disable tls for connection

Ldaph
sso(bool $mode = true)

Enable/disable single sign on

Ldaph
account(string $user, string $pass)

Set user/pass for bind and search

Ldaph
searchbase(string $s)

Set ldap search base

Ldaph
fields(mixed $f)

Set fields to query ldap for

bool
auth(string $userName, string $userPass)

Authenticate an user via LDAP

array
search(string $what = "*", bool $clean = false)

Search ldap directory for $what

Details

at line 127
__construct(string $server, int $port = 389)

Constructor method

Prepare environment for connection (bind)

Parameters

string $server ldap server (ip or FQDN)
int $port port to connect to

Exceptions

LdaphException

at line 155
final Ldaph base(string $dcs)

Set ldap base

Parameters

string $dcs ldap base, comma separated, not spaced

Return Value

Ldaph

Exceptions

LdaphException

at line 178
final Ldaph dn(string $dn)

Set ldap distinguished name (used in ldap bind)

Before bind, special word USERNAME will be substituted by real username

Parameters

string $dn ldap DN, comma separated, not spaced

Return Value

Ldaph

Exceptions

LdaphException

at line 195
final Ldaph version(int $mode = 3)

Set ldap version: 2 or 3 (default)

Parameters

int $mode ldap protocol version

Return Value

Ldaph

at line 216
final Ldaph ssl(bool $mode = true)

Enable/disable ssl for connection

Parameters

bool $mode

Return Value

Ldaph

at line 237
final Ldaph tls(bool $mode = true)

Enable/disable tls for connection

Parameters

bool $mode

Return Value

Ldaph

at line 260
final Ldaph sso(bool $mode = true)

Enable/disable single sign on

Parameters

bool $mode

Return Value

Ldaph

Exceptions

LdaphException

at line 290
final Ldaph account(string $user, string $pass)

Set user/pass for bind and search

Parameters

string $user
string $pass

Return Value

Ldaph

Exceptions

LdaphException

at line 310
final Ldaph searchbase(string $s)

Set ldap search base

During search, special word PATTERN will be sbstituted by provided pattern

Parameters

string $s

Return Value

Ldaph

at line 329
final Ldaph fields(mixed $f)

Set fields to query ldap for

Parameters

mixed $f

Return Value

Ldaph

at line 352
bool auth(string $userName, string $userPass)

Authenticate an user via LDAP

Parameters

string $userName The user to auth
string $userPass The password for user

Return Value

bool

Exceptions

LdaphException
Exception

Search ldap directory for $what

Parameters

string $what The pattern to search for (will replace the searcbase PATTERN special word)
bool $clean If true, raw ldap_get_entries result will be normalized as plain array

Return Value

array

Exceptions

LdaphException
Exception