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