minor #32316 [Ldap] Document the new exceptions thrown by the code (javiereguiluz)

fabpot · fabpot · commit c3e914c6ebee · 2019-07-03T14:43:13.000+02:00
This PR was merged into the 4.4 branch. Discussion ---------- [Ldap] Document the new exceptions thrown by the code | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | no  | BC breaks? | no  | Deprecations? | no  | Tests pass? | yes  | Fixed tickets | - | License | MIT | Doc PR | not needed While deciding if we should document #31547 I saw that the new exceptions weren't documented in the code. I don't know if this is the place where this should be added. Commits ------- 0d27af9 [Ldap] Document the new exceptions thrown by the code
diff --git a/src/Symfony/Component/Ldap/Adapter/ConnectionInterface.php b/src/Symfony/Component/Ldap/Adapter/ConnectionInterface.php
@@ -11,6 +11,10 @@
 
 namespace Symfony\Component\Ldap\Adapter;
 
+use Symfony\Component\Ldap\Exception\AlreadyExistsException;
+use Symfony\Component\Ldap\Exception\ConnectionTimeoutException;
+use Symfony\Component\Ldap\Exception\InvalidCredentialsException;
+
 /**
  * @author Charles Sarrazin <charles@sarraz.in>
  */
@@ -28,6 +32,10 @@ public function isBound();
      *
      * @param string $dn       The user's DN
      * @param string $password The associated password
+     *
+     * @throws AlreadyExistsException      When the connection can't be created because of an LDAP_ALREADY_EXISTS error
+     * @throws ConnectionTimeoutException  When the connection can't be created because of an LDAP_TIMEOUT error
+     * @throws InvalidCredentialsException When the connection can't be created because of an LDAP_INVALID_CREDENTIALS error
      */
     public function bind($dn = null, $password = null);
 }
