/
User.php
323 lines (256 loc) · 6.99 KB
/
User.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
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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
<?php
declare(strict_types=1);
/*
* This file is part of the NucleosUserBundle package.
*
* (c) Christian Gripp <mail@core23.de>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Nucleos\UserBundle\Model;
use DateTime;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Symfony\Component\Security\Core\User\UserInterface as BaseUserInterface;
/**
* @SuppressWarnings(PHPMD.TooManyPublicMethods)
*
* @phpstan-template GroupTemplate of GroupInterface
*
* @phpstan-implements GroupAwareUser<GroupTemplate>
*
* @SuppressWarnings(PHPMD.TooManyPublicMethods)
*/
abstract class User implements UserInterface, GroupAwareUser, LocaleAwareUser
{
protected ?string $username = null;
protected ?string $email = null;
protected bool $enabled = false;
protected ?string $password = null;
/**
* @deprecated
*/
protected ?string $plainPassword = null;
protected ?DateTime $lastLogin = null;
protected ?string $confirmationToken = null;
protected ?DateTime $passwordRequestedAt = null;
/**
* @phpstan-var Collection<array-key, GroupTemplate>
*/
protected Collection $groups;
/**
* @var string[]
*/
protected array $roles = [];
protected ?string $locale = null;
protected ?string $timezone = null;
public function __construct()
{
$this->groups = new ArrayCollection();
}
public function __toString(): string
{
return $this->getUsername();
}
public function addRole(string $role): void
{
$role = strtoupper($role);
if (!\in_array($role, $this->roles, true)) {
$this->roles[] = $role;
}
}
public function eraseCredentials(): void
{
$this->plainPassword = null;
}
public function getUsername(): string
{
return $this->username ?? '';
}
public function getUserIdentifier(): string
{
return $this->getUsername();
}
public function getEmail(): string
{
return $this->email ?? '';
}
public function getPassword(): string
{
return $this->password ?? '';
}
public function getPlainPassword(): ?string
{
return $this->plainPassword;
}
public function getLastLogin(): ?DateTime
{
return $this->lastLogin;
}
public function getConfirmationToken(): ?string
{
return $this->confirmationToken;
}
public function getRoles(): array
{
$roles = $this->roles;
foreach ($this->getGroups() as $group) {
$roles = array_merge($roles, $group->getRoles());
}
// we need to make sure to have at least one role
$roles[] = static::ROLE_DEFAULT;
return array_values(array_unique($roles));
}
public function hasRole(string $role): bool
{
return \in_array(strtoupper($role), $this->getRoles(), true);
}
public function isAccountNonExpired(): bool
{
return true;
}
public function isAccountNonLocked(): bool
{
return true;
}
public function isCredentialsNonExpired(): bool
{
return true;
}
public function isEnabled(): bool
{
return $this->enabled;
}
public function isSuperAdmin(): bool
{
return $this->hasRole(static::ROLE_SUPER_ADMIN);
}
public function removeRole(string $role): void
{
if (false !== $key = array_search(strtoupper($role), $this->roles, true)) {
unset($this->roles[$key]);
$this->roles = array_values($this->roles);
}
}
public function setUsername(string $username): void
{
$this->username = strtolower($username);
}
public function setEmail(string $email): void
{
$this->email = strtolower($email);
}
public function setEnabled(bool $boolean): void
{
$this->enabled = $boolean;
}
public function setPassword(string $password): void
{
$this->password = $password;
}
public function setSuperAdmin(bool $boolean): void
{
if ($boolean) {
$this->addRole(static::ROLE_SUPER_ADMIN);
} else {
$this->removeRole(static::ROLE_SUPER_ADMIN);
}
}
public function setPlainPassword(?string $password): void
{
$this->plainPassword = $password;
$this->passwordRequestedAt = null;
}
public function setLastLogin(DateTime $time = null): void
{
$this->lastLogin = $time;
}
public function setConfirmationToken(?string $confirmationToken): void
{
$this->confirmationToken = $confirmationToken;
}
public function setPasswordRequestedAt(DateTime $date = null): void
{
$this->passwordRequestedAt = $date;
}
public function getPasswordRequestedAt(): ?DateTime
{
return $this->passwordRequestedAt;
}
public function isPasswordRequestNonExpired(int $ttl): bool
{
return $this->getPasswordRequestedAt() instanceof DateTime
&& $this->getPasswordRequestedAt()->getTimestamp() + $ttl > time();
}
public function setRoles(array $roles): void
{
$this->roles = [];
foreach ($roles as $role) {
$this->addRole($role);
}
}
public function getGroups(): Collection
{
if (!isset($this->groups)) {
return new ArrayCollection();
}
return $this->groups;
}
public function getGroupNames(): array
{
$names = [];
foreach ($this->getGroups() as $group) {
$names[] = $group->getName();
}
return $names;
}
public function hasGroup(string $name): bool
{
return \in_array($name, $this->getGroupNames(), true);
}
public function addGroup(GroupInterface $group): void
{
if (!$this->getGroups()->contains($group)) {
$this->getGroups()->add($group);
}
}
public function removeGroup(GroupInterface $group): void
{
if ($this->getGroups()->contains($group)) {
$this->getGroups()->removeElement($group);
}
}
public function setLocale(?string $locale): void
{
$this->locale = $locale;
}
public function getLocale(): ?string
{
return $this->locale;
}
public function setTimezone(?string $timezone): void
{
$this->timezone = $timezone;
}
public function getTimezone(): ?string
{
return $this->timezone;
}
/**
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
*/
public function isEqualTo(BaseUserInterface $user): bool
{
if (!$user instanceof self) {
return false;
}
if ($this->password !== $user->getPassword()) {
return false;
}
if ($this->username !== $user->getUsername()) {
return false;
}
return true;
}
}