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