PEAR Manual
PrevNext

Configuration and connecting

Configuration and connecting -- How to configure Net_LDAP and connect to an LDAP server

Connecting to an LDAP server

To connect to an LDAP server, you should use Net_LDAP's static connect() method. It takes one parameter, an array full of configuration options, and either returns a Net_LDAP object if connecting works, or a Net_LDAP_Error object in case of a failure.

The following table lists all configuration options. If the default value for an option fits your needs, you don't need add it to your configuration array.

Table 51-1. Possible configuration options

NameDescriptionDefault
hostLDAP server name to connect to. You can provide several hosts in an array in which case the hosts are tried from left to right.localhost
portPort on the server389
versionLDAP version3
starttlsTLS is started after connectingfalse
binddnThe distinguished name to bind as (username)(none)
bindpwPassword for the binddn(none)
basednLDAP base name (root directory)(none)
optionsArray of additional ldap options as key-value pairsarray()
filterDefault search filter(objectClass=*)
scopeDefault search scope, see Searchsub

Example 51-1. Connecting to an LDAP server

// Inclusion of the Net_LDAP package:
require_once 'Net/LDAP.php';

// The configuration array:
$config = array (
    'binddn'    => 'cn=admin,ou=users,dc=example,dc=org',
    'bindpw'    => 'password',
    'basedn'    => 'dc=example,dc=org',
    'host'      => 'ldap.example.org'
);

// Connecting using the configuration:
$ldap = Net_LDAP::connect($config);

// Testing for connection error
if (PEAR::isError($ldap)) {
    die('Could not connect to LDAP-server: '.$ldap->getMessage());
}
PrevHomeNext
Error handlingUpSearch