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