xref: /webtrees/app/Module/IndividualFamiliesReportModule.php (revision e2b8114de32f4ac3319ef4ec97dceddeff185499) 
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\Auth;
21use Fisharebest\Webtrees\I18N;
22use Fisharebest\Webtrees\Individual;
23use Fisharebest\Webtrees\Menu;
24
25/**
26 * Class IndividualFamiliesReportModule
27 */
28class IndividualFamiliesReportModule extends AbstractModule implements ModuleInterface, ModuleReportInterface
29{
30    use ModuleReportTrait;
31
32    /** @var int The default access level for this module.  It can be changed in the control panel. */
33    protected $access_level = Auth::PRIV_USER;
34
35    /**
36     * How should this module be labelled on tabs, menus, etc.?
37     *
38     * @return string
39     */
40    public function title(): string
41    {
42        // This text also appears in the .XML file - update both together
43        /* I18N: Name of a module/report */
44        return I18N::translate('Related families');
45    }
46
47    /**
48     * A sentence describing what this module does.
49     *
50     * @return string
51     */
52    public function description(): string
53    {
54        // This text also appears in the .XML file - update both together
55        /* I18N: Description of the “Related families” */
56        return I18N::translate('A report of the families that are closely related to an individual.');
57    }
58
59    /**
60     * Return a menu item for this report.
61     *
62     * @param Individual $individual
63     *
64     * @return Menu
65     */
66    public function getReportMenu(Individual $individual): Menu
67    {
68        return new Menu(
69            $this->title(),
70            route('report-setup', [
71                'ged'    => $individual->tree()->name(),
72                'report' => $this->name(),
73            ]),
74            'menu-report-' . $this->name(),
75            ['rel' => 'nofollow']
76        );
77    }
78}
79