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