xref: /webtrees/app/TreeUser.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;
23use Fisharebest\Webtrees\Services\UserService;
24
25use function assert;
26
27/**
28 * A tree can act as a user, for example to send email.
29 */
30class TreeUser implements UserInterface
31{
32    private Tree $tree;
33
34    /**
35     * TreeUser constructor.
36     *
37     * @param Tree $tree
38     */
39    public function __construct(Tree $tree)
40    {
41        $this->tree = $tree;
42    }
43
44    /**
45     * The user‘s internal identifier.
46     *
47     * @return int
48     */
49    public function id(): int
50    {
51        return 0;
52    }
53
54    /**
55     * The users email address.
56     *
57     * @return string
58     */
59    public function email(): string
60    {
61        $user_service = app(UserService::class);
62        assert($user_service instanceof UserService);
63
64        $contact_id   = (int) $this->getPreference('CONTACT_USER_ID');
65
66        if ($contact_id !== 0) {
67            $contact = $user_service->find($contact_id);
68
69            if ($contact instanceof User) {
70                return $contact->email();
71            }
72        }
73
74        return Site::getPreference('SMTP_FROM_NAME');
75    }
76
77    /**
78     * @param string $setting_name
79     * @param string $default
80     *
81     * @return string
82     */
83    public function getPreference(string $setting_name, string $default = ''): string
84    {
85        return $default;
86    }
87
88    /**
89     * The user‘s real name.
90     *
91     * @return string
92     */
93    public function realName(): string
94    {
95        return $this->tree->title();
96    }
97
98    /**
99     * The user‘s login name.
100     *
101     * @return string
102     */
103    public function userName(): string
104    {
105        return '';
106    }
107
108    /**
109     * @param string $setting_name
110     * @param string $setting_value
111     *
112     * @return void
113     */
114    public function setPreference(string $setting_name, string $setting_value): void
115    {
116    }
117}
118