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 */ 16a9430be8SGreg Roachdeclare(strict_types=1); 17a9430be8SGreg Roach 1876692c8bSGreg Roachnamespace Fisharebest\Webtrees\Module; 19a25f0a04SGreg Roach 20a25f0a04SGreg Roach/** 21a25f0a04SGreg Roach * Interface ModuleBlockInterface - Classes and libraries for module system 22a25f0a04SGreg Roach */ 23a25f0a04SGreg Roachinterface ModuleBlockInterface { 24a25f0a04SGreg Roach /** 25a25f0a04SGreg Roach * Generate the HTML content of this block. 26a25f0a04SGreg Roach * 27cbc1590aSGreg Roach * @param int $block_id 2876692c8bSGreg Roach * @param bool $template 29727f238cSGreg Roach * @param string[] $cfg 30a25f0a04SGreg Roach * 31a25f0a04SGreg Roach * @return string 32a25f0a04SGreg Roach */ 33a9430be8SGreg Roach public function getBlock($block_id, $template = true, $cfg = []): string; 34a25f0a04SGreg Roach 35a25f0a04SGreg Roach /** 36a25f0a04SGreg Roach * Should this block load asynchronously using AJAX? 3776692c8bSGreg Roach * 38a25f0a04SGreg Roach * Simple blocks are faster in-line, more comples ones 39a25f0a04SGreg Roach * can be loaded later. 40a25f0a04SGreg Roach * 41cbc1590aSGreg Roach * @return bool 42a25f0a04SGreg Roach */ 43a9430be8SGreg Roach public function loadAjax(): bool; 44a25f0a04SGreg Roach 45a25f0a04SGreg Roach /** 46a25f0a04SGreg Roach * Can this block be shown on the user’s home page? 47a25f0a04SGreg Roach * 48cbc1590aSGreg Roach * @return bool 49a25f0a04SGreg Roach */ 50a9430be8SGreg Roach public function isUserBlock(): bool; 51a25f0a04SGreg Roach 52a25f0a04SGreg Roach /** 53a25f0a04SGreg Roach * Can this block be shown on the tree’s home page? 54a25f0a04SGreg Roach * 55cbc1590aSGreg Roach * @return bool 56a25f0a04SGreg Roach */ 57a9430be8SGreg Roach public function isGedcomBlock(): bool; 58a25f0a04SGreg Roach 59a25f0a04SGreg Roach /** 60a25f0a04SGreg Roach * An HTML form to edit block settings 61a25f0a04SGreg Roach * 62cbc1590aSGreg Roach * @param int $block_id 63a9430be8SGreg Roach * 64a9430be8SGreg Roach * @return void 65a25f0a04SGreg Roach */ 66be9a728cSGreg Roach public function configureBlock($block_id); 67a25f0a04SGreg Roach} 68