xref: /webtrees/app/Module/BranchesListModule.php (revision 3df1e584fbd868b51c2f8559129ab0652c3acaa3) 
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 */
17
18declare(strict_types=1);
19
20namespace Fisharebest\Webtrees\Module;
21
22use Fisharebest\Webtrees\Http\Controllers\BranchesController;
23use Fisharebest\Webtrees\I18N;
24use Fisharebest\Webtrees\Services\ModuleService;
25use Fisharebest\Webtrees\Tree;
26use Fisharebest\Webtrees\Auth;
27use InvalidArgumentException;
28use Psr\Http\Message\ResponseInterface;
29use Psr\Http\Message\ServerRequestInterface;
30
31use function assert;
32
33/**
34 * Class BranchesListModule
35 */
36class BranchesListModule extends AbstractModule implements ModuleListInterface
37{
38    use ModuleListTrait;
39
40    /**
41     * How should this module be identified in the control panel, etc.?
42     *
43     * @return string
44     */
45    public function title(): string
46    {
47        /* I18N: Name of a module/list */
48        return I18N::translate('Branches');
49    }
50
51    /**
52     * A sentence describing what this module does.
53     *
54     * @return string
55     */
56    public function description(): string
57    {
58        /* I18N: Description of the “BranchesListModule” module */
59        return I18N::translate('A list of branches of a family.');
60    }
61
62    /**
63     * CSS class for the URL.
64     *
65     * @return string
66     */
67    public function listMenuClass(): string
68    {
69        return 'menu-branches';
70    }
71
72    /**
73     * @param Tree    $tree
74     * @param mixed[] $parameters
75     *
76     * @return string
77     */
78    public function listUrl(Tree $tree, array $parameters = []): string
79    {
80        return route('module', [
81                'module' => $this->name(),
82                'action' => 'Page',
83                'tree'    => $tree->name(),
84        ] + $parameters);
85    }
86
87    /**
88     * @param ServerRequestInterface $request
89     *
90     * @return ResponseInterface
91     */
92    public function getPageAction(ServerRequestInterface $request): ResponseInterface
93    {
94        $tree = $request->getAttribute('tree');
95        assert($tree instanceof Tree, new InvalidArgumentException());
96
97        $user = $request->getAttribute('user');
98
99        Auth::checkComponentAccess($this, ModuleListInterface::class, $tree, $user);
100
101        $listController = new BranchesController(app(ModuleService::class));
102        return $listController->page($request);
103    }
104
105    /**
106     * @param ServerRequestInterface $request
107     *
108     * @return ResponseInterface
109     */
110    public function getListAction(ServerRequestInterface $request): ResponseInterface
111    {
112        $tree = $request->getAttribute('tree');
113        assert($tree instanceof Tree, new InvalidArgumentException());
114
115        $user = $request->getAttribute('user');
116
117        Auth::checkComponentAccess($this, ModuleListInterface::class, $tree, $user);
118
119        return app(BranchesController::class)->list($request);
120    }
121
122    /**
123     * @return string[]
124     */
125    public function listUrlAttributes(): array
126    {
127        return [];
128    }
129}
130