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