xref: /webtrees/app/Module/ModuleReportTrait.php (revision 4991f2057a6647447a648c5d6743dab00378e98e) 
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\Module;
21
22use Fisharebest\Webtrees\Http\RequestHandlers\ReportSetupPage;
23use Fisharebest\Webtrees\Individual;
24use Fisharebest\Webtrees\Menu;
25
26/**
27 * Trait ModuleReportTrait - default implementation of ModuleReportInterface
28 */
29trait ModuleReportTrait
30{
31    /**
32     * A unique internal name for this module (based on the installation folder).
33     *
34     * @return string
35     */
36    abstract public function name(): string;
37
38    /**
39     * How should this module be identified in the control panel, etc.?
40     *
41     * @return string
42     */
43    abstract public function title(): string;
44
45    /**
46     * Name of the XML report file, relative to the resources folder.
47     *
48     * @return string
49     */
50    public function xmlFilename(): string
51    {
52        return 'xml/reports/' . $this->name() . '.xml';
53    }
54
55
56    /**
57     * Return a menu item for this report.
58     *
59     * @param Individual $individual
60     *
61     * @return Menu
62     */
63    public function getReportMenu(Individual $individual): Menu
64    {
65        return new Menu(
66            $this->title(),
67            route(ReportSetupPage::class, [
68                'xref'   => $individual->xref(),
69                'tree'   => $individual->tree()->name(),
70                'report' => $this->name(),
71            ]),
72            'menu-report-' . $this->name(),
73            ['rel' => 'nofollow']
74        );
75    }
76}
77