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 */ 16declare(strict_types=1); 17 18namespace Fisharebest\Webtrees\Module; 19 20use Fisharebest\Webtrees\Auth; 21use Fisharebest\Webtrees\I18N; 22use Fisharebest\Webtrees\Menu; 23use Fisharebest\Webtrees\Tree; 24 25/** 26 * Class BirthDeathMarriageReportModule 27 */ 28class BirthDeathMarriageReportModule extends AbstractModule implements ModuleReportInterface 29{ 30 /** 31 * How should this module be labelled on tabs, menus, etc.? 32 * 33 * @return string 34 */ 35 public function getTitle(): string 36 { 37 // This text also appears in the .XML file - update both together 38 /* I18N: Name of a module/report. “Vital records” are life events - birth/marriage/death */ 39 return I18N::translate('Vital records'); 40 } 41 42 /** 43 * A sentence describing what this module does. 44 * 45 * @return string 46 */ 47 public function getDescription(): string 48 { 49 // This text also appears in the .XML file - update both together 50 /* I18N: Description of the “Vital records” module. “Vital records” are life events - birth/marriage/death */ 51 return I18N::translate('A report of vital records for a given date or place.'); 52 } 53 54 /** 55 * What is the default access level for this module? 56 * 57 * Some modules are aimed at admins or managers, and are not generally shown to users. 58 * 59 * @return int 60 */ 61 public function defaultAccessLevel(): int 62 { 63 return Auth::PRIV_PRIVATE; 64 } 65 66 /** 67 * Return a menu item for this report. 68 * 69 * @param Tree $tree 70 * 71 * @return Menu 72 */ 73 public function getReportMenu(Tree $tree): Menu 74 { 75 return new Menu( 76 $this->getTitle(), 77 route('report-setup', ['ged' => $tree->name(), 78 'report' => $this->getName(), 79 ]), 80 'menu-report-' . $this->getName(), 81 ['rel' => 'nofollow'] 82 ); 83 } 84} 85