xref: /webtrees/app/SiteUser.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;
20
21use Fisharebest\Webtrees\Contracts\UserInterface;
22
23/**
24 * The site can act as a user, for example to send email.
25 *
26 * Some SMTP servers insist that this is a real/validated email address.
27 * Others are happy to accept no-reply@localhost.
28 */
29class SiteUser implements UserInterface
30{
31    /**
32     * The user‘s internal identifier.
33     *
34     * @return int
35     */
36    public function id(): int
37    {
38        return 0;
39    }
40
41    /**
42     * The users email address.
43     *
44     * @return string
45     */
46    public function email(): string
47    {
48        return '';
49    }
50
51    /**
52     * The user‘s real name.
53     *
54     * @return string
55     */
56    public function realName(): string
57    {
58        return Webtrees::NAME;
59    }
60
61    /**
62     * The user‘s login name.
63     *
64     * @return string
65     */
66    public function userName(): string
67    {
68        return '';
69    }
70
71    /**
72     * @param string $setting_name
73     * @param string $default
74     *
75     * @return string
76     */
77    public function getPreference(string $setting_name, string $default = ''): string
78    {
79        return $default;
80    }
81
82    /**
83     * @param string $setting_name
84     * @param string $setting_value
85     *
86     * @return UserInterface
87     */
88    public function setPreference(string $setting_name, string $setting_value): UserInterface
89    {
90        return $this;
91    }
92}
93