summaryrefslogtreecommitdiffstats
path: root/Http/Logout/CookieClearingLogoutHandler.php
diff options
context:
space:
mode:
Diffstat (limited to 'Http/Logout/CookieClearingLogoutHandler.php')
-rw-r--r--Http/Logout/CookieClearingLogoutHandler.php59
1 files changed, 59 insertions, 0 deletions
diff --git a/Http/Logout/CookieClearingLogoutHandler.php b/Http/Logout/CookieClearingLogoutHandler.php
new file mode 100644
index 0000000..ea6bff3
--- /dev/null
+++ b/Http/Logout/CookieClearingLogoutHandler.php
@@ -0,0 +1,59 @@
+<?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;
+
+/**
+ * This handler cleares the passed cookies when a user logs out.
+ *
+ * @author Johannes M. Schmitt <schmittjoh@gmail.com>
+ */
+class CookieClearingLogoutHandler implements LogoutHandlerInterface
+{
+ protected $cookieNames;
+
+ /**
+ * Constructor
+ * @param array $cookieNames An array of cookie names to unset
+ */
+ public function __construct(array $cookieNames)
+ {
+ $this->cookieNames = $cookieNames;
+ }
+
+ /**
+ * Returns the names of the cookies to unset
+ * @return array
+ */
+ public function getCookieNames()
+ {
+ return $this->cookieNames;
+ }
+
+ /**
+ * Implementation for the LogoutHandlerInterface. Deletes all requested cookies.
+ *
+ * @param Request $request
+ * @param Response $response
+ * @param TokenInterface $token
+ * @return void
+ */
+ public function logout(Request $request, Response $response, TokenInterface $token)
+ {
+ foreach ($this->cookieNames as $cookieName) {
+ $response->headers->clearCookie($cookieName);
+ }
+ }
+}