feature #6402 [RFR] Documentation for the Ldap component (csarrazi)

xabbuh · xabbuh · commit d96ed74aaae9 · 2016-05-29T13:36:20.000+02:00
This PR was merged into the 2.8 branch. Discussion ---------- [RFR] Documentation for the Ldap component | Q | A | ------------- | --- | Doc fix? | no | New docs? | yes | Applies to | 2.8, 3.0 | Fixed tickets | #6201 #5756 Commits ------- 305abb8 Added documentation for the Ldap component
diff --git a/components/index.rst b/components/index.rst
@@ -22,6 +22,7 @@ The Components
     http_foundation/index
     http_kernel/index
     intl
+    ldap
     options_resolver
     phpunit_bridge
     process
diff --git a/components/ldap.rst b/components/ldap.rst
@@ -0,0 +1,72 @@
+.. index::
+   single: Ldap
+   single: Components; Ldap
+
+The Ldap Component
+==================
+
+    The Ldap component provides a means to connect to an LDAP server (OpenLDAP or Active Directory).
+
+Installation
+------------
+
+You can install the component in 2 different ways:
+
+* :doc:`Install it via Composer </components/using_components>` (``symfony/ldap`` on `Packagist`_);
+* Use the official Git repository (https://github.com/symfony/ldap).
+
+.. include:: /components/require_autoload.rst.inc
+
+Usage
+-----
+
+The :class:`Symfony\\Component\\Ldap\\LdapClient` class provides methods
+to authenticate and query against an LDAP server.
+
+The :class:`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 :method:`Symfony\\Component\\Ldap\\LdapClient::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::
+
+    use Symfony\Component\Ldap\LdapClient;
+    // ...
+
+    $ldap->find('dc=symfony,dc=com', '(&(objectclass=person)(ou=Maintainers))');
+
+.. _Packagist: https://packagist.org/packages/symfony/ldap
diff --git a/components/map.rst.inc b/components/map.rst.inc
@@ -112,6 +112,10 @@
 
   * :doc:`/components/intl`
 
+* **Ldap**
+
+  * :doc:`/components/ldap`
+
 * **OptionsResolver**
 
   * :doc:`/components/options_resolver`
diff --git a/cookbook/map.rst.inc b/cookbook/map.rst.inc
@@ -164,6 +164,7 @@
 * :doc:`Security Authentication (Identifying/Logging in the User) </cookbook/security/index>`
 
   * :doc:`/cookbook/security/form_login_setup`
+  * :doc:`/cookbook/security/ldap`
   * :doc:`/cookbook/security/entity_provider`
   * :doc:`/cookbook/security/guard-authentication`
   * :doc:`/cookbook/security/remember_me`
diff --git a/cookbook/security/index.rst b/cookbook/security/index.rst
@@ -8,6 +8,7 @@ Authentication (Identifying/Logging in the User)
     :maxdepth: 2
 
     form_login_setup
+    ldap
     entity_provider
     guard-authentication
     remember_me
diff --git a/cookbook/security/ldap.rst b/cookbook/security/ldap.rst
diff --git a/reference/configuration/security.rst b/reference/configuration/security.rst
