Classes List

Symfony\Component\Security\Guard\Token\PostAuthenticationGuardToken

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
 55 
 56 
 57 
 58 
 59 
 60 
 61 
 62 
 63 
 64 
 65 
 66 
 67 
 68 
 69 
 70 
 71 
 72 
 73 
 74 
 75 
 76 
 77 
 78 
 79 
 80 
 81 
 82 
 83 
 84 
 85 
 86 
 87 
 88 
 89 
 90 
 91 
<?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\Role;
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> */
class PostAuthenticationGuardToken extends AbstractToken implements GuardTokenInterface
{
    private $providerKey;

    /** * @param UserInterface $user The user! * @param string $providerKey The provider (firewall) key * @param (Role|string)[] $roles An array of roles * * @throws \InvalidArgumentException */
    public function __construct(UserInterface $user$providerKeyarray $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->providerKeyparent::serialize()));
    }

    /** * {@inheritdoc} */
    public function unserialize($serialized)
    {
        list($this->providerKey$parentStr) = unserialize($serialized);
        parent::unserialize($parentStr);
    }
}