blob: bb69884c886ce36939d7be82c028cd4f14cf6d3e (
plain) (
blame)
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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
|
<?php
namespace Drupal\user;
use Drupal\Core\Entity\EntityChangedInterface;
use Drupal\Core\Entity\ContentEntityInterface;
use Drupal\Core\Session\AccountInterface;
/**
* Provides an interface defining a user entity.
*
* @ingroup user_api
*/
interface UserInterface extends ContentEntityInterface, EntityChangedInterface, AccountInterface {
/**
* Maximum length of username text field.
*
* Keep this under 191 characters so we can use a unique constraint in MySQL.
*/
const USERNAME_MAX_LENGTH = 60;
/**
* Only administrators can create user accounts.
*/
const REGISTER_ADMINISTRATORS_ONLY = 'admin_only';
/**
* Visitors can create their own accounts.
*/
const REGISTER_VISITORS = 'visitors';
/**
* Visitors can create accounts that only become active with admin approval.
*/
const REGISTER_VISITORS_ADMINISTRATIVE_APPROVAL = 'visitors_admin_approval';
/**
* New users will be set to the default time zone at registration.
*/
const TIMEZONE_DEFAULT = 0;
/**
* New users will get an empty time zone at registration.
*/
const TIMEZONE_EMPTY = 1;
/**
* New users will select their own timezone at registration.
*/
const TIMEZONE_SELECT = 2;
/**
* Whether a user has a certain role.
*
* @param string $rid
* The role ID to check.
*
* @return bool
* Returns TRUE if the user has the role, otherwise FALSE.
*
* @todo in Drupal 11, move method to Drupal\Core\Session\AccountInterface.
* @see https://www.drupal.org/node/3228209
*/
public function hasRole($rid);
/**
* Add a role to a user.
*
* @param string $rid
* The role ID to add.
*
* @return $this
*/
public function addRole($rid);
/**
* Remove a role from a user.
*
* @param string $rid
* The role ID to remove.
*
* @return $this
*/
public function removeRole($rid);
/**
* Sets the username of this account.
*
* @param string $username
* The new user name.
*
* @return $this
* The called user entity.
*/
public function setUsername($username);
/**
* Returns the hashed password.
*
* @return string|null
* The hashed password, or NULL if a password is not set.
*/
public function getPassword();
/**
* Sets the user password.
*
* @param string $password
* The new un-hashed password.
*
* @return $this
* The called user entity.
*/
public function setPassword(#[\SensitiveParameter] $password);
/**
* Sets the email address of the user.
*
* @param string $mail
* The new email address of the user.
*
* @return $this
* The called user entity.
*/
public function setEmail($mail);
/**
* Returns the creation time of the user as a UNIX timestamp.
*
* @return int
* Timestamp of the creation date.
*/
public function getCreatedTime();
/**
* Sets the UNIX timestamp when the user last accessed the site..
*
* @param int $timestamp
* Timestamp of the last access.
*
* @return $this
* The called user entity.
*/
public function setLastAccessTime($timestamp);
/**
* Returns the UNIX timestamp when the user last logged in.
*
* @return int
* Timestamp of the last login time.
*/
public function getLastLoginTime();
/**
* Sets the UNIX timestamp when the user last logged in.
*
* @param int $timestamp
* Timestamp of the last login time.
*
* @return $this
* The called user entity.
*/
public function setLastLoginTime($timestamp);
/**
* Returns TRUE if the user is active.
*
* @return bool
* TRUE if the user is active, false otherwise.
*/
public function isActive();
/**
* Returns TRUE if the user is blocked.
*
* @return bool
* TRUE if the user is blocked, false otherwise.
*/
public function isBlocked();
/**
* Activates the user.
*
* @return $this
* The called user entity.
*/
public function activate();
/**
* Blocks the user.
*
* @return $this
* The called user entity.
*/
public function block();
/**
* Returns the email that was used when the user was registered.
*
* @return string
* Initial email address of the user.
*/
public function getInitialEmail();
/**
* Sets the existing plain text password.
*
* Required for validation when changing the password, name or email fields.
*
* @param string $password
* The existing plain text password of the user.
*
* @return $this
*/
public function setExistingPassword(#[\SensitiveParameter] $password);
/**
* Checks the existing password if set.
*
* @param \Drupal\user\UserInterface $account_unchanged
* The unchanged user entity to compare against.
*
* @return bool
* TRUE if the correct existing password was provided.
*
* @see UserInterface::setExistingPassword()
*/
public function checkExistingPassword(UserInterface $account_unchanged);
}
|
