summaryrefslogtreecommitdiffstats
path: root/Http/Logout/LogoutSuccessHandlerInterface.php
diff options
context:
space:
mode:
authorJohannes Schmitt <schmittjoh@gmail.com>2011-02-14 19:08:48 +0100
committerFabien Potencier <fabien.potencier@gmail.com>2011-02-14 20:55:07 +0100
commit213a312859e19e391e9f11a35369e3525c54a7d3 (patch)
treee4eb1a88f62a05aa17cf06ae7c3e6dc1fe053858 /Http/Logout/LogoutSuccessHandlerInterface.php
parentd3fb2712958c7221ffcc237cf820aa7a3184dd0c (diff)
downloadsymfony-security-213a312859e19e391e9f11a35369e3525c54a7d3.zip
symfony-security-213a312859e19e391e9f11a35369e3525c54a7d3.tar.gz
symfony-security-213a312859e19e391e9f11a35369e3525c54a7d3.tar.bz2
[Security] adds logout success handler
Diffstat (limited to 'Http/Logout/LogoutSuccessHandlerInterface.php')
-rw-r--r--Http/Logout/LogoutSuccessHandlerInterface.php29
1 files changed, 29 insertions, 0 deletions
diff --git a/Http/Logout/LogoutSuccessHandlerInterface.php b/Http/Logout/LogoutSuccessHandlerInterface.php
new file mode 100644
index 0000000..346784b
--- /dev/null
+++ b/Http/Logout/LogoutSuccessHandlerInterface.php
@@ -0,0 +1,29 @@
+<?php
+
+namespace Symfony\Component\Security\Http\Logout;
+
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\EventDispatcher\EventInterface;
+
+/**
+ * LogoutSuccesshandlerInterface.
+ *
+ * In contrast to the LogoutHandlerInterface, this interface can return a response
+ * which is then used instead of the default behavior.
+ *
+ * If you want to only perform some logout related clean-up task, use the
+ * LogoutHandlerInterface instead.
+ *
+ * @author Johannes M. Schmitt <schmittjoh@gmail.com>
+ */
+interface LogoutSuccessHandlerInterface
+{
+ /**
+ * Creates a Response object to send upon a successful logout.
+ *
+ * @param EventInterface $event
+ * @param Request $request
+ * @return Response never null
+ */
+ function onLogoutSuccess(EventInterface $event, Request $request);
+} \ No newline at end of file