1<?php 2/** 3 * webtrees: online genealogy 4 * Copyright (C) 2019 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 */ 16declare(strict_types=1); 17 18namespace Fisharebest\Webtrees\Module; 19 20use Fisharebest\Webtrees\Menu; 21use Fisharebest\Webtrees\Tree; 22 23/** 24 * Interface ModuleListInterface - Classes and libraries for module system 25 */ 26interface ModuleListInterface extends ModuleInterface 27{ 28 29 /** 30 * A main menu item for this list, or null if the list is empty. 31 * 32 * @param Tree $tree 33 * 34 * @return Menu|null 35 */ 36 public function listMenu(Tree $tree): ?Menu; 37 38 /** 39 * CSS class for the menu. 40 * 41 * @return string 42 */ 43 public function listMenuClass(): string; 44 45 /** 46 * The title for a specific instance of this list. 47 * 48 * @return string 49 */ 50 public function listTitle(): string; 51 52 /** 53 * The URL for a page showing list options. 54 * 55 * @param Tree $tree 56 * @param string[] $parameters 57 * 58 * @return string 59 */ 60 public function listUrl(Tree $tree, array $parameters = []): string; 61 62 /** 63 * Attributes for the URL. 64 * 65 * @return string[] 66 */ 67 public function listUrlAttributes(): array; 68 69 /** 70 * @param Tree $tree 71 * 72 * @return bool 73 */ 74 public function listIsEmpty(Tree $tree): bool; 75} 76