xref: /webtrees/app/Module/ModuleReportTrait.php (revision 6f68916103931ce3f715eba5c6f55acf120c084e)
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\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     * Name of the XML report file, relative to the resources folder.
33     *
34     * @return string
35     */
36    public function xmlFilename(): string
37    {
38        return 'xml/reports/' . $this->name() . '.xml';
39    }
40
41
42    /**
43     * Return a menu item for this report.
44     *
45     * @param Individual $individual
46     *
47     * @return Menu
48     */
49    public function getReportMenu(Individual $individual): Menu
50    {
51        return new Menu(
52            $this->title(),
53            route(ReportSetupPage::class, [
54                'xref'   => $individual->xref(),
55                'tree'   => $individual->tree()->name(),
56                'report' => $this->name(),
57            ]),
58            'menu-report-' . $this->name(),
59            ['rel' => 'nofollow']
60        );
61    }
62}
63