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