xref: /webtrees/app/Module/BranchesListModule.php (revision 15402b288d69d4ae5bddbb34c0c6cb26a98e90bd) 
1<?php
2/**
3 * webtrees: online genealogy
4 * Copyright (C) 2019 webtrees development team
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16declare(strict_types=1);
17
18namespace Fisharebest\Webtrees\Module;
19
20use Fisharebest\Webtrees\Contracts\UserInterface;
21use Fisharebest\Webtrees\Http\Controllers\BranchesController;
22use Fisharebest\Webtrees\I18N;
23use Fisharebest\Webtrees\Services\ModuleService;
24use Fisharebest\Webtrees\Tree;
25use Fisharebest\Webtrees\Auth;
26use Psr\Http\Message\ResponseInterface;
27use Psr\Http\Message\ServerRequestInterface;
28
29/**
30 * Class BranchesListModule
31 */
32class BranchesListModule extends AbstractModule implements ModuleListInterface
33{
34    use ModuleListTrait;
35
36    /**
37     * How should this module be identified in the control panel, etc.?
38     *
39     * @return string
40     */
41    public function title(): string
42    {
43        /* I18N: Name of a module/list */
44        return I18N::translate('Branches');
45    }
46
47    /**
48     * A sentence describing what this module does.
49     *
50     * @return string
51     */
52    public function description(): string
53    {
54        /* I18N: Description of the “BranchesListModule” module */
55        return I18N::translate('A list of branches of a family.');
56    }
57
58    /**
59     * CSS class for the URL.
60     *
61     * @return string
62     */
63    public function listMenuClass(): string
64    {
65        return 'menu-branches';
66    }
67
68    /**
69     * @param Tree  $tree
70     * @param array $parameters
71     *
72     * @return string
73     */
74    public function listUrl(Tree $tree, array $parameters = []): string
75    {
76        return route('module', [
77                'module' => $this->name(),
78                'action' => 'Page',
79                'ged'    => $tree->name(),
80        ] + $parameters);
81    }
82
83    /**
84     * @param ServerRequestInterface $request
85     * @param Tree                   $tree
86     * @param UserInterface          $user
87     *
88     * @return ResponseInterface
89     */
90    public function getPageAction(ServerRequestInterface $request, Tree $tree, UserInterface $user): ResponseInterface
91    {
92        Auth::checkComponentAccess($this, ModuleListInterface::class, $tree, $user);
93
94        $listController = new BranchesController(app(ModuleService::class));
95        return $listController->page($request);
96    }
97
98    /**
99     * @param ServerRequestInterface $request
100     * @param Tree                   $tree
101     * @param UserInterface          $user
102     *
103     * @return ResponseInterface
104     */
105    public function getListAction(ServerRequestInterface $request, Tree $tree, UserInterface $user): ResponseInterface
106    {
107        Auth::checkComponentAccess($this, ModuleListInterface::class, $tree, $user);
108
109        $listController = new BranchesController(app(ModuleService::class));
110        return $listController->list($request, $tree, $user);
111    }
112
113    /**
114     * @return string[]
115     */
116    public function listUrlAttributes(): array
117    {
118        return [];
119    }
120}
121