xref: /webtrees/app/Module/CompactTreeChartModule.php (revision 3fa66c660869af2f4c92ef37e06997aa8a0f55e1) 
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\Auth;
21use Fisharebest\Webtrees\I18N;
22use Fisharebest\Webtrees\Individual;
23use Fisharebest\Webtrees\Menu;
24
25/**
26 * Class CompactTreeChartModule
27 */
28class CompactTreeChartModule extends AbstractModule implements ModuleChartInterface
29{
30    /**
31     * How should this module be labelled on tabs, menus, etc.?
32     *
33     * @return string
34     */
35    public function getTitle(): string
36    {
37        /* I18N: Name of a module/chart */
38        return I18N::translate('Compact tree');
39    }
40
41    /**
42     * A sentence describing what this module does.
43     *
44     * @return string
45     */
46    public function getDescription(): string
47    {
48        /* I18N: Description of the “CompactTreeChart” module */
49        return I18N::translate('A chart of an individual’s ancestors, as a compact tree.');
50    }
51
52    /**
53     * What is the default access level for this module?
54     *
55     * Some modules are aimed at admins or managers, and are not generally shown to users.
56     *
57     * @return int
58     */
59    public function defaultAccessLevel(): int
60    {
61        return Auth::PRIV_PRIVATE;
62    }
63
64    /**
65     * Return a menu item for this chart.
66     *
67     * @param Individual $individual
68     *
69     * @return Menu|null
70     */
71    public function getChartMenu(Individual $individual)
72    {
73        return new Menu(
74            $this->getTitle(),
75            route('compact-tree', [
76                'xref' => $individual->xref(),
77                'ged'  => $individual->tree()->name(),
78            ]),
79            'menu-chart-compact',
80            ['rel' => 'nofollow']
81        );
82    }
83
84    /**
85     * Return a menu item for this chart - for use in individual boxes.
86     *
87     * @param Individual $individual
88     *
89     * @return Menu|null
90     */
91    public function getBoxChartMenu(Individual $individual)
92    {
93        return $this->getChartMenu($individual);
94    }
95}
96