xref: /webtrees/app/Module/IndividualFamiliesReportModule.php (revision e7f56f2af615447ab1a7646851f88b465ace9e04) 
1<?php
2/**
3 * webtrees: online genealogy
4 * Copyright (C) 2018 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\Menu;
23use Fisharebest\Webtrees\Tree;
24
25/**
26 * Class IndividualFamiliesReportModule
27 */
28class IndividualFamiliesReportModule extends AbstractModule implements ModuleReportInterface
29{
30    /** {@inheritdoc} */
31    public function getTitle(): string
32    {
33        // This text also appears in the .XML file - update both together
34        /* I18N: Name of a module/report */
35        return I18N::translate('Related families');
36    }
37
38    /** {@inheritdoc} */
39    public function getDescription(): string
40    {
41        // This text also appears in the .XML file - update both together
42        /* I18N: Description of the “Related families” */
43        return I18N::translate('A report of the families that are closely related to an individual.');
44    }
45
46    /**
47     * What is the default access level for this module?
48     *
49     * Some modules are aimed at admins or managers, and are not generally shown to users.
50     *
51     * @return int
52     */
53    public function defaultAccessLevel(): int
54    {
55        return Auth::PRIV_USER;
56    }
57
58    /**
59     * Return a menu item for this report.
60     *
61     * @param Tree $tree
62     *
63     * @return Menu
64     */
65    public function getReportMenu(Tree $tree): Menu
66    {
67        return new Menu(
68            $this->getTitle(),
69            route('report-setup', ['ged'    => $tree->getName(),
70                                   'report' => $this->getName(),
71            ]),
72            'menu-report-' . $this->getName(),
73            ['rel' => 'nofollow']
74        );
75    }
76}
77