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