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