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 Illuminate\Support\Collection; 21 22/** 23 * Trait ModuleSidebarTrait - default implementation of ModuleSidebarInterface 24 */ 25trait ModuleSidebarTrait 26{ 27 /** @var int The default position for this sidebar. It can be changed in the control panel. */ 28 protected $sidebar_order = 0; 29 30 /** 31 * Users change change the order of sidebars using the control panel. 32 * 33 * @param int $sidebar_order 34 * 35 * @return void 36 */ 37 public function setSidebarOrder(int $sidebar_order): void 38 { 39 $this->sidebar_order = $sidebar_order; 40 } 41 42 /** 43 * Users change change the order of sidebars using the control panel. 44 * 45 * @return int 46 */ 47 public function getSidebarOrder(): int 48 { 49 return $this->sidebar_order ?? $this->defaultSidebarOrder(); 50 } 51 52 53 /** 54 * The default position for this sdiebar. 55 * 56 * @return int 57 */ 58 public function defaultSidebarOrder(): int 59 { 60 return 9999; 61 } 62 63 /** 64 * This module handles the following facts - so don't show them on the "Facts and events" tab. 65 * 66 * @return Collection|string[] 67 */ 68 public function supportedFacts(): Collection 69 { 70 return new Collection([]); 71 } 72} 73