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