merged branch franmomu/add_phpdoc_to_authentication_events (PR symfony#6831)

fabpot · fabpot · commit 0c3d0db5decd · 2013-02-01T22:52:20.000+01:00
This PR was merged into the 2.1 branch. Commits ------- e7624b6 [Security] Add PHPDoc to AuthenticationEvents Discussion ---------- [Security] Added PHPDoc to AuthenticationEvents | Q | A | ------------- | --- | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | | License | MIT | Doc PR |
diff --git a/src/Symfony/Component/Security/Core/AuthenticationEvents.php b/src/Symfony/Component/Security/Core/AuthenticationEvents.php
@@ -13,7 +13,26 @@
 
 final class AuthenticationEvents
 {
+    /**
+     * The AUTHENTICATION_SUCCESS event occurs after a user is authenticated
+     * by one provider.
+     *
+     * The event listener method receives a
+     * Symfony\Component\Security\Core\Event\AuthenticationEvent instance.
+     *
+     * @var string
+     */
     const AUTHENTICATION_SUCCESS = 'security.authentication.success';
 
+    /**
+     * The AUTHENTICATION_FAILURE event occurs after a user cannot be
+     * authenticated by any of the providers.
+     *
+     * The event listener method receives a
+     * Symfony\Component\Security\Core\Event\AuthenticationFailureEvent
+     * instance.
+     *
+     * @var string
+     */
     const AUTHENTICATION_FAILURE = 'security.authentication.failure';
 }
