Docs For Class LdapClient

Class LdapClient

Description

LDAP client class

Implementation of an LDAP client, which is able to search for entries, add new entries and modify or delete existing entries.

Example:

$ldap = new LdapClient(array(
'host' => 'ldap.mydomain.com',
'bindDN' => 'cn=Administrator,dc=yourcompany,dc=com',
'bindPassword' => 'password',
'baseDN' => 'dc=yourcompany,dc=com'
));
if ($ldap->connect()) {
$result = $ldap->search('(cn=*)');
while ($entry = $result->fetchEntry()) {
println($entry->getAttribute('cn');
}
$ldap->close();
}

author: Marcos Pont <mpont@users.sourceforge.net>
version: $Revision$
usedby: AuthLdap
uses: TypeUtils
uses: LdapSearchResult
uses: System
uses: LdapEntry

Located in /core/net/ldap/LdapClient.class.php (line 83)

PHP2Go
   |
   --LdapClient

Variable Summary

string $baseDN

string $bindDN

string $bindPassword

resource $handle

string $host

int $port

int $protocolVersion

bool $useTLS

Method Summary

LdapClient LdapClient ([array $config = array()])

void __destruct ()

bool add (LdapEntry $entry)

void close ()

bool connect ()

bool delete (LdapEntry|string $entry, [bool $recursive = TRUE])

LdapEntry|FALSE find (string $dn)

resource &getHandle ()

mixed getOption (int $option)

bool isConnected ()

LdapSearchResult|NULL search (string $filter, [array $settings = array()], [ $sort = array()])

void setBaseDN (string $baseDN)

void setBindParameters (string $bindDN, string $bindPassword)

bool setOption (int $option, mixed $value)

void setProtocolVersion (int $version)

void setServer (string $host, [int $port = NULL])

bool update (LdapEntry $entry)

array _explodeDN (string $dn)

string _getErrorMessage ()

Variables

string $baseDN (line 108)

Base DN used on searches

string $bindDN (line 114)

DN used to bind

string $bindPassword (line 120)

Password used to bind

resource $handle (line 133)

Connection handle

access: private

string $host = 'localhost' (line 96)

LDAP host

int $port = LDAP_DEFAULT_PORT (line 102)

LDAP port

int $protocolVersion = 3 (line 90)

LDAP protocol version

bool $useTLS = TRUE (line 126)

Enable or disable TLS (Transport Layer Security)

Methods

Constructor LdapClient (line 149)

Class constructor

Allowed config arguments:

host
bindDN
bindPassword
baseDN
useTLS
protocolVersion

LdapClient LdapClient ([array $config = array()])

array $config: Configuration parameters

Destructor __destruct (line 171)

Class destructor

Closes the LDAP connection if opened.

void __destruct ()

add (line 433)

Adds a new entry on the LDAP server

Example:

$ldap = new LdapClient(array(
'host' => 'ldap.yourdomain.com',
'bindDN' => 'cn=Administrator,dc=yourcompany,dc=com',
'bindPassword' => '123456',
'baseDN' => 'dc=yourcompany,dc=com'
));
$entry = new LdapEntry('uid=foo,dc=yourcompany,dc=com', array(
'cn' => 'Foo Bar',
'gn' => 'Foo',
'sn' => 'Bar',
'uid' => 'foo',
'userPassword' => UnixCrypt::encrypt('123456'),
'objectClass' => 'inetOrgPerson'
));
$ldap->add($entry);

bool add (LdapEntry $entry)

LdapEntry $entry: New entry

close (line 560)

Closes the LDAP connection

void close ()

connect (line 240)

Opens the connection with the LDAP server

bool connect ()

delete (line 528)

Deletes an entry from the LDAP server

bool delete (LdapEntry|string $entry, [bool $recursive = TRUE])

LdapEntry|string $entry: Entry object or entry DN
bool $recursive: Delete entry's children recursively

find (line 392)

Searches for a given DN in the LDAP directory

Returns FALSE in case of error or entry not found. When DN is incomplete, base DN will be added.

Examples:

$client = new LdapClient(array(
'bindDN' => 'cn=Administrator,dc=yourcompany,dc=com',
'bindPassword' => 'secret',
'baseDN' => 'dc=yourcompany,dc=com'
));
$entry->find('uid=foo');
$entry->find('uid=foo,ou=people,dc=yourcompany,dc=com');

LdapEntry|FALSE find (string $dn)

string $dn: Entry DN

getHandle (line 284)

Get connection handle

resource &getHandle ()

getOption (line 295)

Reads an option from the LDAP server

link: http://br2.php.net/ldap#ldap.constants

mixed getOption (int $option)

int $option: Option number

isConnected (line 275)

Checks if connection is active

bool isConnected ()

search (line 338)

Performs a search on the LDAP server

Allowed keys for $settings:

sizeLimit : limit of entries to be fetched
timeLimit : search timeout
attrsOnly : set this to 1 if only attribute types are wanted
attributes : required attributes
scope : search scope (LDAP_SEARCH_SINGLE_LEVEL, LDAP_SEARCH_BASE or LDAP_SEARCH_SUBTREE)

LdapSearchResult|NULL search (string $filter, [array $settings = array()], [ $sort = array()])

string $filter: Search filter
array $settings: Search settings
$sort

setBaseDN (line 203)

Set base DN used to perform searches

void setBaseDN (string $baseDN)

string $baseDN: Base DN

setBindParameters (line 228)

Set bind parameters

When using LDAP, $bindDN is a distinguished name. When using AD, $bindDN is an email address.

Examples:

/* LDAP */
$client = new LdapClient();
$client->setServer('ldap.yourcompany.com', 389);
$client->setBindParameters('cn=Administrator,dc=yourcompany,dc=com', 'secret');
/* Microsoft AD */
$client = new LdapClient();
$client->setServer('ad.yourcompany.com', 389);
$client->setBindParameters('admin@yourcompany.com', 'secret');

void setBindParameters (string $bindDN, string $bindPassword)

string $bindDN: Bind DN
string $bindPassword: Bind password

setOption (line 313)

Changes an option on the LDAP server

link: http://br2.php.net/ldap#ldap.constants

bool setOption (int $option, mixed $value)

int $option: Option number
mixed $value: Option value

setProtocolVersion (line 180)

Set LDAP protocol version

void setProtocolVersion (int $version)

int $version: Protocol version

setServer (line 190)

Set LDAP host and port

void setServer (string $host, [int $port = NULL])

string $host: Host name or IP address
int $port: Port number

update (line 470)

Updates a given LDAP entry

Collects all changes stored in the class, performing attribute inserts, updates and removes sequentially.

Example:

$ldap = new LdapClient(array(
'host' => 'ldap.yourdomain.com',
'bindDN' => 'cn=Administrator,dc=yourcompany,dc=com',
'bindPassword' => '123456',
'baseDN' => 'dc=yourcompany,dc=com'
));
$entry = $ldap->find('uid=foo');
$entry->setAttribute('gn', 'Foo');
$entry->setAttribute('sn', 'Bar');
$entry->addValues('mail', array('foo@foo.org', 'foobar@bar.org'));
$ldap->update($entry);

bool update (LdapEntry $entry)

LdapEntry $entry: Entry to be updated

_explodeDN (line 589)

Wrapper over the function ldap_explode_dn()

Ensures that a DN is properly escaped and encoded.

return: Exploded DN
access: private

array _explodeDN (string $dn)

string $dn: DN

_getErrorMessage (line 573)

Retrieves an error message from the server

access: private

string _getErrorMessage ()

Inherited Methods

Inherited From PHP2Go

PHP2Go::PHP2Go()
PHP2Go::equals()
PHP2Go::generateUniqueId()
PHP2Go::getClassName()
PHP2Go::getConfigVal()
PHP2Go::getLangVal()
PHP2Go::getObjectName()
PHP2Go::getParentName()
PHP2Go::hasDestructor()
PHP2Go::hashCode()
PHP2Go::isA()
PHP2Go::isSubclassOf()
PHP2Go::logError()
PHP2Go::raiseError()
PHP2Go::registerDestructor()
PHP2Go::registerShutdownFunc()
PHP2Go::retrieve()
PHP2Go::store()
PHP2Go::__toString()

Documentation generated on Sun, 07 Oct 2007 19:27:06 -0300 by phpDocumentor 1.3.2