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