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 * Trait ModuleMenuTrait - default implementation of ModuleMenuInterface 27 */ 28trait ModuleMenuTrait 29{ 30 // The default position for this menu. It can be changed in the control panel. 31 protected int $menu_order; 32 33 /** 34 * Users change change the order of menus using the control panel. 35 * 36 * @param int $menu_order 37 * 38 * @return void 39 */ 40 public function setMenuOrder(int $menu_order): void 41 { 42 $this->menu_order = $menu_order; 43 } 44 45 /** 46 * Users change change the order of menus using the control panel. 47 * 48 * @return int 49 */ 50 public function getMenuOrder(): int 51 { 52 return $this->menu_order ?? $this->defaultMenuOrder(); 53 } 54 55 /** 56 * The default position for this menu. 57 * 58 * @return int 59 */ 60 public function defaultMenuOrder(): int 61 { 62 return 9999; 63 } 64 65 /** 66 * A menu, to be added to the main application menu. 67 * 68 * @param Tree $tree 69 * 70 * @return Menu|null 71 */ 72 public function getMenu(/** @scrutinizer ignore-unused */ Tree $tree): ?Menu 73 { 74 return null; 75 } 76} 77