xref: /webtrees/app/Module/IndividualFamiliesReportModule.php (revision 3976b4703df669696105ed6b024b96d433c8fbdb)
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2019 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 <http://www.gnu.org/licenses/>.
16 */
17declare(strict_types=1);
18
19namespace Fisharebest\Webtrees\Module;
20
21use Fisharebest\Webtrees\Auth;
22use Fisharebest\Webtrees\I18N;
23
24/**
25 * Class IndividualFamiliesReportModule
26 */
27class IndividualFamiliesReportModule extends AbstractModule implements ModuleReportInterface
28{
29    use ModuleReportTrait;
30
31    /** @var int The default access level for this module.  It can be changed in the control panel. */
32    protected $access_level = Auth::PRIV_USER;
33
34    /**
35     * How should this module be identified in the control panel, etc.?
36     *
37     * @return string
38     */
39    public function title(): string
40    {
41        // This text also appears in the .XML file - update both together
42        /* I18N: Name of a module/report */
43        return I18N::translate('Related families');
44    }
45
46    /**
47     * A sentence describing what this module does.
48     *
49     * @return string
50     */
51    public function description(): string
52    {
53        // This text also appears in the .XML file - update both together
54        /* I18N: Description of the “Related families” */
55        return I18N::translate('A report of the families that are closely related to an individual.');
56    }
57}
58