Classes List

Symfony\Component\Security\Core\Authentication\Token\TokenInterface

 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 
 92 
 93 
 94 
 95 
 96 
 97 
 98 
 99 
 100 
 101 
 102 
 103 
 104 
 105 
 106 
 107 
 108 
 109 
 110 
 111 
 112 
 113 
 114 
 115 
 116 
 117 
 118 
 119 
 120 
 121 
 122 
 123 
 124 
 125 
 126 
 127 
 128 
 129 
 130 
 131 
 132 
<?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\Core\Authentication\Token;

use Symfony\Component\Security\Core\Role\RoleInterface;

/** * TokenInterface is the interface for the user authentication information. * * @author Fabien Potencier <fabien@symfony.com> * @author Johannes M. Schmitt <schmittjoh@gmail.com> */
interface TokenInterface extends \Serializable
{
    /** * Returns a string representation of the Token. * * This is only to be used for debugging purposes. * * @return string */
    public function __toString();

    /** * Returns the user roles. * * @return RoleInterface[] An array of RoleInterface instances */
    public function getRoles();

    /** * Returns the user credentials. * * @return mixed The user credentials */
    public function getCredentials();

    /** * Returns a user representation. * * @return mixed Can be a UserInterface instance, an object implementing a __toString method, * or the username as a regular string * * @see AbstractToken::setUser() */
    public function getUser();

    /** * Sets a user. * * @param mixed $user */
    public function setUser($user);

    /** * Returns the username. * * @return string */
    public function getUsername();

    /** * Returns whether the user is authenticated or not. * * @return bool true if the token has been authenticated, false otherwise */
    public function isAuthenticated();

    /** * Sets the authenticated flag. * * @param bool $isAuthenticated The authenticated flag */
    public function setAuthenticated($isAuthenticated);

    /** * Removes sensitive information from the token. */
    public function eraseCredentials();

    /** * Returns the token attributes. * * @return array The token attributes */
    public function getAttributes();

    /** * Sets the token attributes. * * @param array $attributes The token attributes */
    public function setAttributes(array $attributes);

    /** * Returns true if the attribute exists. * * @param string $name The attribute name * * @return bool true if the attribute exists, false otherwise */
    public function hasAttribute($name);

    /** * Returns an attribute value. * * @param string $name The attribute name * * @return mixed The attribute value * * @throws \InvalidArgumentException When attribute doesn't exist for this token */
    public function getAttribute($name);

    /** * Sets an attribute. * * @param string $name The attribute name * @param mixed $value The attribute value */
    public function setAttribute($name$value);
}