1<?php 2/** 3 * webtrees: online genealogy 4 * Copyright (C) 2018 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 */ 16namespace Fisharebest\Webtrees\Module; 17 18use Fisharebest\Webtrees\Auth; 19use Fisharebest\Webtrees\I18N; 20use Fisharebest\Webtrees\Menu; 21use Fisharebest\Webtrees\Tree; 22 23/** 24 * Class AhnentafelReportModule 25 */ 26class AhnentafelReportModule extends AbstractModule implements ModuleReportInterface { 27 /** 28 * How should this module be labelled on tabs, menus, etc.? 29 * 30 * @return string 31 */ 32 public function getTitle() { 33 // This text also appears in the .XML file - update both together 34 return /* I18N: Name of a module/report */ I18N::translate('Ancestors'); 35 } 36 37 /** 38 * A sentence describing what this module does. 39 * 40 * @return string 41 */ 42 public function getDescription() { 43 // This text also appears in the .XML file - update both together 44 return /* I18N: Description of the “Ancestors” module */ I18N::translate('A report of an individual’s ancestors, in a narrative style.'); 45 } 46 47 /** 48 * What is the default access level for this module? 49 * 50 * Some modules are aimed at admins or managers, and are not generally shown to users. 51 * 52 * @return int 53 */ 54 public function defaultAccessLevel() { 55 return Auth::PRIV_PRIVATE; 56 } 57 58 /** 59 * Return a menu item for this report. 60 * 61 * @param Tree $tree 62 * 63 * @return Menu 64 */ 65 public function getReportMenu(Tree $tree): Menu { 66 return new Menu( 67 $this->getTitle(), 68 route('report-setup', ['ged' => $tree->getName(), 'report' => $this->getName()]), 69 'menu-report-' . $this->getName(), 70 ['rel' => 'nofollow'] 71 ); 72 } 73} 74