xref: /webtrees/app/Contracts/UserInterface.php (revision 66ce3d2365f7eb099897303ad7dc49a8459ceb55) 
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 */
17
18declare(strict_types=1);
19
20namespace Fisharebest\Webtrees\Contracts;
21
22/**
23 * Behaviour required of a user object.
24 */
25interface UserInterface
26{
27    /**
28     * The user‘s internal identifier
29     *
30     * @return int
31     */
32    public function id(): int;
33
34    /**
35     * The users email address.
36     *
37     * @return string
38     */
39    public function email(): string;
40
41    /**
42     * The user‘s real name.
43     *
44     * @return string
45     */
46    public function realName(): string;
47
48    /**
49     * The user‘s login name.
50     *
51     * @return string
52     */
53    public function userName(): string;
54
55    /**
56     * @param string $setting_name
57     * @param string $default
58     *
59     * @return string
60     */
61    public function getPreference(string $setting_name, string $default = ''): string;
62
63    /**
64     * @param string $setting_name
65     * @param string $setting_value
66     *
67     * @return UserInterface
68     */
69    public function setPreference(string $setting_name, string $setting_value): UserInterface;
70}
71