-
Notifications
You must be signed in to change notification settings - Fork 443
/
PKPUser.inc.php
405 lines (351 loc) · 8.49 KB
/
PKPUser.inc.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
<?php
/**
* @defgroup user User
* Implements data objects and DAOs concerned with managing user accounts.
*/
/**
* @file classes/user/PKPUser.inc.php
*
* Copyright (c) 2014-2019 Simon Fraser University
* Copyright (c) 2000-2019 John Willinsky
* Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
*
* @class PKPUser
* @ingroup user
* @see UserDAO
*
* @brief Basic class describing users existing in the system.
*/
import('lib.pkp.classes.identity.Identity');
class PKPUser extends Identity {
/** @var array Roles assigned to this user grouped by context */
protected $_roles = array();
//
// Get/set methods
//
/**
* Get username.
* @return string
*/
function getUsername() {
return $this->getData('username');
}
/**
* Set username.
* @param $username string
*/
function setUsername($username) {
$this->setData('username', $username);
}
/**
* Get implicit auth ID string.
* @return String
*/
function getAuthStr() {
return $this->getData('authStr');
}
/**
* Set Shib ID string for this user.
* @param $authStr string
*/
function setAuthStr($authStr) {
$this->setData('authStr', $authStr);
}
/**
* Get localized user signature.
*/
function getLocalizedSignature() {
return $this->getLocalizedData('signature');
}
/**
* Get email signature.
* @param $locale string
* @return string
*/
function getSignature($locale) {
return $this->getData('signature', $locale);
}
/**
* Set signature.
* @param $signature string
* @param $locale string
*/
function setSignature($signature, $locale) {
$this->setData('signature', $signature, $locale);
}
/**
* Get password (encrypted).
* @return string
*/
function getPassword() {
return $this->getData('password');
}
/**
* Set password (assumed to be already encrypted).
* @param $password string
*/
function setPassword($password) {
$this->setData('password', $password);
}
/**
* Get phone number.
* @return string
*/
function getPhone() {
return $this->getData('phone');
}
/**
* Set phone number.
* @param $phone string
*/
function setPhone($phone) {
$this->setData('phone', $phone);
}
/**
* Get mailing address.
* @return string
*/
function getMailingAddress() {
return $this->getData('mailingAddress');
}
/**
* Set mailing address.
* @param $mailingAddress string
*/
function setMailingAddress($mailingAddress) {
$this->setData('mailingAddress', $mailingAddress);
}
/**
* Get billing address.
* @return string
*/
function getBillingAddress() {
return $this->getData('billingAddress');
}
/**
* Set billing address.
* @param $billingAddress string
*/
function setBillingAddress($billingAddress) {
$this->setData('billingAddress', $billingAddress);
}
/**
* Get the user's interests displayed as a comma-separated string
* @return string
*/
function getInterestString() {
import('lib.pkp.classes.user.InterestManager');
$interestManager = new InterestManager();
return $interestManager->getInterestsString($this);
}
/**
* Get user gossip.
* @return string
*/
function getGossip() {
return $this->getData('gossip');
}
/**
* Set user gossip.
* @param $gossip string
*/
function setGossip($gossip) {
$this->setData('gossip', $gossip);
}
/**
* Get user's working languages.
* @return array
*/
function getLocales() {
$locales = $this->getData('locales');
return isset($locales) ? $locales : array();
}
/**
* Set user's working languages.
* @param $locales array
*/
function setLocales($locales) {
$this->setData('locales', $locales);
}
/**
* Get date user last sent an email.
* @return datestamp (YYYY-MM-DD HH:MM:SS)
*/
function getDateLastEmail() {
return $this->getData('dateLastEmail');
}
/**
* Set date user last sent an email.
* @param $dateLastEmail datestamp (YYYY-MM-DD HH:MM:SS)
*/
function setDateLastEmail($dateLastEmail) {
$this->setData('dateLastEmail', $dateLastEmail);
}
/**
* Get date user registered with the site.
* @return datestamp (YYYY-MM-DD HH:MM:SS)
*/
function getDateRegistered() {
return $this->getData('dateRegistered');
}
/**
* Set date user registered with the site.
* @param $dateRegistered datestamp (YYYY-MM-DD HH:MM:SS)
*/
function setDateRegistered($dateRegistered) {
$this->setData('dateRegistered', $dateRegistered);
}
/**
* Get date user email was validated with the site.
* @return datestamp (YYYY-MM-DD HH:MM:SS)
*/
function getDateValidated() {
return $this->getData('dateValidated');
}
/**
* Set date user email was validated with the site.
* @param $dateValidated datestamp (YYYY-MM-DD HH:MM:SS)
*/
function setDateValidated($dateValidated) {
$this->setData('dateValidated', $dateValidated);
}
/**
* Get date user last logged in to the site.
* @return datestamp
*/
function getDateLastLogin() {
return $this->getData('dateLastLogin');
}
/**
* Set date user last logged in to the site.
* @param $dateLastLogin datestamp
*/
function setDateLastLogin($dateLastLogin) {
$this->setData('dateLastLogin', $dateLastLogin);
}
/**
* Check if user must change their password on their next login.
* @return boolean
*/
function getMustChangePassword() {
return $this->getData('mustChangePassword');
}
/**
* Set whether or not user must change their password on their next login.
* @param $mustChangePassword boolean
*/
function setMustChangePassword($mustChangePassword) {
$this->setData('mustChangePassword', $mustChangePassword);
}
/**
* Check if user is disabled.
* @return boolean
*/
function getDisabled() {
return $this->getData('disabled');
}
/**
* Set whether or not user is disabled.
* @param $disabled boolean
*/
function setDisabled($disabled) {
$this->setData('disabled', $disabled);
}
/**
* Get the reason the user was disabled.
* @return string
*/
function getDisabledReason() {
return $this->getData('disabled_reason');
}
/**
* Set the reason the user is disabled.
* @param $reasonDisabled string
*/
function setDisabledReason($reasonDisabled) {
$this->setData('disabled_reason', $reasonDisabled);
}
/**
* Get ID of authentication source for this user.
* @return int
*/
function getAuthId() {
return $this->getData('authId');
}
/**
* Set ID of authentication source for this user.
* @param $authId int
*/
function setAuthId($authId) {
$this->setData('authId', $authId);
}
/**
* Get the inline help display status for this user.
* @return int
*/
function getInlineHelp() {
return $this->getData('inlineHelp');
}
/**
* Set the inline help display status for this user.
* @param $inlineHelp int
*/
function setInlineHelp($inlineHelp) {
$this->setData('inlineHelp', $inlineHelp);
}
function getContactSignature() {
$signature = htmlspecialchars($this->getFullName());
AppLocale::requireComponents(LOCALE_COMPONENT_PKP_USER);
if ($a = $this->getLocalizedAffiliation()) $signature .= '<br/>' . htmlspecialchars($a);
if ($p = $this->getPhone()) $signature .= '<br/>' . __('user.phone') . ' ' . htmlspecialchars($p);
$signature .= '<br/>' . htmlspecialchars($this->getEmail());
return $signature;
}
/**
* Check if this user has a role in a context
*
* @param int|array $roles Role(s) to check for
* @param int $contextId The context to check for roles in.
* @return bool
*/
public function hasRole($roles, $contextId) {
$contextRoles = $this->getRoles($contextId);
if (empty($contextRoles)) {
return false;
}
if (!is_array($roles)) {
$roles = array($roles);
}
foreach($contextRoles as $contextRole) {
if (in_array((int) $contextRole->getId(), $roles)) {
return true;
}
}
return false;
}
/**
* Get this user's roles in a context
*
* @param int $contextId The context to retrieve roles in.
* @param bool $noCache Force the roles to be retrieved from the database
* @return array
*/
public function getRoles($contextId, $noCache = false) {
if ($noCache || empty($this->_roles[$contextId])) {
import('lib.pkp.classes.security.RoleDAO');
$userRolesDao = DAORegistry::getDAO('RoleDAO');
$this->setRoles($userRolesDao->getByUserId($this->getId(), $contextId), $contextId);
}
return isset($this->_roles[$contextId]) ? $this->_roles[$contextId] : array();
}
/**
* Set this user's roles in a context
*
* @param array $roles The roles to assign this user
* @param int $contextId The context to assign these roles
*/
public function setRoles($roles, $contextId) {
$this->_roles[$contextId] = $roles;
}
}
?>