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