/
TokenInterface.php
87 lines (71 loc) · 2.14 KB
/
TokenInterface.php
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
<?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\User\UserInterface;
/**
* TokenInterface is the interface for the user authentication information.
*
* @author Fabien Potencier <fabien@symfony.com>
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
interface TokenInterface
{
/**
* Returns a string representation of the Token.
*
* This is only to be used for debugging purposes.
*/
public function __toString(): string;
/**
* Returns the user identifier used during authentication (e.g. a user's email address or username).
*/
public function getUserIdentifier(): string;
/**
* Returns the user roles.
*
* @return string[]
*/
public function getRoleNames(): array;
/**
* Returns a user representation.
*
* @see AbstractToken::setUser()
*/
public function getUser(): ?UserInterface;
/**
* Sets the authenticated user in the token.
*
* @throws \InvalidArgumentException
*/
public function setUser(UserInterface $user);
/**
* Removes sensitive information from the token.
*/
public function eraseCredentials();
public function getAttributes(): array;
/**
* @param array $attributes The token attributes
*/
public function setAttributes(array $attributes);
public function hasAttribute(string $name): bool;
/**
* @throws \InvalidArgumentException When attribute doesn't exist for this token
*/
public function getAttribute(string $name): mixed;
public function setAttribute(string $name, mixed $value);
/**
* Returns all the necessary state of the object for serialization purposes.
*/
public function __serialize(): array;
/**
* Restores the object state from an array given by __serialize().
*/
public function __unserialize(array $data): void;
}