1<?php 2 3/** 4 * webtrees: online genealogy 5 * Copyright (C) 2019 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 <http://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 /** 32 * A main menu item for this list, or null if the list is empty. 33 * 34 * @param Tree $tree 35 * 36 * @return Menu|null 37 */ 38 public function listMenu(Tree $tree): ?Menu; 39 40 /** 41 * CSS class for the menu. 42 * 43 * @return string 44 */ 45 public function listMenuClass(): string; 46 47 /** 48 * The title for a specific instance of this list. 49 * 50 * @return string 51 */ 52 public function listTitle(): string; 53 54 /** 55 * The URL for a page showing list options. 56 * 57 * @param Tree $tree 58 * @param mixed[] $parameters 59 * 60 * @return string 61 */ 62 public function listUrl(Tree $tree, array $parameters = []): string; 63 64 /** 65 * Attributes for the URL. 66 * 67 * @return string[] 68 */ 69 public function listUrlAttributes(): array; 70 71 /** 72 * @param Tree $tree 73 * 74 * @return bool 75 */ 76 public function listIsEmpty(Tree $tree): bool; 77} 78