merged branch franmomu/added_phpdoc_security_events (PR symfony#6818)

fabpot · fabpot · commit 5663820aa682 · 2013-01-21T16:19:16.000+01:00
This PR was squashed before being merged into the 2.0 branch (closes symfony#6818). Commits ------- 598ae9d [Security] PHPDoc in SecurityEvents Discussion ---------- [Security] PHPDoc in SecurityEvents | Q | A | ------------- | --- | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | | License | MIT | Doc PR | I'm not sure about the description given.
diff --git a/src/Symfony/Component/Security/Http/SecurityEvents.php b/src/Symfony/Component/Security/Http/SecurityEvents.php
@@ -13,7 +13,25 @@
 
 final class SecurityEvents
 {
+    /**
+     * The INTERACTIVE_LOGIN event occurs after a user is logged in
+     * interactively for authentication based on http, cookies or X509.
+     *
+     * The event listener method receives a
+     * Symfony\Component\Security\Http\Event\InteractiveLoginEvent instance.
+     *
+     * @var string
+     */
     const INTERACTIVE_LOGIN = 'security.interactive_login';
 
+    /**
+     * The SWITCH_USER event occurs before switch to another user and
+     * before exit from an already switched user.
+     *
+     * The event listener method receives a
+     * Symfony\Component\Security\Http\Event\SwitchUserEvent instance.
+     *
+     * @var string
+     */
     const SWITCH_USER = 'security.switch_user';
 }
