1<?php 2namespace Webtrees; 3 4/** 5 * webtrees: online genealogy 6 * Copyright (C) 2015 webtrees development team 7 * This program is free software: you can redistribute it and/or modify 8 * it under the terms of the GNU General Public License as published by 9 * the Free Software Foundation, either version 3 of the License, or 10 * (at your option) any later version. 11 * This program is distributed in the hope that it will be useful, 12 * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 * GNU General Public License for more details. 15 * You should have received a copy of the GNU General Public License 16 * along with this program. If not, see <http://www.gnu.org/licenses/>. 17 */ 18 19/** 20 * Interface ModuleTabInterface - Classes and libraries for module system 21 */ 22interface ModuleTabInterface { 23 /** 24 * The user can re-arrange the tab order, but until they do, this 25 * is the order in which tabs are shown. 26 * 27 * @return integer 28 */ 29 public function defaultTabOrder(); 30 31 /** 32 * Generate the HTML content of this tab. 33 * 34 * @return string 35 */ 36 public function getTabContent(); 37 38 /** 39 * Is this tab empty? If so, we don't always need to display it. 40 * @return boolean 41 */ 42 public function hasTabContent(); 43 44 /** 45 * Can this tab load asynchronously? 46 * 47 * @return boolean 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 boolean 65 */ 66 public function isGrayedOut(); 67} 68