xref: /webtrees/app/Module/FamilyListModule.php (revision 57ab22314b2599feb432b1a1ed71643cfc2f0452) 
1<?php
2/**
3 * webtrees: online genealogy
4 * Copyright (C) 2019 webtrees development team
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16declare(strict_types=1);
17
18namespace Fisharebest\Webtrees\Module;
19
20use Fisharebest\Webtrees\Http\Controllers\ListController;
21use Fisharebest\Webtrees\I18N;
22use Fisharebest\Webtrees\Services\IndividualListService;
23use Fisharebest\Webtrees\Services\LocalizationService;
24use Fisharebest\Webtrees\Auth;
25use Psr\Http\Message\ResponseInterface;
26use Psr\Http\Message\ServerRequestInterface;
27
28/**
29 * Class FamilyListModule
30 */
31class FamilyListModule extends AbstractModule implements ModuleListInterface
32{
33    use ModuleListTrait;
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 “FamilyListModule” 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 getListAction(ServerRequestInterface $request): ResponseInterface
73    {
74        $tree = $request->getAttribute('tree');
75        $user = $request->getAttribute('user');
76
77        Auth::checkComponentAccess($this, ModuleListInterface::class, $tree, $user);
78
79        $listController = new ListController(app(IndividualListService::class), app(LocalizationService::class));
80        return $listController->familyList($request, $this);
81    }
82
83    /**
84     * @return string[]
85     */
86    public function listUrlAttributes(): array
87    {
88        return [];
89    }
90}
91