xref: /webtrees/app/Http/RequestHandlers/ReportListPage.php (revision 17c6a11dd0f7d834aa76b1703185adf9cae1b8a9) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2021 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 <https://www.gnu.org/licenses/>.
16 */
17
18declare(strict_types=1);
19
20namespace Fisharebest\Webtrees\Http\RequestHandlers;
21
22use Fisharebest\Webtrees\Contracts\UserInterface;
23use Fisharebest\Webtrees\Http\ViewResponseTrait;
24use Fisharebest\Webtrees\I18N;
25use Fisharebest\Webtrees\Module\ModuleReportInterface;
26use Fisharebest\Webtrees\Services\ModuleService;
27use Fisharebest\Webtrees\Tree;
28use Psr\Http\Message\ResponseInterface;
29use Psr\Http\Message\ServerRequestInterface;
30use Psr\Http\Server\RequestHandlerInterface;
31
32use function assert;
33
34/**
35 * Show all available reports.
36 */
37class ReportListPage implements RequestHandlerInterface
38{
39    use ViewResponseTrait;
40
41    private ModuleService $module_service;
42
43    /**
44     * ReportEngineController constructor.
45     *
46     * @param ModuleService $module_service
47     */
48    public function __construct(ModuleService $module_service)
49    {
50        $this->module_service = $module_service;
51    }
52
53    /**
54     * A list of available reports.
55     *
56     * @param ServerRequestInterface $request
57     *
58     * @return ResponseInterface
59     */
60    public function handle(ServerRequestInterface $request): ResponseInterface
61    {
62        $tree = $request->getAttribute('tree');
63        assert($tree instanceof Tree);
64
65        $user = $request->getAttribute('user');
66        assert($user instanceof UserInterface);
67
68        $reports = $this->module_service
69            ->findByComponent(ModuleReportInterface::class, $tree, $user);
70
71        $title = I18N::translate('Choose a report to run');
72
73        return $this->viewResponse('report-select-page', [
74            'reports' => $reports,
75            'title'   => $title,
76            'tree'    => $tree,
77        ]);
78    }
79}
80