xref: /webtrees/app/Module/IndividualFamiliesReportModule.php (revision 8d018ab2fe3b6881cab8124d97e1a69e0be79d32)
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2023 webtrees development team
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <https://www.gnu.org/licenses/>.
16 */
17
18declare(strict_types=1);
19
20namespace Fisharebest\Webtrees\Module;
21
22use Fisharebest\Webtrees\Auth;
23use Fisharebest\Webtrees\I18N;
24
25/**
26 * Class IndividualFamiliesReportModule
27 */
28class IndividualFamiliesReportModule extends AbstractModule implements 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 int $access_level = Auth::PRIV_USER;
34
35    /**
36     * How should this module be identified in the control panel, 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