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