xref: /webtrees/app/Module/TreesMenuModule.php (revision fd6c003f26d8770d21ea893811f0fc20a190c323) 
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\I18N;
22use Fisharebest\Webtrees\Menu;
23use Fisharebest\Webtrees\Site;
24use Fisharebest\Webtrees\Tree;
25
26/**
27 * Class TreesMenuModule - provide a menu option for the trees options
28 */
29class TreesMenuModule extends AbstractModule implements ModuleMenuInterface
30{
31    use ModuleMenuTrait;
32
33    /**
34     * How should this module be identified in the control panel, etc.?
35     *
36     * @return string
37     */
38    public function title(): string
39    {
40        /* I18N: Name of a module */
41        return I18N::translate('Family trees');
42    }
43
44    /**
45     * A sentence describing what this module does.
46     *
47     * @return string
48     */
49    public function description(): string
50    {
51        /* I18N: Description of the “Reports” module */
52        return I18N::translate('The family trees menu.');
53    }
54
55    /**
56     * The default position for this menu.  It can be changed in the control panel.
57     *
58     * @return int
59     */
60    public function defaultMenuOrder(): int
61    {
62        return 1;
63    }
64
65    /**
66     * A menu, to be added to the main application menu.
67     *
68     * @param Tree $tree
69     *
70     * @return Menu|null
71     */
72    public function getMenu(Tree $tree): ?Menu
73    {
74        if (Tree::all()->count() === 1 || Site::getPreference('ALLOW_CHANGE_GEDCOM') !== '1') {
75            return new Menu(I18N::translate('Family tree'), route('tree-page', ['tree' => $tree->name()]), 'menu-tree');
76        }
77
78        $submenus = [];
79        foreach (Tree::all() as $menu_tree) {
80            if ($menu_tree->id() === $tree->id()) {
81                $active = 'active ';
82            } else {
83                $active = '';
84            }
85            $submenus[] = new Menu(e($menu_tree->title()), route('tree-page', ['tree' => $menu_tree->name()]), $active . 'menu-tree-' . $menu_tree->id());
86        }
87
88        return new Menu(I18N::translate('Family trees'), '#', 'menu-tree', [], $submenus);
89    }
90}
91