summaryrefslogtreecommitdiffstats
path: root/Http/Logout/LogoutHandlerInterface.php
diff options
context:
space:
mode:
Diffstat (limited to 'Http/Logout/LogoutHandlerInterface.php')
-rw-r--r--Http/Logout/LogoutHandlerInterface.php36
1 files changed, 36 insertions, 0 deletions
diff --git a/Http/Logout/LogoutHandlerInterface.php b/Http/Logout/LogoutHandlerInterface.php
new file mode 100644
index 0000000..86859f9
--- /dev/null
+++ b/Http/Logout/LogoutHandlerInterface.php
@@ -0,0 +1,36 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien.potencier@symfony-project.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Security\Http\Logout;
+
+use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpFoundation\Request;
+
+/**
+ * Interface that needs to be implemented by LogoutHandlers.
+ *
+ * @author Johannes M. Schmitt <schmittjoh@gmail.com>
+ */
+interface LogoutHandlerInterface
+{
+ /**
+ * This method is called by the LogoutListener when a user has requested
+ * to be logged out. Usually, you would unset session variables, or remove
+ * cookies, etc.
+ *
+ * @param Request $request
+ * @param Response $response
+ * @param TokenInterface $token
+ * @return void
+ */
+ function logout(Request $request, Response $response, TokenInterface $token);
+} \ No newline at end of file