xref: /webtrees/app/Module/IndividualReportModule.php (revision 895230eed7521b5cd885b90d4f5310405ff0b69a) 
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 IndividualReportModule
26 */
27class IndividualReportModule extends AbstractModule implements ModuleInterface, ModuleReportInterface
28{
29    use ModuleReportTrait;
30
31    /** {@inheritdoc} */
32    public function title(): string
33    {
34        // This text also appears in the .XML file - update both together
35        /* I18N: Name of a module/report */
36        return I18N::translate('Individual');
37    }
38
39    /** {@inheritdoc} */
40    public function description(): string
41    {
42        // This text also appears in the .XML file - update both together
43        /* I18N: Description of the “Individual” module */
44        return I18N::translate('A report of an individual’s details.');
45    }
46
47    /**
48     * Return a menu item for this report.
49     *
50     * @param Individual $individual
51     *
52     * @return Menu
53     */
54    public function getReportMenu(Individual $individual): Menu
55    {
56        return new Menu(
57            $this->title(),
58            route('report-setup', [
59                'xref'   => $individual->xref(),
60                'ged'    => $individual->tree()->name(),
61                'report' => $this->getName(),
62            ]),
63            'menu-report-' . $this->getName(),
64            ['rel' => 'nofollow']
65        );
66    }
67}
68