xref: /webtrees/app/Module/BirthDeathMarriageReportModule.php (revision d965cc1addf7b3da2d389764bd43a5a54958df6d) 
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 BirthDeathMarriageReportModule
26 */
27class BirthDeathMarriageReportModule extends AbstractModule implements ModuleReportInterface
28{
29    use ModuleReportTrait;
30
31    /**
32     * How should this module be identified in the control panel, etc.?
33     *
34     * @return string
35     */
36    public function title(): string
37    {
38        // This text also appears in the .XML file - update both together
39        /* I18N: Name of a module/report. “Vital records” are life events - birth/marriage/death */
40        return I18N::translate('Vital records');
41    }
42
43    /**
44     * A sentence describing what this module does.
45     *
46     * @return string
47     */
48    public function description(): string
49    {
50        // This text also appears in the .XML file - update both together
51        /* I18N: Description of the “Vital records” module. “Vital records” are life events - birth/marriage/death */
52        return I18N::translate('A report of vital records for a given date or place.');
53    }
54
55    /**
56     * Return a menu item for this report.
57     *
58     * @param Individual $individual
59     *
60     * @return Menu
61     */
62    public function getReportMenu(Individual $individual): Menu
63    {
64        return new Menu(
65            $this->title(),
66            route('report-setup', [
67                'ged'    => $individual->tree()->name(),
68                'report' => $this->name(),
69            ]),
70            'menu-report-' . $this->name(),
71            ['rel' => 'nofollow']
72        );
73    }
74}
75