xref: /webtrees/app/Module/ListsMenuModule.php (revision 9ed80f829cfb208ae92f7928345696619569bf4e) 
1<?php
2/**
3 * webtrees: online genealogy
4 * Copyright (C) 2019 webtrees development team
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16declare(strict_types=1);
17
18namespace Fisharebest\Webtrees\Module;
19
20use Fisharebest\Webtrees\Auth;
21use Fisharebest\Webtrees\I18N;
22use Fisharebest\Webtrees\Menu;
23use Fisharebest\Webtrees\Services\ModuleService;
24use Fisharebest\Webtrees\Tree;
25
26/**
27 * Class ListsMenuModule - provide a menu option for the lists
28 */
29class ListsMenuModule extends AbstractModule implements ModuleMenuInterface
30{
31    use ModuleMenuTrait;
32
33    /**
34     * @var ModuleService
35     */
36    private $module_service;
37
38    /**
39     * ListsMenuModule constructor.
40     *
41     * @param ModuleService $module_service
42     */
43    public function __construct(ModuleService $module_service)
44    {
45        $this->module_service = $module_service;
46    }
47
48    /**
49     * How should this module be identified in the control panel, etc.?
50     *
51     * @return string
52     */
53    public function title(): string
54    {
55        /* I18N: Name of a module */
56        return I18N::translate('Lists');
57    }
58
59    /**
60     * A sentence describing what this module does.
61     *
62     * @return string
63     */
64    public function description(): string
65    {
66        /* I18N: Description of the “Reports” module */
67        return I18N::translate('The lists menu.');
68    }
69
70    /**
71     * The default position for this menu.  It can be changed in the control panel.
72     *
73     * @return int
74     */
75    public function defaultMenuOrder(): int
76    {
77        return 3;
78    }
79
80    /**
81     * A menu, to be added to the main application menu.
82     *
83     * @param Tree $tree
84     *
85     * @return Menu|null
86     */
87    public function getMenu(Tree $tree): ?Menu
88    {
89        $submenus = $this->module_service->findByComponent(ModuleListInterface::class, $tree, Auth::user())
90            ->map(static function (ModuleListInterface $module) use ($tree): ?Menu {
91                return $module->listMenu($tree);
92            })
93            ->filter()
94            ->sort(static function (Menu $x, Menu $y) {
95                return $x->getLabel() <=> $y->getLabel();
96            });
97
98        if ($submenus->isEmpty()) {
99            return null;
100        }
101
102        return new Menu(I18N::translate('Lists'), '#', 'menu-list', [], $submenus->all());
103    }
104}
105