xref: /webtrees/app/TreeUser.php (revision e5a6b4d4f6f6e7ff2fba7ae2cf27546ae68a79cc) 
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
40        $this->tree = $tree;
41    }
42
43    /**
44     * The user‘s internal identifier.
45     *
46     * @return int
47     */
48    public function id(): int
49    {
50        return 0;
51    }
52
53    /**
54     * The users email address.
55     *
56     * @return string
57     */
58    public function email(): string
59    {
60        return $this->tree->getPreference('WEBTREES_EMAIL', 'no-reply@example.com');
61    }
62
63    /**
64     * The user‘s real name.
65     *
66     * @return string
67     */
68    public function realName(): string
69    {
70        return $this->tree->title();
71    }
72
73    /**
74     * The user‘s login name.
75     *
76     * @return string
77     */
78    public function userName(): string
79    {
80        return '';
81    }
82
83    /**
84     * @param string $setting_name
85     * @param string $default
86     *
87     * @return string
88     */
89    public function getPreference(string $setting_name, string $default = ''): string
90    {
91        return $default;
92    }
93
94    /**
95     * @param string $setting_name
96     * @param string $setting_value
97     *
98     * @return UserInterface
99     */
100    public function setPreference(string $setting_name, string $setting_value): UserInterface
101    {
102        return $this;
103    }
104}
105