Installation¶

You can install the component in 2 different ways:

• Install it via Composer (symfony/ldap on Packagist);
• Use the official Git repository (https://github.com/symfony/ldap).

Then, require the vendor/autoload.php file to enable the autoloading mechanism provided by Composer. Otherwise, your application won’t be able to find the classes of this Symfony component.

Usage¶

The Symfony\Component\Ldap\LdapClient class provides methods to authenticate and query against an LDAP server.

The Symfony\Component\Ldap\LdapClient class can be configured using the following options:

host

IP or hostname of the LDAP server

port

Port used to access the LDAP server

version

The version of the LDAP protocol to use

useSsl

Whether or not to secure the connection using SSL

useStartTls

Whether or not to secure the connection using StartTLS

optReferrals

Specifies whether to automatically follow referrals returned by the LDAP server

For example, to connect to a start-TLS secured LDAP server:

use Symfony\Component\Ldap\LdapClient;

$ldap = new LdapClient('my-server', 389, 3, false, true);

The bind() method authenticates a previously configured connection using both the distinguished name (DN) and the password of a user:

use Symfony\Component\Ldap\LdapClient;
// ...

$ldap->bind($dn, $password);

Once bound (or if you enabled anonymous authentication on your LDAP server), you may query the LDAP server using the find() method:

use Symfony\Component\Ldap\LdapClient;
// ...

$ldap->find('dc=symfony,dc=com', '(&(objectclass=person)(ou=Maintainers))');