xref: /webtrees/app/Module/ReportsMenuModule.php (revision b6017f990d38d8c56e04c0096ce9a7e8745ad4ba) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2021 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\Services\ModuleService;
26use Fisharebest\Webtrees\Tree;
27use Psr\Http\Message\ServerRequestInterface;
28
29use function app;
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    /**
39     * @var ModuleService
40     */
41    private $module_service;
42
43    /**
44     * ChartsMenuModule constructor.
45     *
46     * @param ModuleService $module_service
47     */
48    public function __construct(ModuleService $module_service)
49    {
50        $this->module_service = $module_service;
51    }
52
53    /**
54     * How should this module be identified in the control panel, etc.?
55     *
56     * @return string
57     */
58    public function title(): string
59    {
60        /* I18N: Name of a module */
61        return I18N::translate('Reports');
62    }
63
64    /**
65     * A sentence describing what this module does.
66     *
67     * @return string
68     */
69    public function description(): string
70    {
71        /* I18N: Description of the “Reports” module */
72        return I18N::translate('The reports menu.');
73    }
74
75    /**
76     * The default position for this menu.  It can be changed in the control panel.
77     *
78     * @return int
79     */
80    public function defaultMenuOrder(): int
81    {
82        return 5;
83    }
84
85    /**
86     * A menu, to be added to the main application menu.
87     *
88     * @param Tree $tree
89     *
90     * @return Menu|null
91     */
92    public function getMenu(Tree $tree): ?Menu
93    {
94        $request    = app(ServerRequestInterface::class);
95        $xref       = $request->getAttribute('xref', '');
96        $individual = $tree->significantIndividual(Auth::user(), $xref);
97        $submenus   = $this->module_service->findByComponent(ModuleReportInterface::class, $tree, Auth::user())
98            ->map(static function (ModuleReportInterface $module) use ($individual): Menu {
99                return $module->getReportMenu($individual);
100            })
101            ->sort(static function (Menu $x, Menu $y): int {
102                return $x->getLabel() <=> $y->getLabel();
103            });
104
105        if ($submenus->isEmpty()) {
106            return null;
107        }
108
109        return new Menu(I18N::translate('Reports'), '#', 'menu-report', ['rel' => 'nofollow'], $submenus->all());
110    }
111}
112