/
BackendUser.php
407 lines (359 loc) · 9.24 KB
/
BackendUser.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
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
<?php
/*
* This file is part of the TYPO3 CMS project.
*
* It is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License, either version 2
* of the License, or any later version.
*
* For the full copyright and license information, please read the
* LICENSE.txt file that was distributed with this source code.
*
* The TYPO3 project - inspiring people to share!
*/
namespace Fixpunkt\Backendtools\Domain\Model;
use TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Extbase\Annotation as Extbase;
use TYPO3\CMS\Extbase\DomainObject\AbstractEntity;
use TYPO3\CMS\Extbase\Persistence\ObjectStorage;
/**
* Model for backend user
* @internal This class is a TYPO3 Backend implementation and is not considered part of the Public TYPO3 API.
*/
class BackendUser extends AbstractEntity
{
/**
* @var string
*/
#[Extbase\Validate(['validator' => 'NotEmpty'])]
protected $userName = '';
/**
* @var ObjectStorage<BackendUserGroup>
*/
protected $backendUserGroups;
/**
* Comma separated list of uids in multi-select
* Might retrieve the labels from TCA/DataMapper
*
* @var string
*/
protected $allowedLanguages = '';
/**
* @var string
*/
protected $dbMountPoints = '';
/**
* @var string
*/
protected $description = '';
/**
* @var string
*/
protected $fileMountPoints = '';
/**
* @var bool
*/
protected $isAdministrator = false;
/**
* @var bool
*/
protected $isDisabled = false;
/**
* @var \DateTime|null
*/
protected $startDateAndTime;
/**
* @var \DateTime|null
*/
protected $endDateAndTime;
/**
* @var string
*/
protected $email = '';
/**
* @var string
*/
protected $realName = '';
/**
* @var \DateTime|null
*/
protected $lastLoginDateAndTime;
/**
* @param string $allowedLanguages
*/
public function setAllowedLanguages($allowedLanguages)
{
$this->allowedLanguages = $allowedLanguages;
}
/**
* @return string
*/
public function getAllowedLanguages()
{
return $this->allowedLanguages;
}
/**
* @param string $dbMountPoints
*/
public function setDbMountPoints($dbMountPoints)
{
$this->dbMountPoints = $dbMountPoints;
}
/**
* @return string
*/
public function getDbMountPoints()
{
return $this->dbMountPoints;
}
/**
* @param string $fileMountPoints
*/
public function setFileMountPoints($fileMountPoints)
{
$this->fileMountPoints = $fileMountPoints;
}
/**
* @return string
*/
public function getFileMountPoints()
{
return $this->fileMountPoints;
}
/**
* Check if user is active, not disabled
*
* @return bool
*/
public function isActive()
{
if ($this->getIsDisabled()) {
return false;
}
$now = new \DateTime('now');
return !$this->getStartDateAndTime() && !$this->getEndDateAndTime() || $this->getStartDateAndTime() <= $now && (!$this->getEndDateAndTime() || $this->getEndDateAndTime() > $now);
}
/**
* @param ObjectStorage<BackendUserGroup> $backendUserGroups
*/
public function setBackendUserGroups($backendUserGroups)
{
$this->backendUserGroups = $backendUserGroups;
}
/**
* @return ObjectStorage<BackendUserGroup>
*/
public function getBackendUserGroups()
{
return $this->backendUserGroups;
}
/**
* Check if user is currently logged in
*
* @return bool
*/
public function isCurrentlyLoggedIn()
{
return $this->getUid() === (int)($this->getBackendUser()->user['uid'] ?? 0);
}
/**
* Gets the user name.
*
* @return string the user name, will not be empty
*/
public function getUserName()
{
return $this->userName;
}
/**
* Sets the user name.
*
* @param string $userName the user name to set, must not be empty
*/
public function setUserName($userName)
{
$this->userName = $userName;
}
/**
* @return string
*/
public function getDescription()
{
return $this->description;
}
/**
* @param string $description
*/
public function setDescription($description)
{
$this->description = $description;
}
/**
* Checks whether this user is an administrator.
*
* @return bool whether this user is an administrator
*/
public function getIsAdministrator()
{
return $this->isAdministrator;
}
/**
* Sets whether this user should be an administrator.
*
* @param bool $isAdministrator whether this user should be an administrator
*/
public function setIsAdministrator($isAdministrator)
{
$this->isAdministrator = $isAdministrator;
}
/**
* Checks whether this user is disabled.
*
* @return bool whether this user is disabled
*/
public function getIsDisabled()
{
return $this->isDisabled;
}
/**
* Sets whether this user is disabled.
*
* @param bool $isDisabled whether this user is disabled
*/
public function setIsDisabled($isDisabled)
{
$this->isDisabled = $isDisabled;
}
/**
* Returns the point in time from which this user is enabled.
*
* @return \DateTime|null the start date and time
*/
public function getStartDateAndTime()
{
return $this->startDateAndTime;
}
/**
* Sets the point in time from which this user is enabled.
*
* @param \DateTime|null $dateAndTime the start date and time
*/
public function setStartDateAndTime(\DateTime $dateAndTime = null)
{
$this->startDateAndTime = $dateAndTime;
}
/**
* Returns the point in time before which this user is enabled.
*
* @return \DateTime|null the end date and time
*/
public function getEndDateAndTime()
{
return $this->endDateAndTime;
}
/**
* Sets the point in time before which this user is enabled.
*
* @param \DateTime|null $dateAndTime the end date and time
*/
public function setEndDateAndTime(\DateTime $dateAndTime = null)
{
$this->endDateAndTime = $dateAndTime;
}
/**
* Gets the e-mail address of this user.
*
* @return string the e-mail address, might be empty
*/
public function getEmail()
{
return $this->email;
}
/**
* Sets the e-mail address of this user.
*
* @param string $email the e-mail address, may be empty
*/
public function setEmail($email)
{
$this->email = $email;
}
/**
* Returns this user's real name.
*
* @return string the real name. might be empty
*/
public function getRealName()
{
return $this->realName;
}
/**
* Sets this user's real name.
*
* @param string $name the user's real name, may be empty.
*/
public function setRealName($name)
{
$this->realName = $name;
}
/**
* Checks whether this user is currently activated.
*
* This function takes the "disabled" flag, the start date/time and the end date/time into account.
*
* @return bool whether this user is currently activated
*/
public function isActivated()
{
return !$this->getIsDisabled() && $this->isActivatedViaStartDateAndTime() && $this->isActivatedViaEndDateAndTime();
}
/**
* Checks whether this user is activated as far as the start date and time is concerned.
*
* @return bool whether this user is activated as far as the start date and time is concerned
*/
protected function isActivatedViaStartDateAndTime()
{
if ($this->getStartDateAndTime() === null) {
return true;
}
$now = new \DateTime('now');
return $this->getStartDateAndTime() <= $now;
}
/**
* Checks whether this user is activated as far as the end date and time is concerned.
*
* @return bool whether this user is activated as far as the end date and time is concerned
*/
protected function isActivatedViaEndDateAndTime()
{
if ($this->getEndDateAndTime() === null) {
return true;
}
$now = new \DateTime('now');
return $now <= $this->getEndDateAndTime();
}
/**
* Gets this user's last login date and time.
*
* @return \DateTime|null this user's last login date and time, will be NULL if this user has never logged in before
*/
public function getLastLoginDateAndTime()
{
return $this->lastLoginDateAndTime;
}
/**
* Sets this user's last login date and time.
*
* @param \DateTime|null $dateAndTime this user's last login date and time
*/
public function setLastLoginDateAndTime(\DateTime $dateAndTime = null)
{
$this->lastLoginDateAndTime = $dateAndTime;
}
public function getBackendUser(): BackendUserAuthentication
{
return $GLOBALS['BE_USER'];
}
}