xref: /webtrees/app/Module/ReportsMenuModule.php (revision ad7270802ba57a28d195fc58fcc55f26458a779a) 
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\Individual;
23use Fisharebest\Webtrees\Menu;
24use Fisharebest\Webtrees\Services\ModuleService;
25use Fisharebest\Webtrees\Tree;
26use Symfony\Component\HttpFoundation\Request;
27
28/**
29 * Class ReportsMenuModule - provide a menu option for the reports
30 */
31class ReportsMenuModule extends AbstractModule implements ModuleMenuInterface
32{
33    use ModuleMenuTrait;
34
35    /**
36     * @var ModuleService
37     */
38    private $module_service;
39
40    /**
41     * ChartsMenuModule 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 labelled on tabs, menus, etc.?
52     *
53     * @return string
54     */
55    /** {@inheritdoc} */
56    public function title(): string
57    {
58        /* I18N: Name of a module */
59        return I18N::translate('Reports');
60    }
61
62    /**
63     * A sentence describing what this module does.
64     *
65     * @return string
66     */
67    public function description(): string
68    {
69        /* I18N: Description of the “Reports” module */
70        return I18N::translate('The reports menu.');
71    }
72
73    /**
74     * The default position for this menu.  It can be changed in the control panel.
75     *
76     * @return int
77     */
78    public function defaultMenuOrder(): int
79    {
80        return 5;
81    }
82
83    /**
84     * A menu, to be added to the main application menu.
85     *
86     * @param Tree $tree
87     *
88     * @return Menu|null
89     */
90    public function getMenu(Tree $tree): ?Menu
91    {
92        $request    = Request::createFromGlobals();
93        $xref       = $request->get('xref', '');
94        $individual = Individual::getInstance($xref, $tree) ?? $tree->significantIndividual(Auth::user());
95        $submenus   = $this->module_service->findByComponent('report', $tree, Auth::user())
96            ->map(function (ModuleReportInterface $module) use ($individual): Menu {
97                return $module->getReportMenu($individual);
98            });
99
100        if ($submenus->isEmpty()) {
101            return null;
102        }
103
104        return new Menu(I18N::translate('Reports'), '#', 'menu-report', ['rel' => 'nofollow'], $submenus->all());
105    }
106}
107