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