xref: /webtrees/app/Module/BranchesListModule.php (revision 71378461661e7642e52abe7d41c9cfffb3e5369b) 
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\Http\Controllers\BranchesController;
22use Fisharebest\Webtrees\Http\RequestHandlers\ModuleAction;
23use Fisharebest\Webtrees\I18N;
24use Fisharebest\Webtrees\Services\ModuleService;
25use Fisharebest\Webtrees\Tree;
26use Fisharebest\Webtrees\Auth;
27use Psr\Http\Message\ResponseInterface;
28use Psr\Http\Message\ServerRequestInterface;
29
30/**
31 * Class BranchesListModule
32 */
33class BranchesListModule 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('Branches');
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 “BranchesListModule” module */
56        return I18N::translate('A list of branches of a family.');
57    }
58
59    /**
60     * CSS class for the URL.
61     *
62     * @return string
63     */
64    public function listMenuClass(): string
65    {
66        return 'menu-branches';
67    }
68
69    /**
70     * @param Tree  $tree
71     * @param array $parameters
72     *
73     * @return string
74     */
75    public function listUrl(Tree $tree, array $parameters = []): string
76    {
77        return route('module', [
78                'module' => $this->name(),
79                'action' => 'Page',
80                'ged'    => $tree->name(),
81        ] + $parameters);
82    }
83
84    /**
85     * @param ServerRequestInterface $request
86     *
87     * @return ResponseInterface
88     */
89    public function getPageAction(ServerRequestInterface $request): ResponseInterface
90    {
91        $tree = $request->getAttribute('tree');
92        $user = $request->getAttribute('user');
93
94        Auth::checkComponentAccess($this, ModuleListInterface::class, $tree, $user);
95
96        $listController = new BranchesController(app(ModuleService::class));
97        return $listController->page($request);
98    }
99
100    /**
101     * @param ServerRequestInterface $request
102     *
103     * @return ResponseInterface
104     */
105    public function getListAction(ServerRequestInterface $request): ResponseInterface
106    {
107        $tree = $request->getAttribute('tree');
108        $user = $request->getAttribute('user');
109
110        Auth::checkComponentAccess($this, ModuleListInterface::class, $tree, $user);
111
112        return app(BranchesController::class)->list($request);
113    }
114
115    /**
116     * @return string[]
117     */
118    public function listUrlAttributes(): array
119    {
120        return [];
121    }
122}
123