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