summaryrefslogtreecommitdiffstats
path: root/Http/Session/SessionAuthenticationStrategyInterface.php
diff options
context:
space:
mode:
Diffstat (limited to 'Http/Session/SessionAuthenticationStrategyInterface.php')
-rw-r--r--Http/Session/SessionAuthenticationStrategyInterface.php19
1 files changed, 19 insertions, 0 deletions
diff --git a/Http/Session/SessionAuthenticationStrategyInterface.php b/Http/Session/SessionAuthenticationStrategyInterface.php
index c2d95c3..b248fd7 100644
--- a/Http/Session/SessionAuthenticationStrategyInterface.php
+++ b/Http/Session/SessionAuthenticationStrategyInterface.php
@@ -5,7 +5,26 @@ namespace Symfony\Component\Security\Http\Session;
use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
use Symfony\Component\HttpFoundation\Request;
+/**
+ * SessionAuthenticationStrategyInterface
+ *
+ * Implementation are responsible for updating the session after an interactive
+ * authentication attempt was successful.
+ *
+ * @author Johannes M. Schmitt <schmittjoh@gmail.com>
+ */
interface SessionAuthenticationStrategyInterface
{
+ /**
+ * This performs any necessary changes to the session.
+ *
+ * This method is called before the SecurityContext is populated with a
+ * Token, and only by classes inheriting from AbstractAuthenticationListener.
+ *
+ * @param Request $request
+ * @param TokenInterface $token
+ *
+ * @return void
+ */
function onAuthentication(Request $request, TokenInterface $token);
} \ No newline at end of file