1<?php 2/** 3 * webtrees: online genealogy 4 * Copyright (C) 2018 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 */ 16namespace Fisharebest\Webtrees\Module; 17 18use Fisharebest\Webtrees\Individual; 19 20/** 21 * Interface ModuleSidebarInterface - Classes and libraries for module system 22 */ 23interface ModuleSidebarInterface { 24 /** 25 * The user can change the order of sidebars. Until they do this, they are shown in this order. 26 * 27 * @return int 28 */ 29 public function defaultSidebarOrder(); 30 31 /** 32 * Load this sidebar synchronously. 33 * 34 * @param Individual $individual 35 * 36 * @return string 37 */ 38 public function getSidebarContent(Individual $individual); 39 40 /** 41 * Load this sidebar asynchronously. 42 * 43 * @return string 44 */ 45 public function getSidebarAjaxContent(); 46 47 /** 48 * Does this sidebar have anything to display for this individual? 49 * 50 * Individual $individual 51 * 52 * @return bool 53 */ 54 public function hasSidebarContent(Individual $individual); 55} 56