1<?php 2 3/** 4 * webtrees: online genealogy 5 * Copyright (C) 2022 webtrees development team 6 * This program is free software: you can redistribute it and/or modify 7 * it under the terms of the GNU General Public License as published by 8 * the Free Software Foundation, either version 3 of the License, or 9 * (at your option) any later version. 10 * This program is distributed in the hope that it will be useful, 11 * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 * GNU General Public License for more details. 14 * You should have received a copy of the GNU General Public License 15 * along with this program. If not, see <https://www.gnu.org/licenses/>. 16 */ 17 18declare(strict_types=1); 19 20namespace Fisharebest\Webtrees\Module; 21 22use Fisharebest\Webtrees\Menu; 23use Fisharebest\Webtrees\Tree; 24 25/** 26 * Interface ModuleListInterface - Classes and libraries for module system 27 */ 28interface ModuleListInterface extends ModuleInterface 29{ 30 /** 31 * A main menu item for this list, or null if the list is empty. 32 * 33 * @param Tree $tree 34 * 35 * @return Menu|null 36 */ 37 public function listMenu(Tree $tree): ?Menu; 38 39 /** 40 * CSS class for the menu. 41 * 42 * @return string 43 */ 44 public function listMenuClass(): string; 45 46 /** 47 * The title for a specific instance of this list. 48 * 49 * @return string 50 */ 51 public function listTitle(): string; 52 53 /** 54 * The URL for a page showing list options. 55 * 56 * @param Tree $tree 57 * @param array<bool|int|string|array<string>|null> $parameters 58 * 59 * @return string 60 */ 61 public function listUrl(Tree $tree, array $parameters = []): string; 62 63 /** 64 * Attributes for the URL. 65 * 66 * @return array<string> 67 */ 68 public function listUrlAttributes(): array; 69 70 /** 71 * @param Tree $tree 72 * 73 * @return bool 74 */ 75 public function listIsEmpty(Tree $tree): bool; 76} 77