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