xref: /webtrees/app/Module/UserWelcomeModule.php (revision 52550490b7095dd69811f3ec21ed5a3ca1a8968d) 
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\Module;
21
22use Fisharebest\Webtrees\Auth;
23use Fisharebest\Webtrees\Contracts\UserInterface;
24use Fisharebest\Webtrees\Http\RequestHandlers\AccountEdit;
25use Fisharebest\Webtrees\I18N;
26use Fisharebest\Webtrees\Individual;
27use Fisharebest\Webtrees\Registry;
28use Fisharebest\Webtrees\Services\ModuleService;
29use Fisharebest\Webtrees\Tree;
30use Illuminate\Support\Str;
31
32/**
33 * Class UserWelcomeModule
34 */
35class UserWelcomeModule extends AbstractModule implements ModuleBlockInterface
36{
37    use ModuleBlockTrait;
38
39    private ModuleService $module_service;
40
41    /**
42     * @param ModuleService $module_service
43     */
44    public function __construct(ModuleService $module_service)
45    {
46        $this->module_service = $module_service;
47    }
48
49    /**
50     * How should this module be identified in the control panel, etc.?
51     *
52     * @return string
53     */
54    public function title(): string
55    {
56        /* I18N: Name of a module */
57        return I18N::translate('My page');
58    }
59
60    /**
61     * A sentence describing what this module does.
62     *
63     * @return string
64     */
65    public function description(): string
66    {
67        /* I18N: Description of the “My page” module */
68        return I18N::translate('A greeting message and useful links for a user.');
69    }
70
71    /**
72     * Generate the HTML content of this block.
73     *
74     * @param Tree                 $tree
75     * @param int                  $block_id
76     * @param string               $context
77     * @param array<string,string> $config
78     *
79     * @return string
80     */
81    public function getBlock(Tree $tree, int $block_id, string $context, array $config = []): string
82    {
83        $gedcomid   = $tree->getUserPreference(Auth::user(), UserInterface::PREF_TREE_ACCOUNT_XREF);
84        $individual = Registry::individualFactory()->make($gedcomid, $tree);
85        $links      = [];
86
87        $pedigree_chart = $this->module_service->findByComponent(ModuleChartInterface::class, $tree, Auth::user())
88            ->first(static fn (ModuleInterface $module): bool => $module instanceof PedigreeChartModule);
89
90        if ($individual instanceof Individual) {
91            if ($pedigree_chart instanceof PedigreeChartModule) {
92                $links[] = [
93                    'url'   => $pedigree_chart->chartUrl($individual),
94                    'title' => I18N::translate('Default chart'),
95                    'icon'  => 'icon-pedigree',
96                ];
97            }
98
99            $links[] = [
100                'url'   => $individual->url(),
101                'title' => I18N::translate('My individual record'),
102                'icon'  => 'icon-indis',
103            ];
104        }
105
106        $links[] = [
107            'url'   => route(AccountEdit::class, ['tree' => $tree->name()]),
108            'title' => I18N::translate('My account'),
109            'icon'  => 'icon-mypage',
110        ];
111        $content = view('modules/user_welcome/welcome', ['links' => $links]);
112
113        $real_name = "\u{2068}" . e(Auth::user()->realName()) . "\u{2069}";
114
115        /* I18N: A %s is the user’s name */
116        $title = I18N::translate('Welcome %s', $real_name);
117
118        if ($context !== self::CONTEXT_EMBED) {
119            return view('modules/block-template', [
120                'block'      => Str::kebab($this->name()),
121                'id'         => $block_id,
122                'config_url' => '',
123                'title'      => $title,
124                'content'    => $content,
125            ]);
126        }
127
128        return $content;
129    }
130
131    /**
132     * Should this block load asynchronously using AJAX?
133     *
134     * Simple blocks are faster in-line, more complex ones can be loaded later.
135     *
136     * @return bool
137     */
138    public function loadAjax(): bool
139    {
140        return false;
141    }
142
143    /**
144     * Can this block be shown on the user’s home page?
145     *
146     * @return bool
147     */
148    public function isUserBlock(): bool
149    {
150        return true;
151    }
152
153    /**
154     * Can this block be shown on the tree’s home page?
155     *
156     * @return bool
157     */
158    public function isTreeBlock(): bool
159    {
160        return false;
161    }
162}
163