xref: /webtrees/app/Module/FamilyListModule.php (revision 9f9acdbc09170c04c1e150c36ee57d49027e314a) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2020 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\Auth;
23use Fisharebest\Webtrees\Contracts\UserInterface;
24use Fisharebest\Webtrees\I18N;
25use Fisharebest\Webtrees\Tree;
26use Psr\Http\Message\ResponseInterface;
27use Psr\Http\Message\ServerRequestInterface;
28
29use function assert;
30
31/**
32 * Class FamilyListModule
33 */
34class FamilyListModule extends IndividualListModule
35{
36    protected const ROUTE_URL = '/tree/{tree}/family-list';
37
38    /**
39     * How should this module be identified in the control panel, etc.?
40     *
41     * @return string
42     */
43    public function title(): string
44    {
45        /* I18N: Name of a module/list */
46        return I18N::translate('Families');
47    }
48
49    /**
50     * A sentence describing what this module does.
51     *
52     * @return string
53     */
54    public function description(): string
55    {
56        /* I18N: Description of the “Families” module */
57        return I18N::translate('A list of families.');
58    }
59
60    /**
61     * CSS class for the URL.
62     *
63     * @return string
64     */
65    public function listMenuClass(): string
66    {
67        return 'menu-list-fam';
68    }
69
70    /**
71     * @param ServerRequestInterface $request
72     *
73     * @return ResponseInterface
74     */
75    public function handle(ServerRequestInterface $request): ResponseInterface
76    {
77        $tree = $request->getAttribute('tree');
78        assert($tree instanceof Tree);
79
80        $user = $request->getAttribute('user');
81        assert($user instanceof UserInterface);
82
83        Auth::checkComponentAccess($this, ModuleListInterface::class, $tree, $user);
84
85        return $this->createResponse($tree, $user, $request->getQueryParams(), true);
86    }
87}
88