xref: /webtrees/app/Module/UserWelcomeModule.php (revision 57ab22314b2599feb432b1a1ed71643cfc2f0452) 
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\Module;
19
20use Fisharebest\Webtrees\Auth;
21use Fisharebest\Webtrees\I18N;
22use Fisharebest\Webtrees\Individual;
23use Fisharebest\Webtrees\Services\ModuleService;
24use Fisharebest\Webtrees\Tree;
25use Illuminate\Support\Str;
26
27/**
28 * Class UserWelcomeModule
29 */
30class UserWelcomeModule extends AbstractModule implements ModuleBlockInterface
31{
32    use ModuleBlockTrait;
33
34    /**
35     * @var ModuleService
36     */
37    private $module_service;
38
39    /**
40     * UserWelcomeModule constructor.
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 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(), 'gedcomid');
84        $individual = Individual::getInstance($gedcomid, $tree);
85        $links      = [];
86
87        $pedigree_chart = $this->module_service->findByComponent(ModuleChartInterface::class, $tree, Auth::user())
88            ->first(static function (ModuleInterface $module): bool {
89                return $module instanceof PedigreeChartModule;
90            });
91
92        if ($individual instanceof Individual) {
93            if ($pedigree_chart instanceof PedigreeChartModule) {
94                $links[] = [
95                    'url'   => $pedigree_chart->chartUrl($individual),
96                    'title' => I18N::translate('Default chart'),
97                    'icon'  => 'icon-pedigree',
98                ];
99            }
100
101            $links[] = [
102                'url'   => $individual->url(),
103                'title' => I18N::translate('My individual record'),
104                'icon'  => 'icon-indis',
105            ];
106        }
107
108        $links[] = [
109            'url'   => route('my-account', []),
110            'title' => I18N::translate('My account'),
111            'icon'  => 'icon-mypage',
112        ];
113        $content = view('modules/user_welcome/welcome', ['links' => $links]);
114
115        $real_name = '<span dir="auto">' . e(Auth::user()->realName()) . '</span>';
116
117        /* I18N: A %s is the user’s name */
118        $title = I18N::translate('Welcome %s', $real_name);
119
120        if ($context !== self::CONTEXT_EMBED) {
121            return view('modules/block-template', [
122                'block'      => Str::kebab($this->name()),
123                'id'         => $block_id,
124                'config_url' => '',
125                'title'      => $title,
126                'content'    => $content,
127            ]);
128        }
129
130        return $content;
131    }
132
133    /**
134     * Should this block load asynchronously using AJAX?
135     *
136     * Simple blocks are faster in-line, more complex ones can be loaded later.
137     *
138     * @return bool
139     */
140    public function loadAjax(): bool
141    {
142        return false;
143    }
144
145    /**
146     * Can this block be shown on the user’s home page?
147     *
148     * @return bool
149     */
150    public function isUserBlock(): bool
151    {
152        return true;
153    }
154
155    /**
156     * Can this block be shown on the tree’s home page?
157     *
158     * @return bool
159     */
160    public function isTreeBlock(): bool
161    {
162        return false;
163    }
164}
165