xref: /webtrees/app/Module/FamilyListModule.php (revision 96d794e780958996ac6963fb1b7159a9750f2e1e) 
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\Contracts\UserInterface;
21use Fisharebest\Webtrees\Http\Controllers\ListController;
22use Fisharebest\Webtrees\I18N;
23use Fisharebest\Webtrees\Services\IndividualListService;
24use Fisharebest\Webtrees\Services\LocalizationService;
25use Fisharebest\Webtrees\Tree;
26use Fisharebest\Webtrees\Auth;
27use Psr\Http\Message\ResponseInterface;
28use Psr\Http\Message\ServerRequestInterface;
29
30/**
31 * Class FamilyListModule
32 */
33class FamilyListModule extends AbstractModule implements ModuleListInterface
34{
35    use ModuleListTrait;
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 “FamilyListModule” 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     * @param Tree                   $tree
72     * @param UserInterface          $user
73     *
74     * @return ResponseInterface
75     */
76    public function getListAction(ServerRequestInterface $request, Tree $tree, UserInterface $user): ResponseInterface
77    {
78        Auth::checkComponentAccess($this, ModuleListInterface::class, $tree, $user);
79
80        $listController = new ListController(app(IndividualListService::class), app(LocalizationService::class));
81        return $listController->familyList($request, $tree, $user, $this);
82    }
83
84    /**
85     * @return string[]
86     */
87    public function listUrlAttributes(): array
88    {
89        return [];
90    }
91}
92