xref: /webtrees/app/NoReplyUser.php (revision b11cdcd45131b1585d66693fab363cfeb18c51a4)
1<?php
2
3/**
4 * webtrees: online genealogy
5 * 'Copyright (C) 2023 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 <https://www.gnu.org/licenses/>.
16 */
17
18declare(strict_types=1);
19
20namespace Fisharebest\Webtrees;
21
22use Fisharebest\Webtrees\Contracts\UserInterface;
23
24/**
25 * A fake user that cannot receive email.
26 */
27class NoReplyUser implements UserInterface
28{
29    /**
30     * The user‘s internal identifier.
31     *
32     * @return int
33     */
34    public function id(): int
35    {
36        return 0;
37    }
38
39    /**
40     * The users email address.
41     *
42     * @return string
43     */
44    public function email(): string
45    {
46        $domain = Site::getPreference('SMTP_HELO') ?: 'localhost';
47
48        return 'no-reply@' . $domain;
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 void
87     */
88    public function setPreference(string $setting_name, string $setting_value): void
89    {
90    }
91}
92