xref: /webtrees/app/Http/RequestHandlers/ReportListPage.php (revision 7ef421a4290b6b468944b845497d6139b0eddd3f) 
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\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    /**
42     * @var ModuleService
43     */
44    private $module_service;
45
46    /**
47     * ReportEngineController constructor.
48     *
49     * @param ModuleService $module_service
50     */
51    public function __construct(ModuleService $module_service)
52    {
53        $this->module_service = $module_service;
54    }
55
56    /**
57     * A list of available reports.
58     *
59     * @param ServerRequestInterface $request
60     *
61     * @return ResponseInterface
62     */
63    public function handle(ServerRequestInterface $request): ResponseInterface
64    {
65        $tree = $request->getAttribute('tree');
66        assert($tree instanceof Tree);
67
68        $user = $request->getAttribute('user');
69        assert($user instanceof UserInterface);
70
71        $reports = $this->module_service
72            ->findByComponent(ModuleReportInterface::class, $tree, $user);
73
74        $title = I18N::translate('Choose a report to run');
75
76        return $this->viewResponse('report-select-page', [
77            'reports' => $reports,
78            'title'   => $title,
79            'tree'    => $tree,
80        ]);
81    }
82}
83