xref: /webtrees/app/Module/TreesMenuModule.php (revision 102b4ac44f212e64db4f1856a1da4ed1949a71ef) 
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\Http\RequestHandlers\TreePage;
23use Fisharebest\Webtrees\I18N;
24use Fisharebest\Webtrees\Menu;
25use Fisharebest\Webtrees\Services\TreeService;
26use Fisharebest\Webtrees\Site;
27use Fisharebest\Webtrees\Tree;
28
29use function e;
30use function route;
31
32/**
33 * Class TreesMenuModule - provide a menu option for the trees options
34 */
35class TreesMenuModule extends AbstractModule implements ModuleMenuInterface
36{
37    use ModuleMenuTrait;
38
39    private TreeService $tree_service;
40
41    /**
42     * @param TreeService $tree_service
43     */
44    public function __construct(TreeService $tree_service)
45    {
46        $this->tree_service = $tree_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('Family trees');
58    }
59
60    public function description(): string
61    {
62        /* I18N: Description of the “Family trees” module */
63        return I18N::translate('The family trees menu.');
64    }
65
66    /**
67     * The default position for this menu.  It can be changed in the control panel.
68     *
69     * @return int
70     */
71    public function defaultMenuOrder(): int
72    {
73        return 1;
74    }
75
76    /**
77     * A menu, to be added to the main application menu.
78     *
79     * @param Tree $tree
80     *
81     * @return Menu|null
82     */
83    public function getMenu(Tree $tree): Menu|null
84    {
85        $trees = $this->tree_service->all();
86
87        if ($trees->count() === 1 || Site::getPreference('ALLOW_CHANGE_GEDCOM') !== '1') {
88            return new Menu(I18N::translate('Family tree'), route(TreePage::class, ['tree' => $tree->name()]), 'menu-tree');
89        }
90
91        $submenus = [];
92        foreach ($trees as $menu_tree) {
93            if ($menu_tree->id() === $tree->id()) {
94                $active = 'active ';
95            } else {
96                $active = '';
97            }
98            $submenus[] = new Menu(e($menu_tree->title()), route(TreePage::class, ['tree' => $menu_tree->name()]), $active . 'menu-tree-' . $menu_tree->id());
99        }
100
101        return new Menu(I18N::translate('Family trees'), '#', 'menu-tree', [], $submenus);
102    }
103}
104