xref: /webtrees/app/Module/ChartsMenuModule.php (revision 050c0bce7a32e90a2464e43124b663679e68bf20) 
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 Psr\Http\Message\ServerRequestInterface;
27
28/**
29 * Class ChartsMenuModule - provide a menu option for the charts
30 */
31class ChartsMenuModule 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 identified in the control panel, etc.?
52     *
53     * @return string
54     */
55    public function title(): string
56    {
57        /* I18N: Name of a module */
58        return I18N::translate('Charts');
59    }
60
61    /**
62     * A sentence describing what this module does.
63     *
64     * @return string
65     */
66    public function description(): string
67    {
68        /* I18N: Description of the “Reports” module */
69        return I18N::translate('The charts menu.');
70    }
71
72    /**
73     * The default position for this menu.  It can be changed in the control panel.
74     *
75     * @return int
76     */
77    public function defaultMenuOrder(): int
78    {
79        return 2;
80    }
81
82    /**
83     * A menu, to be added to the main application menu.
84     *
85     * @param Tree $tree
86     *
87     * @return Menu|null
88     */
89    public function getMenu(Tree $tree): ?Menu
90    {
91        $request    = app(ServerRequestInterface::class);
92        $xref       = $request->getQueryParams()['xref'] ?? '';
93        $individual = Individual::getInstance($xref, $tree) ?? $tree->significantIndividual(Auth::user());
94        $submenus   = $this->module_service->findByComponent(ModuleChartInterface::class, $tree, Auth::user())
95            ->map(static function (ModuleChartInterface $module) use ($individual): Menu {
96                return $module->chartMenu($individual);
97            });
98
99        if ($submenus->isEmpty()) {
100            return null;
101        }
102
103        return new Menu(I18N::translate('Charts'), '#', 'menu-chart', ['rel' => 'nofollow'], $submenus->all());
104    }
105}
106