xref: /webtrees/app/Module/TreesMenuModule.php (revision 895230eed7521b5cd885b90d4f5310405ff0b69a) 
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 ModuleInterface, ModuleMenuInterface
29{
30    use ModuleMenuTrait;
31
32    /** {@inheritdoc} */
33    public function title(): string
34    {
35        /* I18N: Name of a module */
36        return I18N::translate('Family trees');
37    }
38
39    /** {@inheritdoc} */
40    public function description(): string
41    {
42        /* I18N: Description of the “Reports” module */
43        return I18N::translate('The family trees menu.');
44    }
45
46    /**
47     * The default position for this menu.  It can be changed in the control panel.
48     *
49     * @return int
50     */
51    public function defaultMenuOrder(): int
52    {
53        return 10;
54    }
55
56    /**
57     * A menu, to be added to the main application menu.
58     *
59     * @param Tree $tree
60     *
61     * @return Menu|null
62     */
63    public function getMenu(Tree $tree): ?Menu
64    {
65        if (Tree::all()->count() === 1 || Site::getPreference('ALLOW_CHANGE_GEDCOM') !== '1') {
66            return new Menu(I18N::translate('Family tree'), route('tree-page', ['ged' => $tree->name()]), 'menu-tree');
67        }
68
69        $submenus = [];
70        foreach (Tree::all() as $menu_tree) {
71            if ($menu_tree->id() === $tree->id()) {
72                $active = 'active ';
73            } else {
74                $active = '';
75            }
76            $submenus[] = new Menu(e($menu_tree->title()), route('tree-page', ['ged' => $menu_tree->name()]), $active . 'menu-tree-' . $menu_tree->id());
77        }
78
79        return new Menu(I18N::translate('Family trees'), '#', 'menu-tree', [], $submenus);
80    }
81}
82