summaryrefslogtreecommitdiffstats
path: root/Http/Authentication
diff options
context:
space:
mode:
Diffstat (limited to 'Http/Authentication')
-rw-r--r--Http/Authentication/AuthenticationFailureHandlerInterface.php21
-rw-r--r--Http/Authentication/AuthenticationSuccessHandlerInterface.php21
2 files changed, 42 insertions, 0 deletions
diff --git a/Http/Authentication/AuthenticationFailureHandlerInterface.php b/Http/Authentication/AuthenticationFailureHandlerInterface.php
index 4957edf..5eeefa1 100644
--- a/Http/Authentication/AuthenticationFailureHandlerInterface.php
+++ b/Http/Authentication/AuthenticationFailureHandlerInterface.php
@@ -5,7 +5,28 @@ namespace Symfony\Component\Security\Http\Authentication;
use Symfony\Component\EventDispatcher\EventInterface;
use Symfony\Component\HttpFoundation\Request;
+/**
+ * Interface for custom authentication failure handlers.
+ *
+ * If you want to customize the failure handling process, instead of
+ * overwriting the respective listener globally, you can set a custom failure
+ * handler which implements this interface.
+ *
+ * @author Johannes M. Schmitt <schmittjoh@gmail.com>
+ */
interface AuthenticationFailureHandlerInterface
{
+ /**
+ * This is called when an interactive authentication attempt fails. This is
+ * called by authentication listeners inheriting from
+ * AbstractAuthenticationListener.
+ *
+ * @param EventInterface $event the "core.security" event, this event always
+ * has the kernel as target
+ * @param Request $request
+ * @param \Exception $exception
+ *
+ * @return Response the response to return
+ */
function onAuthenticationFailure(EventInterface $event, Request $request, \Exception $exception);
} \ No newline at end of file
diff --git a/Http/Authentication/AuthenticationSuccessHandlerInterface.php b/Http/Authentication/AuthenticationSuccessHandlerInterface.php
index 6efa309..235eb94 100644
--- a/Http/Authentication/AuthenticationSuccessHandlerInterface.php
+++ b/Http/Authentication/AuthenticationSuccessHandlerInterface.php
@@ -6,7 +6,28 @@ use Symfony\Component\EventDispatcher\EventInterface;
use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
use Symfony\Component\HttpFoundation\Request;
+/**
+ * Interface for a custom authentication success handler
+ *
+ * If you want to customize the success handling process, instead of
+ * overwriting the respective listener globally, you can set a custom success
+ * handler which implements this interface.
+ *
+ * @author Johannes M. Schmitt <schmittjoh@gmail.com>
+ */
interface AuthenticationSuccessHandlerInterface
{
+ /**
+ * This is called when an interactive authentication attempt succeeds. This
+ * is called by authentication listeners inheriting from
+ * AbstractAuthenticationListener.
+ *
+ * @param EventInterface $event the "core.security" event, this event always
+ * has the kernel as target
+ * @param Request $request
+ * @param TokenInterface $token
+ *
+ * @return Response the response to return
+ */
function onAuthenticationSuccess(EventInterface $event, Request $request, TokenInterface $token);
} \ No newline at end of file