1a25f0a04SGreg Roach<?php 2a25f0a04SGreg Roach/** 3a25f0a04SGreg Roach * webtrees: online genealogy 4*1062a142SGreg Roach * Copyright (C) 2018 webtrees development team 5a25f0a04SGreg Roach * This program is free software: you can redistribute it and/or modify 6a25f0a04SGreg Roach * it under the terms of the GNU General Public License as published by 7a25f0a04SGreg Roach * the Free Software Foundation, either version 3 of the License, or 8a25f0a04SGreg Roach * (at your option) any later version. 9a25f0a04SGreg Roach * This program is distributed in the hope that it will be useful, 10a25f0a04SGreg Roach * but WITHOUT ANY WARRANTY; without even the implied warranty of 11a25f0a04SGreg Roach * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12a25f0a04SGreg Roach * GNU General Public License for more details. 13a25f0a04SGreg Roach * You should have received a copy of the GNU General Public License 14a25f0a04SGreg Roach * along with this program. If not, see <http://www.gnu.org/licenses/>. 15a25f0a04SGreg Roach */ 1676692c8bSGreg Roachnamespace Fisharebest\Webtrees\Module; 17a25f0a04SGreg Roach 18a25f0a04SGreg Roach/** 19a25f0a04SGreg Roach * Interface ModuleSidebarInterface - Classes and libraries for module system 20a25f0a04SGreg Roach */ 21a25f0a04SGreg Roachinterface ModuleSidebarInterface { 22a25f0a04SGreg Roach /** 23a25f0a04SGreg Roach * The user can change the order of sidebars. Until they do this, they are shown in this order. 24a25f0a04SGreg Roach * 25cbc1590aSGreg Roach * @return int 26a25f0a04SGreg Roach */ 27a25f0a04SGreg Roach public function defaultSidebarOrder(); 28a25f0a04SGreg Roach 29a25f0a04SGreg Roach /** 30a25f0a04SGreg Roach * Load this sidebar synchronously. 31cbc1590aSGreg Roach * 32a25f0a04SGreg Roach * @return string 33a25f0a04SGreg Roach */ 34a25f0a04SGreg Roach public function getSidebarContent(); 35a25f0a04SGreg Roach 36a25f0a04SGreg Roach /** 37a25f0a04SGreg Roach * Load this sidebar asynchronously. 38a25f0a04SGreg Roach * 39a25f0a04SGreg Roach * @return string 40a25f0a04SGreg Roach */ 41a25f0a04SGreg Roach public function getSidebarAjaxContent(); 42a25f0a04SGreg Roach 43a25f0a04SGreg Roach /** 44a25f0a04SGreg Roach * Does this sidebar have anything to display for this individual? 45a25f0a04SGreg Roach * 46cbc1590aSGreg Roach * @return bool 47a25f0a04SGreg Roach */ 48a25f0a04SGreg Roach public function hasSidebarContent(); 49a25f0a04SGreg Roach} 50