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