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