xref: /webtrees/app/Module/PlaceHierarchyListModule.php (revision 1a218474113038005e50986fff24ebcbd58554ff) 
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;
28
29use function assert;
30
31/**
32 * Class IndividualListModule
33 */
34class PlaceHierarchyListModule extends AbstractModule implements ModuleListInterface
35{
36    use ModuleListTrait;
37
38    /**
39     * How should this module be identified in the control panel, etc.?
40     *
41     * @return string
42     */
43    public function title(): string
44    {
45        /* I18N: Name of a module/list */
46        return I18N::translate('Place hierarchy');
47    }
48
49    /**
50     * A sentence describing what this module does.
51     *
52     * @return string
53     */
54    public function description(): string
55    {
56        /* I18N: Description of the “PlaceHierarchyListModule” module */
57        return I18N::translate('The place hierarchy.');
58    }
59
60    /**
61     * CSS class for the URL.
62     *
63     * @return string
64     */
65    public function listMenuClass(): string
66    {
67        return 'menu-list-plac';
68    }
69
70    /**
71     * @param ServerRequestInterface $request
72     *
73     * @return ResponseInterface
74     */
75    public function getListAction(ServerRequestInterface $request): ResponseInterface
76    {
77        $tree = $request->getAttribute('tree');
78        assert($tree instanceof Tree, new InvalidArgumentException());
79
80        $user = $request->getAttribute('user');
81
82        Auth::checkComponentAccess($this, ModuleListInterface::class, $tree, $user);
83
84        return app(PlaceHierarchyController::class)->show($request);
85    }
86
87    /**
88     * @return string[]
89     */
90    public function listUrlAttributes(): array
91    {
92        return [];
93    }
94}
95