xref: /webtrees/app/Module/FamilyListModule.php (revision b5e8e56bec7bb707a6a32677d4a3d121432ce517) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2019 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\Http\Controllers\ListController;
23use Fisharebest\Webtrees\I18N;
24use Fisharebest\Webtrees\Services\IndividualListService;
25use Fisharebest\Webtrees\Services\LocalizationService;
26use Fisharebest\Webtrees\Auth;
27use Fisharebest\Webtrees\Tree;
28use Psr\Http\Message\ResponseInterface;
29use Psr\Http\Message\ServerRequestInterface;
30
31use function assert;
32
33/**
34 * Class FamilyListModule
35 */
36class FamilyListModule extends AbstractModule implements ModuleListInterface
37{
38    use ModuleListTrait;
39
40    /**
41     * How should this module be identified in the control panel, etc.?
42     *
43     * @return string
44     */
45    public function title(): string
46    {
47        /* I18N: Name of a module/list */
48        return I18N::translate('Families');
49    }
50
51    /**
52     * A sentence describing what this module does.
53     *
54     * @return string
55     */
56    public function description(): string
57    {
58        /* I18N: Description of the “Families” module */
59        return I18N::translate('A list of families.');
60    }
61
62    /**
63     * CSS class for the URL.
64     *
65     * @return string
66     */
67    public function listMenuClass(): string
68    {
69        return 'menu-list-fam';
70    }
71
72    /**
73     * @param ServerRequestInterface $request
74     *
75     * @return ResponseInterface
76     */
77    public function getListAction(ServerRequestInterface $request): ResponseInterface
78    {
79        $tree = $request->getAttribute('tree');
80        assert($tree instanceof Tree);
81
82        $user = $request->getAttribute('user');
83
84        Auth::checkComponentAccess($this, ModuleListInterface::class, $tree, $user);
85
86        $listController = new ListController(app(IndividualListService::class), app(LocalizationService::class));
87        return $listController->familyList($request, $this);
88    }
89
90    /**
91     * @return string[]
92     */
93    public function listUrlAttributes(): array
94    {
95        return [];
96    }
97}
98