xref: /webtrees/app/Module/IndividualFamiliesReportModule.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\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    /** {@inheritdoc} */
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 */
40        return I18N::translate('Related families');
41    }
42
43    /** {@inheritdoc} */
44    public function description(): string
45    {
46        // This text also appears in the .XML file - update both together
47        /* I18N: Description of the “Related families” */
48        return I18N::translate('A report of the families that are closely related to an individual.');
49    }
50
51    /**
52     * Return a menu item for this report.
53     *
54     * @param Individual $individual
55     *
56     * @return Menu
57     */
58    public function getReportMenu(Individual $individual): Menu
59    {
60        return new Menu(
61            $this->title(),
62            route('report-setup', [
63                'ged'    => $individual->tree()->name(),
64                'report' => $this->getName(),
65            ]),
66            'menu-report-' . $this->getName(),
67            ['rel' => 'nofollow']
68        );
69    }
70}
71