xref: /webtrees/app/TreeUser.php (revision 3d0d3c4eac0d9885ecf85cce0ac6e76860c614d4) 
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 * A tree can act as a user, for example to send email.
24 */
25class TreeUser implements UserInterface
26{
27    /**
28     * @var Tree
29     */
30    private $tree;
31
32    /**
33     * TreeUser constructor.
34     *
35     * @param Tree $tree
36     */
37    public function __construct(Tree $tree)
38    {
39        $this->tree = $tree;
40    }
41
42    /**
43     * The user‘s internal identifier.
44     *
45     * @return int
46     */
47    public function id(): int
48    {
49        return 0;
50    }
51
52    /**
53     * The users email address.
54     *
55     * @return string
56     */
57    public function email(): string
58    {
59        return $this->tree->getPreference('WEBTREES_EMAIL', 'no-reply@example.com');
60    }
61
62    /**
63     * The user‘s real name.
64     *
65     * @return string
66     */
67    public function realName(): string
68    {
69        return $this->tree->title();
70    }
71
72    /**
73     * The user‘s login name.
74     *
75     * @return string
76     */
77    public function userName(): string
78    {
79        return '';
80    }
81
82    /**
83     * @param string $setting_name
84     * @param string $default
85     *
86     * @return string
87     */
88    public function getPreference(string $setting_name, string $default = ''): string
89    {
90        return $default;
91    }
92
93    /**
94     * @param string $setting_name
95     * @param string $setting_value
96     *
97     * @return UserInterface
98     */
99    public function setPreference(string $setting_name, string $setting_value): UserInterface
100    {
101        return $this;
102    }
103}
104