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\Individual; 21use Illuminate\Support\Collection; 22 23/** 24 * Interface ModuleSidebarInterface - Classes and libraries for module system 25 */ 26interface ModuleSidebarInterface extends ModuleInterface 27{ 28 public function sidebarTitle(): string; 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 /** 40 * Users change change the order of sidebars using the control panel. 41 * 42 * @return int 43 */ 44 public function getSidebarOrder(): int; 45 46 /** 47 * The default position for this sidebar. It can be changed in the control panel. 48 * 49 * @return int 50 */ 51 public function defaultSidebarOrder(): int; 52 53 /** 54 * Sidebar content. 55 * 56 * @param Individual $individual 57 * 58 * @return string 59 */ 60 public function getSidebarContent(Individual $individual): string; 61 62 /** 63 * Does this sidebar have anything to display for this individual? 64 * 65 * @param Individual $individual 66 * 67 * @return bool 68 */ 69 public function hasSidebarContent(Individual $individual): bool; 70 /** 71 * This module handles the following facts - so don't show them on the "Facts and events" tab. 72 * 73 * @return Collection|string[] 74 */ 75 public function supportedFacts(): Collection; 76} 77