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