The Ldap Component
Warning: You are browsing the documentation for Symfony 2.x, which is no longer maintained.
Read the updated version of this page for Symfony 7.2 (the current stable version).
The Ldap component provides a means to connect to an LDAP server (OpenLDAP or Active Directory).
2.8
The Ldap component was introduced in Symfony 2.8.
Installation
1
$ composer require symfony/ldapAlternatively, you can clone the https://github.com/symfony/ldap repository.
Note
If you install this component outside of a Symfony application, you must
require the vendor/autoload.php file in your code to enable the class
autoloading mechanism provided by Composer. Read
this article for more details.
Usage
The LdapClient class provides methods to authenticate and query against an LDAP server.
The 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:
1 2 3
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:
1 2 3 4
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:
1 2 3 4
use Symfony\Component\Ldap\LdapClient;
// ...
$ldap->find('dc=symfony,dc=com', '(&(objectclass=person)(ou=Maintainers))');