xref: /webtrees/app/Module/ListsMenuModule.php (revision d9ea0e86582fe4bcb21969eb1dafa8be7d592091) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2023 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;
27
28/**
29 * Class ListsMenuModule - provide a menu option for the lists
30 */
31class ListsMenuModule extends AbstractModule implements ModuleMenuInterface
32{
33    use ModuleMenuTrait;
34
35    private ModuleService $module_service;
36
37    /**
38     * ListsMenuModule constructor.
39     *
40     * @param ModuleService $module_service
41     */
42    public function __construct(ModuleService $module_service)
43    {
44        $this->module_service = $module_service;
45    }
46
47    /**
48     * How should this module be identified in the control panel, etc.?
49     *
50     * @return string
51     */
52    public function title(): string
53    {
54        /* I18N: Name of a module */
55        return I18N::translate('Lists');
56    }
57
58    /**
59     * A sentence describing what this module does.
60     *
61     * @return string
62     */
63    public function description(): string
64    {
65        /* I18N: Description of the “Lists” module */
66        return I18N::translate('The lists menu.');
67    }
68
69    /**
70     * The default position for this menu.  It can be changed in the control panel.
71     *
72     * @return int
73     */
74    public function defaultMenuOrder(): int
75    {
76        return 3;
77    }
78
79    /**
80     * A menu, to be added to the main application menu.
81     *
82     * @param Tree $tree
83     *
84     * @return Menu|null
85     */
86    public function getMenu(Tree $tree): ?Menu
87    {
88        $submenus = $this->module_service->findByComponent(ModuleListInterface::class, $tree, Auth::user())
89            ->map(static function (ModuleListInterface $module) use ($tree): ?Menu {
90                return $module->listMenu($tree);
91            })
92            ->filter()
93            ->sort(static function (Menu $x, Menu $y): int {
94                return I18N::comparator()($x->getLabel(), $y->getLabel());
95            });
96
97        if ($submenus->isEmpty()) {
98            return null;
99        }
100
101        return new Menu(I18N::translate('Lists'), '#', 'menu-list', [], $submenus->all());
102    }
103}
104