xref: /webtrees/app/Module/ChartsMenuModule.php (revision d279a86e6770b5e6a6d888a56fcc7c0f1239a0e4) 
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    /** {@inheritdoc} */
36    public function title(): string
37    {
38        /* I18N: Name of a module */
39        return I18N::translate('Charts');
40    }
41
42    /** {@inheritdoc} */
43    public function description(): string
44    {
45        /* I18N: Description of the “Reports” module */
46        return I18N::translate('The charts menu.');
47    }
48
49    /**
50     * The default position for this menu.  It can be changed in the control panel.
51     *
52     * @return int
53     */
54    public function defaultMenuOrder(): int
55    {
56        return 20;
57    }
58
59    /**
60     * A menu, to be added to the main application menu.
61     *
62     * @param Tree $tree
63     *
64     * @return Menu|null
65     */
66    public function getMenu(Tree $tree): ?Menu
67    {
68        $request    = Request::createFromGlobals();
69        $xref       = $request->get('xref', '');
70        $individual = Individual::getInstance($xref, $tree) ?? $tree->significantIndividual(Auth::user());
71        $submenus   = Module::activeCharts($tree)
72            ->map(function (ModuleChartInterface $module) use ($individual): Menu {
73                return $module->chartMenu($individual);
74            });
75
76        if ($submenus->isEmpty()) {
77            return null;
78        }
79
80        return new Menu(I18N::translate('Charts'), '#', 'menu-chart', ['rel' => 'nofollow'], $submenus->all());
81    }
82}
83