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