xref: /webtrees/app/Module/ListsMenuModule.php (revision 3976b4703df669696105ed6b024b96d433c8fbdb) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2019 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 <http://www.gnu.org/licenses/>.
16 */
17declare(strict_types=1);
18
19namespace Fisharebest\Webtrees\Module;
20
21use Fisharebest\Webtrees\Auth;
22use Fisharebest\Webtrees\I18N;
23use Fisharebest\Webtrees\Menu;
24use Fisharebest\Webtrees\Services\ModuleService;
25use Fisharebest\Webtrees\Tree;
26
27/**
28 * Class ListsMenuModule - provide a menu option for the lists
29 */
30class ListsMenuModule extends AbstractModule implements ModuleMenuInterface
31{
32    use ModuleMenuTrait;
33
34    /**
35     * @var ModuleService
36     */
37    private $module_service;
38
39    /**
40     * ListsMenuModule 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('Lists');
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 “Reports” module */
68        return I18N::translate('The lists 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 3;
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        $submenus = $this->module_service->findByComponent(ModuleListInterface::class, $tree, Auth::user())
91            ->map(static function (ModuleListInterface $module) use ($tree): ?Menu {
92                return $module->listMenu($tree);
93            })
94            ->filter()
95            ->sort(static function (Menu $x, Menu $y): int {
96                return $x->getLabel() <=> $y->getLabel();
97            });
98
99        if ($submenus->isEmpty()) {
100            return null;
101        }
102
103        return new Menu(I18N::translate('Lists'), '#', 'menu-list', [], $submenus->all());
104    }
105}
106