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