xref: /webtrees/app/Module/ModuleReportTrait.php (revision 89d880da80f202b08b9fe837f38a87b48c6d2a97)
1<?php
2/**
3 * webtrees: online genealogy
4 * Copyright (C) 2019 webtrees development team
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16declare(strict_types=1);
17
18namespace Fisharebest\Webtrees\Module;
19
20use Fisharebest\Webtrees\Individual;
21use Fisharebest\Webtrees\Menu;
22
23/**
24 * Trait ModuleReportTrait - default implementation of ModuleReportInterface
25 */
26trait ModuleReportTrait
27{
28    /**
29     * Name of the XML report file, relative to the resources folder.
30     *
31     * @return string
32     */
33    public function xmlFilename(): string
34    {
35        return 'xml/reports/' . $this->name() . '.xml';
36    }
37
38
39    /**
40     * Return a menu item for this report.
41     *
42     * @param Individual $individual
43     *
44     * @return Menu
45     */
46    public function getReportMenu(Individual $individual): Menu
47    {
48        return new Menu(
49            $this->title(),
50            route('report-setup', [
51                'xref'   => $individual->xref(),
52                'ged'    => $individual->tree()->name(),
53                'report' => $this->name(),
54            ]),
55            'menu-report-' . $this->name(),
56            ['rel' => 'nofollow']
57        );
58    }
59}
60