xref: /webtrees/app/Module/ReportsMenuModule.php (revision ba1d7494e9648df5a87aaa3fece3e098e5ce26b1) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2019 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    /** {@inheritdoc} */
60    public function title(): string
61    {
62        /* I18N: Name of a module */
63        return I18N::translate('Reports');
64    }
65
66    /**
67     * A sentence describing what this module does.
68     *
69     * @return string
70     */
71    public function description(): string
72    {
73        /* I18N: Description of the “Reports” module */
74        return I18N::translate('The reports menu.');
75    }
76
77    /**
78     * The default position for this menu.  It can be changed in the control panel.
79     *
80     * @return int
81     */
82    public function defaultMenuOrder(): int
83    {
84        return 5;
85    }
86
87    /**
88     * A menu, to be added to the main application menu.
89     *
90     * @param Tree $tree
91     *
92     * @return Menu|null
93     */
94    public function getMenu(Tree $tree): ?Menu
95    {
96        $request    = app(ServerRequestInterface::class);
97        $xref       = $request->getQueryParams()['xref'] ?? '';
98        $individual = Individual::getInstance($xref, $tree) ?? $tree->significantIndividual(Auth::user());
99        $submenus   = $this->module_service->findByComponent(ModuleReportInterface::class, $tree, Auth::user())
100            ->map(static function (ModuleReportInterface $module) use ($individual): Menu {
101                return $module->getReportMenu($individual);
102            });
103
104        if ($submenus->isEmpty()) {
105            return null;
106        }
107
108        return new Menu(I18N::translate('Reports'), '#', 'menu-report', ['rel' => 'nofollow'], $submenus->all());
109    }
110}
111