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; 21 22/** 23 * Interface ModuleSidebarInterface - Classes and libraries for module system 24 */ 25interface ModuleSidebarInterface extends ModuleInterface 26{ 27 /** 28 * Users change change the order of sidebars using the control panel. 29 * 30 * @param int $sidebar_order 31 * 32 * @return void 33 */ 34 public function setSidebarOrder(int $sidebar_order): void; 35 36 /** 37 * Users change change the order of sidebars using the control panel. 38 * 39 * @return int 40 */ 41 public function getSidebarOrder(): int; 42 43 /** 44 * The default position for this sidebar. It can be changed in the control panel. 45 * 46 * @return int 47 */ 48 public function defaultSidebarOrder(): int; 49 50 /** 51 * Sidebar content. 52 * 53 * @param Individual $individual 54 * 55 * @return string 56 */ 57 public function getSidebarContent(Individual $individual): string; 58 59 /** 60 * Does this sidebar have anything to display for this individual? 61 * 62 * @param Individual $individual 63 * 64 * @return bool 65 */ 66 public function hasSidebarContent(Individual $individual): bool; 67} 68