xref: /webtrees/app/Contracts/UserInterface.php (revision ad7270802ba57a28d195fc58fcc55f26458a779a) 
1<?php
2/**
3 * webtrees: online genealogy
4 * Copyright (C) 2019 webtrees development team
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16declare(strict_types=1);
17
18namespace Fisharebest\Webtrees\Contracts;
19
20/**
21 * Behaviour required of a user object.
22 */
23interface UserInterface
24{
25    /**
26     * The user‘s internal identifier
27     *
28     * @return int
29     */
30    public function id(): int;
31
32    /**
33     * The users email address.
34     *
35     * @return string
36     */
37    public function email(): string;
38
39    /**
40     * The user‘s real name.
41     *
42     * @return string
43     */
44    public function realName(): string;
45
46    /**
47     * The user‘s login name.
48     *
49     * @return string
50     */
51    public function userName(): string;
52
53    /**
54     * @param string $setting_name
55     * @param string $default
56     *
57     * @return string
58     */
59    public function getPreference(string $setting_name, string $default = ''): string;
60
61    /**
62     * @param string $setting_name
63     * @param string $setting_value
64     *
65     * @return UserInterface
66     */
67    public function setPreference(string $setting_name, string $setting_value): UserInterface;
68}
69