xref: /webtrees/app/Module/ReportsMenuModule.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\I18N;
24use Fisharebest\Webtrees\Menu;
25use Fisharebest\Webtrees\Registry;
26use Fisharebest\Webtrees\Services\ModuleService;
27use Fisharebest\Webtrees\Tree;
28use Fisharebest\Webtrees\Validator;
29use Psr\Http\Message\ServerRequestInterface;
30
31/**
32 * Class ReportsMenuModule - provide a menu option for the reports
33 */
34class ReportsMenuModule extends AbstractModule implements ModuleMenuInterface
35{
36    use ModuleMenuTrait;
37
38    private ModuleService $module_service;
39
40    /**
41     * @param ModuleService $module_service
42     */
43    public function __construct(ModuleService $module_service)
44    {
45        $this->module_service = $module_service;
46    }
47
48    /**
49     * How should this module be identified in the control panel, etc.?
50     *
51     * @return string
52     */
53    public function title(): string
54    {
55        /* I18N: Name of a module */
56        return I18N::translate('Reports');
57    }
58
59    /**
60     * A sentence describing what this module does.
61     *
62     * @return string
63     */
64    public function description(): string
65    {
66        /* I18N: Description of the “Reports” module */
67        return I18N::translate('The reports menu.');
68    }
69
70    /**
71     * The default position for this menu.  It can be changed in the control panel.
72     *
73     * @return int
74     */
75    public function defaultMenuOrder(): int
76    {
77        return 5;
78    }
79
80    /**
81     * A menu, to be added to the main application menu.
82     *
83     * @param Tree $tree
84     *
85     * @return Menu|null
86     */
87    public function getMenu(Tree $tree): Menu|null
88    {
89        $request    = Registry::container()->get(ServerRequestInterface::class);
90        $xref       = Validator::attributes($request)->isXref()->string('xref', '');
91        $individual = $tree->significantIndividual(Auth::user(), $xref);
92        $submenus   = $this->module_service->findByComponent(ModuleReportInterface::class, $tree, Auth::user())
93            ->map(static fn (ModuleReportInterface $module): Menu => $module->getReportMenu($individual))
94            ->sort(static fn (Menu $x, Menu $y): int => I18N::comparator()($x->getLabel(), $y->getLabel()));
95
96        if ($submenus->isEmpty()) {
97            return null;
98        }
99
100        return new Menu(I18N::translate('Reports'), '#', 'menu-report', ['rel' => 'nofollow'], $submenus->all());
101    }
102}
103