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