xref: /webtrees/app/Module/TreesMenuModule.php (revision 9320815f1ce8e5a76b792d0fc59d7ba088fe3793) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2021 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    /** @var TreeService */
40    private $tree_service;
41
42    /**
43     * TreesMenuModule constructor.
44     *
45     * @param TreeService $tree_service
46     */
47    public function __construct(TreeService $tree_service)
48    {
49        $this->tree_service = $tree_service;
50    }
51
52    /**
53     * How should this module be identified in the control panel, etc.?
54     *
55     * @return string
56     */
57    public function title(): string
58    {
59        /* I18N: Name of a module */
60        return I18N::translate('Family trees');
61    }
62
63    /**
64     * A sentence describing what this module does.
65     *
66     * @return string
67     */
68    public function description(): string
69    {
70        /* I18N: Description of the “Family trees” module */
71        return I18N::translate('The family trees menu.');
72    }
73
74    /**
75     * The default position for this menu.  It can be changed in the control panel.
76     *
77     * @return int
78     */
79    public function defaultMenuOrder(): int
80    {
81        return 1;
82    }
83
84    /**
85     * A menu, to be added to the main application menu.
86     *
87     * @param Tree $tree
88     *
89     * @return Menu|null
90     */
91    public function getMenu(Tree $tree): ?Menu
92    {
93        $trees = $this->tree_service->all();
94
95        if ($trees->count() === 1 || Site::getPreference('ALLOW_CHANGE_GEDCOM') !== '1') {
96            return new Menu(I18N::translate('Family tree'), route(TreePage::class, ['tree' => $tree->name()]), 'menu-tree');
97        }
98
99        $submenus = [];
100        foreach ($trees as $menu_tree) {
101            if ($menu_tree->id() === $tree->id()) {
102                $active = 'active ';
103            } else {
104                $active = '';
105            }
106            $submenus[] = new Menu(e($menu_tree->title()), route(TreePage::class, ['tree' => $menu_tree->name()]), $active . 'menu-tree-' . $menu_tree->id());
107        }
108
109        return new Menu(I18N::translate('Family trees'), '#', 'menu-tree', [], $submenus);
110    }
111}
112