blob: cce35cc1c7ceffc2a6ddf1f8b195063c2304d4ab (
plain)
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
133
134
135
136
137
138
139
140
141
142
143
144
|
<?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\Core\Authentication\Token;
use Symfony\Component\Security\Core\User\AccountInterface;
/**
* TokenInterface is the interface for the user authentication information.
*
* @author Fabien Potencier <fabien.potencier@symfony-project.com>
*/
interface TokenInterface extends \Serializable
{
/**
* Returns a string representation of the token.
*
* @return string A string representation
*/
function __toString();
/**
* Returns the user roles.
*
* @return Role[] An array of Role instances.
*/
function getRoles();
/**
* Sets the user's roles
*
* @param array $roles
* @return void
*/
function setRoles(array $roles);
/**
* Returns the user credentials.
*
* @return mixed The user credentials
*/
function getCredentials();
/**
* Returns a user representation.
*
* @return mixed either returns an object which implements __toString(), or
* a primitive string is returned.
*/
function getUser();
/**
* Sets the user.
*
* @param mixed $user can either be an object which implements __toString(), or
* only a primitive string
*/
function setUser($user);
/**
* Checks if the user is authenticated or not.
*
* @return Boolean true if the token has been authenticated, false otherwise
*/
function isAuthenticated();
/**
* Sets the authenticated flag.
*
* @param Boolean $isAuthenticated The authenticated flag
*/
function setAuthenticated($isAuthenticated);
/**
* Whether this token is considered immutable
*
* @return Boolean
*/
function isImmutable();
/**
* Marks this token as immutable. This change cannot be reversed.
*
* You'll need to create a new token if you want a mutable token again.
*
* @return void
*/
function setImmutable();
/**
* Removes sensitive information from the token.
*/
function eraseCredentials();
/**
* Returns the token attributes.
*
* @return array The token attributes
*/
function getAttributes();
/**
* Sets the token attributes.
*
* @param array $attributes The token attributes
*/
function setAttributes(array $attributes);
/**
* Returns true if the attribute exists.
*
* @param string $name The attribute name
*
* @return Boolean true if the attribute exists, false otherwise
*/
function hasAttribute($name);
/**
* Returns a attribute value.
*
* @param string $name The attribute name
*
* @return mixed The attribute value
*
* @throws \InvalidArgumentException When attribute doesn't exist for this token
*/
function getAttribute($name);
/**
* Sets a attribute.
*
* @param string $name The attribute name
* @param mixed $value The attribute value
*/
function setAttribute($name, $value);
}
|
