blob: 73a25c9c6d3e42459a0d272767cb05223d17c6e4 (
plain)
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
|
<?php
/**
* webtrees: online genealogy
* Copyright (C) 2026 webtrees development team
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace Fisharebest\Webtrees\Contracts;
/**
* behavior required of a user object.
*/
interface UserInterface
{
// For historic reasons, user preferences have inconsistent and confusing names.
public const string PREF_AUTO_ACCEPT_EDITS = 'auto_accept';
public const string PREF_CONTACT_METHOD = 'contactmethod';
public const string PREF_IS_ACCOUNT_APPROVED = 'verified_by_admin';
public const string PREF_IS_ADMINISTRATOR = 'canadmin';
public const string PREF_IS_EMAIL_VERIFIED = 'verified';
public const string PREF_IS_VISIBLE_ONLINE = 'visibleonline';
public const string PREF_LANGUAGE = 'language';
public const string PREF_NEW_ACCOUNT_COMMENT = 'comment';
public const string PREF_TIMESTAMP_REGISTERED = 'reg_timestamp';
public const string PREF_TIMESTAMP_ACTIVE = 'sessiontime';
public const string PREF_TIME_ZONE = 'TIMEZONE';
public const string PREF_THEME = 'theme';
public const string PREF_VERIFICATION_TOKEN = 'reg_hashcode';
// For historic reasons, user-tree preferences have inconsistent and confusing names.
public const string PREF_TREE_ACCOUNT_XREF = 'gedcomid';
public const string PREF_TREE_DEFAULT_XREF = 'rootid';
public const string PREF_TREE_PATH_LENGTH = 'RELATIONSHIP_PATH_LENGTH';
public const string PREF_TREE_ROLE = 'canedit';
// For historic reasons, roles have inconsistent and confusing names.
public const string ROLE_VISITOR = 'none';
public const string ROLE_MEMBER = 'access';
public const string ROLE_EDITOR = 'edit';
public const string ROLE_MODERATOR = 'accept';
public const string ROLE_MANAGER = 'admin';
/**
* The user‘s internal identifier
*
* @return int
*/
public function id(): int;
/**
* The users email address.
*
* @return string
*/
public function email(): string;
/**
* The user‘s real name.
*
* @return string
*/
public function realName(): string;
/**
* The user‘s login name.
*
* @return string
*/
public function userName(): string;
/**
* @param string $setting_name
* @param string $default
*
* @return string
*/
public function getPreference(string $setting_name, string $default = ''): string;
/**
* @param string $setting_name
* @param string $setting_value
*
* @return void
*/
public function setPreference(string $setting_name, string $setting_value): void;
}
|
