xref: /webtrees/app/Module/FamilyListModule.php (revision 1270d2767576ed4a83917769b0ee3613e3b010bf)
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\I18N;
23
24class FamilyListModule extends IndividualListModule
25{
26    public function title(): string
27    {
28        /* I18N: Name of a module/list */
29        return I18N::translate('Families');
30    }
31
32    public function description(): string
33    {
34        /* I18N: Description of the “Families” module */
35        return I18N::translate('A list of families.');
36    }
37
38    public function listMenuClass(): string
39    {
40        return 'menu-list-fam';
41    }
42
43    protected function showFamilies(): bool
44    {
45        return true;
46    }
47
48    protected function routeUrl(): string
49    {
50        return '/tree/{tree}/family-list';
51    }
52}
53