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