xref: /webtrees/app/Module/WelcomeBlockModule.php (revision 0cfd6963ac65bd7fe86283b801b4f23d665c6004) 
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\Services\ModuleService;
23use Fisharebest\Webtrees\Site;
24use Fisharebest\Webtrees\Tree;
25use Symfony\Component\HttpFoundation\Request;
26
27/**
28 * Class WelcomeBlockModule
29 */
30class WelcomeBlockModule 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('Home 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 “Home page” module */
68        return I18N::translate('A greeting message for site visitors.');
69    }
70
71    /**
72     * Generate the HTML content of this block.
73     *
74     * @param Tree     $tree
75     * @param int      $block_id
76     * @param string   $ctype
77     * @param string[] $cfg
78     *
79     * @return string
80     */
81    public function getBlock(Tree $tree, int $block_id, string $ctype = '', array $cfg = []): string
82    {
83        $individual = $tree->significantIndividual(Auth::user());
84
85        $links = [];
86
87        $pedigree_chart = $this->module_service->findByComponent(ModuleChartInterface::class, $tree, Auth::user())
88            ->filter(function (ModuleInterface $module): bool {
89                return $module instanceof PedigreeChartModule;
90            });
91
92        if ($pedigree_chart instanceof PedigreeChartModule) {
93            $links[] = [
94                'url'   => route('pedigree', [
95                    'xref' => $individual->xref(),
96                    'ged'  => $individual->tree()->name(),
97                ]),
98                'title' => I18N::translate('Default chart'),
99                'icon'  => 'icon-pedigree',
100            ];
101        }
102
103        $links[] = [
104            'url'   => $individual->url(),
105            'title' => I18N::translate('Default individual'),
106            'icon'  => 'icon-indis',
107        ];
108
109        if (Site::getPreference('USE_REGISTRATION_MODULE') === '1' && !Auth::check()) {
110            $links[] = [
111                'url'   => route('register'),
112                'title' => I18N::translate('Request a new user account'),
113                'icon'  => 'icon-user_add',
114            ];
115        }
116
117        $content = view('modules/gedcom_block/welcome', ['links' => $links]);
118
119        if ($ctype !== '') {
120            return view('modules/block-template', [
121                'block'      => str_replace('_', '-', $this->name()),
122                'id'         => $block_id,
123                'config_url' => '',
124                'title'      => $individual->tree()->title(),
125                'content'    => $content,
126            ]);
127        }
128
129        return $content;
130    }
131
132    /** {@inheritdoc} */
133    public function loadAjax(): bool
134    {
135        return false;
136    }
137
138    /** {@inheritdoc} */
139    public function isUserBlock(): bool
140    {
141        return false;
142    }
143
144    /** {@inheritdoc} */
145    public function isTreeBlock(): bool
146    {
147        return true;
148    }
149
150    /**
151     * Update the configuration for a block.
152     *
153     * @param Request $request
154     * @param int     $block_id
155     *
156     * @return void
157     */
158    public function saveBlockConfiguration(Request $request, int $block_id)
159    {
160    }
161
162    /**
163     * An HTML form to edit block settings
164     *
165     * @param Tree $tree
166     * @param int  $block_id
167     *
168     * @return void
169     */
170    public function editBlockConfiguration(Tree $tree, int $block_id)
171    {
172    }
173}
174