xref: /webtrees/app/Module/ModuleReportTrait.php (revision fcfa147e10aaa6c7ff580c29bd6e5b88666befc1)
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\Module;
21
22use Fisharebest\Webtrees\Individual;
23use Fisharebest\Webtrees\Menu;
24
25/**
26 * Trait ModuleReportTrait - default implementation of ModuleReportInterface
27 */
28trait ModuleReportTrait
29{
30    /**
31     * @return string
32     */
33    abstract public function name(): string;
34
35    /**
36     * Name of the XML report file, relative to the resources folder.
37     *
38     * @return string
39     */
40    public function xmlFilename(): string
41    {
42        return 'xml/reports/' . $this->name() . '.xml';
43    }
44
45
46    /**
47     * Return a menu item for this report.
48     *
49     * @param Individual $individual
50     *
51     * @return Menu
52     */
53    public function getReportMenu(Individual $individual): Menu
54    {
55        return new Menu(
56            $this->title(),
57            route('report-setup', [
58                'xref'   => $individual->xref(),
59                'tree'   => $individual->tree()->name(),
60                'report' => $this->name(),
61            ]),
62            'menu-report-' . $this->name(),
63            ['rel' => 'nofollow']
64        );
65    }
66}
67