xref: /webtrees/app/Module/TimelineChartModule.php (revision 49a243cb5fe7c21b24e262552d556b018bfe3f41) 
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\Individual;
22use Fisharebest\Webtrees\Menu;
23
24/**
25 * Class TimelineChartModule
26 */
27class TimelineChartModule extends AbstractModule implements ModuleInterface, ModuleChartInterface
28{
29    use ModuleChartTrait;
30
31    /**
32     * How should this module be labelled on tabs, menus, etc.?
33     *
34     * @return string
35     */
36    public function title(): string
37    {
38        /* I18N: Name of a module/chart */
39        return I18N::translate('Timeline');
40    }
41
42    /**
43     * A sentence describing what this module does.
44     *
45     * @return string
46     */
47    public function description(): string
48    {
49        /* I18N: Description of the “TimelineChart” module */
50        return I18N::translate('A timeline displaying individual events.');
51    }
52
53    /**
54     * Return a menu item for this chart.
55     *
56     * @param Individual $individual
57     *
58     * @return Menu|null
59     */
60    public function getChartMenu(Individual $individual): ?Menu
61    {
62        return new Menu(
63            $this->title(),
64            route('timeline', [
65                'xrefs[]' => $individual->xref(),
66                'ged'     => $individual->tree()->name(),
67            ]),
68            'menu-chart-timeline',
69            ['rel' => 'nofollow']
70        );
71    }
72
73    /**
74     * Return a menu item for this chart - for use in individual boxes.
75     *
76     * @param Individual $individual
77     *
78     * @return Menu|null
79     */
80    public function getBoxChartMenu(Individual $individual): ?Menu
81    {
82        return null;
83    }
84}
85