xref: /webtrees/app/Module/FamilyListModule.php (revision 59597b37d69e8147c3f4a27643e9c8edaa2a0592) 
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 */
17
18declare(strict_types=1);
19
20namespace Fisharebest\Webtrees\Module;
21
22use Fisharebest\Webtrees\Http\Controllers\ListController;
23use Fisharebest\Webtrees\I18N;
24use Fisharebest\Webtrees\Services\IndividualListService;
25use Fisharebest\Webtrees\Services\LocalizationService;
26use Fisharebest\Webtrees\Auth;
27use Fisharebest\Webtrees\Tree;
28use InvalidArgumentException;
29use Psr\Http\Message\ResponseInterface;
30use Psr\Http\Message\ServerRequestInterface;
31
32use function assert;
33
34/**
35 * Class FamilyListModule
36 */
37class FamilyListModule extends AbstractModule implements ModuleListInterface
38{
39    use ModuleListTrait;
40
41    /**
42     * How should this module be identified in the control panel, etc.?
43     *
44     * @return string
45     */
46    public function title(): string
47    {
48        /* I18N: Name of a module/list */
49        return I18N::translate('Families');
50    }
51
52    /**
53     * A sentence describing what this module does.
54     *
55     * @return string
56     */
57    public function description(): string
58    {
59        /* I18N: Description of the “FamilyListModule” module */
60        return I18N::translate('A list of families.');
61    }
62
63    /**
64     * CSS class for the URL.
65     *
66     * @return string
67     */
68    public function listMenuClass(): string
69    {
70        return 'menu-list-fam';
71    }
72
73    /**
74     * @param ServerRequestInterface $request
75     *
76     * @return ResponseInterface
77     */
78    public function getListAction(ServerRequestInterface $request): ResponseInterface
79    {
80        $tree = $request->getAttribute('tree');
81        assert($tree instanceof Tree, new InvalidArgumentException());
82
83        $user = $request->getAttribute('user');
84
85        Auth::checkComponentAccess($this, ModuleListInterface::class, $tree, $user);
86
87        $listController = new ListController(app(IndividualListService::class), app(LocalizationService::class));
88        return $listController->familyList($request, $this);
89    }
90
91    /**
92     * @return string[]
93     */
94    public function listUrlAttributes(): array
95    {
96        return [];
97    }
98}
99