1<?php 2/** 3 * webtrees: online genealogy 4 * Copyright (C) 2019 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\GedcomRecord; 21use Fisharebest\Webtrees\Menu; 22use Fisharebest\Webtrees\Tree; 23 24/** 25 * Interface ModuleMenuInterface - Classes and libraries for module system 26 */ 27interface ModuleMenuInterface 28{ 29 /** 30 * Users change change the order of menus using the control panel. 31 * 32 * @param int $menu_order 33 * 34 * @return void 35 */ 36 public function setMenuOrder(int $menu_order): void; 37 38 /** 39 * Users change change the order of menus using the control panel. 40 * 41 * @return int 42 */ 43 public function getMenuOrder(): int; 44 45 /** 46 * The default position for this menu. It can be changed in the control panel. 47 * 48 * @return int 49 */ 50 public function defaultMenuOrder(): int; 51 52 /** 53 * A menu, to be added to the main application menu. 54 * 55 * @param Tree $tree 56 * 57 * @return Menu|null 58 */ 59 public function getMenu(Tree $tree): ?Menu; 60} 61