xref: /webtrees/app/Module/ListsMenuModule.php (revision 89f7189b61a494347591c99bdb92afb7d8b66e1b) 
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;
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    /**
36     * @var ModuleService
37     */
38    private $module_service;
39
40    /**
41     * ListsMenuModule 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('Lists');
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 “Lists” module */
69        return I18N::translate('The lists 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 3;
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        $submenus = $this->module_service->findByComponent(ModuleListInterface::class, $tree, Auth::user())
92            ->map(static function (ModuleListInterface $module) use ($tree): ?Menu {
93                return $module->listMenu($tree);
94            })
95            ->filter()
96            ->sort(static function (Menu $x, Menu $y): int {
97                return $x->getLabel() <=> $y->getLabel();
98            });
99
100        if ($submenus->isEmpty()) {
101            return null;
102        }
103
104        return new Menu(I18N::translate('Lists'), '#', 'menu-list', [], $submenus->all());
105    }
106}
107