xref: /webtrees/app/Module/PlaceHierarchyListModule.php (revision 5229eade2a8cdd1381e19f96f67fc1c8b92ca95d) 
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 */
17declare(strict_types=1);
18
19namespace Fisharebest\Webtrees\Module;
20
21use Fisharebest\Webtrees\Auth;
22use Fisharebest\Webtrees\Http\Controllers\PlaceHierarchyController;
23use Fisharebest\Webtrees\I18N;
24use Fisharebest\Webtrees\Tree;
25use InvalidArgumentException;
26use Psr\Http\Message\ResponseInterface;
27use Psr\Http\Message\ServerRequestInterface;
28use function assert;
29
30/**
31 * Class IndividualListModule
32 */
33class PlaceHierarchyListModule 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('Place hierarchy');
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 “PlaceHierarchyListModule” module */
56        return I18N::translate('The place hierarchy.');
57    }
58
59    /**
60     * CSS class for the URL.
61     *
62     * @return string
63     */
64    public function listMenuClass(): string
65    {
66        return 'menu-list-plac';
67    }
68
69    /**
70     * @param ServerRequestInterface $request
71     *
72     * @return ResponseInterface
73     */
74    public function getListAction(ServerRequestInterface $request): ResponseInterface
75    {
76        $tree = $request->getAttribute('tree');
77        assert($tree instanceof Tree, new InvalidArgumentException());
78
79        $user = $request->getAttribute('user');
80
81        Auth::checkComponentAccess($this, ModuleListInterface::class, $tree, $user);
82
83        return app(PlaceHierarchyController::class)->show($request);
84    }
85
86    /**
87     * @return string[]
88     */
89    public function listUrlAttributes(): array
90    {
91        return [];
92    }
93}
94