xref: /webtrees/app/Module/ChartsMenuModule.php (revision 4ff0652c9f716485ce1866f88c40897142051b8b) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2021 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 <https://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 Fisharebest\Webtrees\Validator;
28use Psr\Http\Message\ServerRequestInterface;
29
30/**
31 * Class ChartsMenuModule - provide a menu option for the charts
32 */
33class ChartsMenuModule extends AbstractModule implements ModuleMenuInterface
34{
35    use ModuleMenuTrait;
36
37    private ModuleService $module_service;
38
39    /**
40     * ChartsMenuModule constructor.
41     *
42     * @param ModuleService $module_service
43     */
44    public function __construct(ModuleService $module_service)
45    {
46        $this->module_service = $module_service;
47    }
48
49    /**
50     * How should this module be identified in the control panel, etc.?
51     *
52     * @return string
53     */
54    public function title(): string
55    {
56        /* I18N: Name of a module */
57        return I18N::translate('Charts');
58    }
59
60    /**
61     * A sentence describing what this module does.
62     *
63     * @return string
64     */
65    public function description(): string
66    {
67        /* I18N: Description of the “Charts” module */
68        return I18N::translate('The charts menu.');
69    }
70
71    /**
72     * The default position for this menu.  It can be changed in the control panel.
73     *
74     * @return int
75     */
76    public function defaultMenuOrder(): int
77    {
78        return 2;
79    }
80
81    /**
82     * A menu, to be added to the main application menu.
83     *
84     * @param Tree $tree
85     *
86     * @return Menu|null
87     */
88    public function getMenu(Tree $tree): ?Menu
89    {
90        $request = app(ServerRequestInterface::class);
91        assert($request instanceof ServerRequestInterface);
92
93        $xref       = Validator::attributes($request)->isXref()->string('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            ->sort(static function (Menu $x, Menu $y): int {
100                return $x->getLabel() <=> $y->getLabel();
101            });
102
103        if ($submenus->isEmpty()) {
104            return null;
105        }
106
107        return new Menu(I18N::translate('Charts'), '#', 'menu-chart', ['rel' => 'nofollow'], $submenus->all());
108    }
109}
110