xref: /webtrees/app/TreeUser.php (revision df27497a949ee94233b78915e33f253447a14e62) 
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 */
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            return '';
67        }
68
69        $contact = $user_service->find($contact_id);
70
71        if ($contact instanceof User) {
72            return $contact->email();
73        }
74
75        return '';
76    }
77
78    /**
79     * @param string $setting_name
80     * @param string $default
81     *
82     * @return string
83     */
84    public function getPreference(string $setting_name, string $default = ''): string
85    {
86        return $default;
87    }
88
89    /**
90     * The user‘s real name.
91     *
92     * @return string
93     */
94    public function realName(): string
95    {
96        return $this->tree->title();
97    }
98
99    /**
100     * The user‘s login name.
101     *
102     * @return string
103     */
104    public function userName(): string
105    {
106        return '';
107    }
108
109    /**
110     * @param string $setting_name
111     * @param string $setting_value
112     *
113     * @return UserInterface
114     */
115    public function setPreference(string $setting_name, string $setting_value): UserInterface
116    {
117        return $this;
118    }
119}
120