xref: /webtrees/app/Module/WelcomeBlockModule.php (revision 0797053b7314a8688ee46e4c25ffb66029a38744) 
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 Illuminate\Support\Str;
26use Psr\Http\Message\ServerRequestInterface;
27
28/**
29 * Class WelcomeBlockModule
30 */
31class WelcomeBlockModule extends AbstractModule implements ModuleBlockInterface
32{
33    use ModuleBlockTrait;
34
35    /**
36     * @var ModuleService
37     */
38    private $module_service;
39
40    /**
41     * UserWelcomeModule constructor.
42     *
43     * @param ModuleService $module_service
44     */
45    public function __construct(ModuleService $module_service)
46    {
47        $this->module_service = $module_service;
48    }
49
50    /**
51     * How should this module be identified in the control panel, etc.?
52     *
53     * @return string
54     */
55    public function title(): string
56    {
57        /* I18N: Name of a module */
58        return I18N::translate('Home page');
59    }
60
61    /**
62     * A sentence describing what this module does.
63     *
64     * @return string
65     */
66    public function description(): string
67    {
68        /* I18N: Description of the “Home page” module */
69        return I18N::translate('A greeting message for site visitors.');
70    }
71
72    /**
73     * Generate the HTML content of this block.
74     *
75     * @param Tree     $tree
76     * @param int      $block_id
77     * @param string   $ctype
78     * @param string[] $cfg
79     *
80     * @return string
81     */
82    public function getBlock(Tree $tree, int $block_id, string $ctype = '', array $cfg = []): string
83    {
84        $individual = $tree->significantIndividual(Auth::user());
85
86        $links = [];
87
88        $pedigree_chart = $this->module_service
89            ->findByComponent(ModuleChartInterface::class, $tree, Auth::user())
90            ->first(static function (ModuleInterface $module): bool {
91                return $module instanceof PedigreeChartModule;
92            });
93
94        if ($pedigree_chart instanceof PedigreeChartModule) {
95            $links[] = [
96                'url'   => route('pedigree', [
97                    'xref' => $individual->xref(),
98                    'ged'  => $individual->tree()->name(),
99                ]),
100                'title' => I18N::translate('Default chart'),
101                'icon'  => 'icon-pedigree',
102            ];
103        }
104
105        $links[] = [
106            'url'   => $individual->url(),
107            'title' => I18N::translate('Default individual'),
108            'icon'  => 'icon-indis',
109        ];
110
111        if (Site::getPreference('USE_REGISTRATION_MODULE') === '1' && !Auth::check()) {
112            $links[] = [
113                'url'   => route('register'),
114                'title' => I18N::translate('Request a new user account'),
115                'icon'  => 'icon-user_add',
116            ];
117        }
118
119        $content = view('modules/gedcom_block/welcome', ['links' => $links]);
120
121        if ($ctype !== '') {
122            return view('modules/block-template', [
123                'block'      => Str::kebab($this->name()),
124                'id'         => $block_id,
125                'config_url' => '',
126                'title'      => $individual->tree()->title(),
127                'content'    => $content,
128            ]);
129        }
130
131        return $content;
132    }
133
134    /** {@inheritdoc} */
135    public function loadAjax(): bool
136    {
137        return false;
138    }
139
140    /** {@inheritdoc} */
141    public function isUserBlock(): bool
142    {
143        return false;
144    }
145
146    /** {@inheritdoc} */
147    public function isTreeBlock(): bool
148    {
149        return true;
150    }
151
152    /**
153     * Update the configuration for a block.
154     *
155     * @param ServerRequestInterface $request
156     * @param int     $block_id
157     *
158     * @return void
159     */
160    public function saveBlockConfiguration(ServerRequestInterface $request, int $block_id): void
161    {
162    }
163
164    /**
165     * An HTML form to edit block settings
166     *
167     * @param Tree $tree
168     * @param int  $block_id
169     *
170     * @return void
171     */
172    public function editBlockConfiguration(Tree $tree, int $block_id): void
173    {
174    }
175}
176