xref: /webtrees/app/Module/ChartsMenuModule.php (revision 961ec7555e8fa1828ea16f2a1fd6a74f140ce707) 
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\Module;
25use Fisharebest\Webtrees\Tree;
26use Symfony\Component\HttpFoundation\Request;
27
28/**
29 * Class ChartsMenuModule - provide a menu option for the charts
30 */
31class ChartsMenuModule extends AbstractModule implements ModuleInterface, ModuleMenuInterface
32{
33    use ModuleMenuTrait;
34
35    /**
36     * How should this module be labelled on tabs, menus, etc.?
37     *
38     * @return string
39     */
40    public function title(): string
41    {
42        /* I18N: Name of a module */
43        return I18N::translate('Charts');
44    }
45
46    /**
47     * A sentence describing what this module does.
48     *
49     * @return string
50     */
51    public function description(): string
52    {
53        /* I18N: Description of the “Reports” module */
54        return I18N::translate('The charts menu.');
55    }
56
57    /**
58     * The default position for this menu.  It can be changed in the control panel.
59     *
60     * @return int
61     */
62    public function defaultMenuOrder(): int
63    {
64        return 20;
65    }
66
67    /**
68     * A menu, to be added to the main application menu.
69     *
70     * @param Tree $tree
71     *
72     * @return Menu|null
73     */
74    public function getMenu(Tree $tree): ?Menu
75    {
76        $request    = Request::createFromGlobals();
77        $xref       = $request->get('xref', '');
78        $individual = Individual::getInstance($xref, $tree) ?? $tree->significantIndividual(Auth::user());
79        $submenus   = Module::activeCharts($tree)
80            ->map(function (ModuleChartInterface $module) use ($individual): Menu {
81                return $module->chartMenu($individual);
82            });
83
84        if ($submenus->isEmpty()) {
85            return null;
86        }
87
88        return new Menu(I18N::translate('Charts'), '#', 'menu-chart', ['rel' => 'nofollow'], $submenus->all());
89    }
90}
91