xref: /webtrees/app/Module/ChartsMenuModule.php (revision a091ac74647eab281b25090b737835eeea14ae10) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2020 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\Menu;
25use Fisharebest\Webtrees\Services\ModuleService;
26use Fisharebest\Webtrees\Tree;
27use Psr\Http\Message\ServerRequestInterface;
28
29/**
30 * Class ChartsMenuModule - provide a menu option for the charts
31 */
32class ChartsMenuModule extends AbstractModule implements ModuleMenuInterface
33{
34    use ModuleMenuTrait;
35
36    /**
37     * @var ModuleService
38     */
39    private $module_service;
40
41    /**
42     * ChartsMenuModule constructor.
43     *
44     * @param ModuleService $module_service
45     */
46    public function __construct(ModuleService $module_service)
47    {
48        $this->module_service = $module_service;
49    }
50
51    /**
52     * How should this module be identified in the control panel, etc.?
53     *
54     * @return string
55     */
56    public function title(): string
57    {
58        /* I18N: Name of a module */
59        return I18N::translate('Charts');
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 “Charts” module */
70        return I18N::translate('The charts 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 2;
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    = app(ServerRequestInterface::class);
93        $xref       = $request->getAttribute('xref', '');
94        $individual = $tree->significantIndividual(Auth::user(), $xref);
95        $submenus   = $this->module_service->findByComponent(ModuleChartInterface::class, $tree, Auth::user())
96            ->map(static function (ModuleChartInterface $module) use ($individual): Menu {
97                return $module->chartMenu($individual);
98            });
99
100        if ($submenus->isEmpty()) {
101            return null;
102        }
103
104        return new Menu(I18N::translate('Charts'), '#', 'menu-chart', ['rel' => 'nofollow'], $submenus->all());
105    }
106}
107