summaryrefslogtreecommitdiffstats
path: root/Guard/Token/PostAuthenticationGuardToken.php
diff options
context:
space:
mode:
Diffstat (limited to 'Guard/Token/PostAuthenticationGuardToken.php')
-rw-r--r--Guard/Token/PostAuthenticationGuardToken.php90
1 files changed, 90 insertions, 0 deletions
diff --git a/Guard/Token/PostAuthenticationGuardToken.php b/Guard/Token/PostAuthenticationGuardToken.php
new file mode 100644
index 0000000..36c40ca
--- /dev/null
+++ b/Guard/Token/PostAuthenticationGuardToken.php
@@ -0,0 +1,90 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Security\Guard\Token;
+
+use Symfony\Component\Security\Core\Authentication\Token\AbstractToken;
+use Symfony\Component\Security\Core\Role\RoleInterface;
+use Symfony\Component\Security\Core\User\UserInterface;
+
+/**
+ * Used as an "authenticated" token, though it could be set to not-authenticated later.
+ *
+ * If you're using Guard authentication, you *must* use a class that implements
+ * GuardTokenInterface as your authenticated token (like this class).
+ *
+ * @author Ryan Weaver <ryan@knpuniversity.com>n@gmail.com>
+ */
+class PostAuthenticationGuardToken extends AbstractToken implements GuardTokenInterface
+{
+ private $providerKey;
+
+ /**
+ * @param UserInterface $user The user!
+ * @param string $providerKey The provider (firewall) key
+ * @param RoleInterface[]|string[] $roles An array of roles
+ *
+ * @throws \InvalidArgumentException
+ */
+ public function __construct(UserInterface $user, $providerKey, array $roles)
+ {
+ parent::__construct($roles);
+
+ if (empty($providerKey)) {
+ throw new \InvalidArgumentException('$providerKey (i.e. firewall key) must not be empty.');
+ }
+
+ $this->setUser($user);
+ $this->providerKey = $providerKey;
+
+ // this token is meant to be used after authentication success, so it is always authenticated
+ // you could set it as non authenticated later if you need to
+ parent::setAuthenticated(true);
+ }
+
+ /**
+ * This is meant to be only an authenticated token, where credentials
+ * have already been used and are thus cleared.
+ *
+ * {@inheritdoc}
+ */
+ public function getCredentials()
+ {
+ return array();
+ }
+
+ /**
+ * Returns the provider (firewall) key.
+ *
+ * @return string
+ */
+ public function getProviderKey()
+ {
+ return $this->providerKey;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function serialize()
+ {
+ return serialize(array($this->providerKey, parent::serialize()));
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function unserialize($serialized)
+ {
+ list($this->providerKey, $parentStr) = unserialize($serialized);
+ parent::unserialize($parentStr);
+ }
+}