Skip to content

use Ldap instead of the deprecated LdapClient #7950

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 3, 2017
Merged

use Ldap instead of the deprecated LdapClient #7950

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e38e58c
use Ldap instead of the deprecated LdapClient
xabbuh May 26, 2017
2b990f4
Fixed code indentation
javiereguiluz May 28, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 21 additions & 11 deletions components/ldap.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,12 @@ You can install the component in 2 different ways:
Usage
-----

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

The :class:`Symfony\\Component\\Ldap\\LdapClient` class can be configured
The ``Ldap`` class uses an :class:`Symfony\\Component\\Ldap\\Adapter\\AdapterInterface`
to communicate with an LDAP server. The :class:`adapter <Symfony\\Component\\Ldap\\Adapter\\ExtLdap\\Adapter>`
for PHP's built-in LDAP extension, for example, can be configured
using the following options:

``host``
Expand All @@ -47,24 +49,32 @@ using the following options:

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 :method:`Symfony\\Component\\Ldap\\LdapClient::bind` method
use Symfony\Component\Ldap\Adapter\ExtLdap\Adapter;
use Symfony\Component\Ldap\Ldap;

$adapter = new Adapter(array(
'host' => 'my-server',
'port' => 389,
'encryption' => 'tls',
'options' => array(
'protocol_version' => 3,
'referrals' => false,
),
));
$ldap = new Ldap($adapter);

The :method:`Symfony\\Component\\Ldap\\Ldap::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
:method:`Symfony\\Component\\Ldap\\LdapClient::find` method::
:method:`Symfony\\Component\\Ldap\\Ldap::find` method::

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

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