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 18/** 19 * Interface ModuleTabInterface - Classes and libraries for module system 20 */ 21interface ModuleTabInterface { 22 /** 23 * The user can re-arrange the tab order, but until they do, this 24 * is the order in which tabs are shown. 25 * 26 * @return int 27 */ 28 public function defaultTabOrder(); 29 30 /** 31 * Generate the HTML content of this tab. 32 * 33 * @return string 34 */ 35 public function getTabContent(); 36 37 /** 38 * Is this tab empty? If so, we don't always need to display it. 39 * 40 * @return bool 41 */ 42 public function hasTabContent(); 43 44 /** 45 * Can this tab load asynchronously? 46 * 47 * @return bool 48 */ 49 public function canLoadAjax(); 50 51 /** 52 * Any content (e.g. Javascript) that needs to be rendered before the tabs. 53 * 54 * This function is probably not needed, as there are better ways to achieve this. 55 * 56 * @return string 57 */ 58 public function getPreLoadContent(); 59 60 /** 61 * A greyed out tab has no actual content, but may perhaps have 62 * options to create content. 63 * 64 * @return bool 65 */ 66 public function isGrayedOut(); 67} 68