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\Contracts; 21 22use Aura\Router\Map; 23use Aura\Router\Route; 24 25/** 26 * Make a URL for a route. 27 */ 28interface RouteFactoryInterface 29{ 30 /** 31 * Generate a URL for a named route. 32 * 33 * @param string $route_name 34 * @param array<bool|int|string|array<string>|null> $parameters 35 * 36 * @return string 37 */ 38 public function route(string $route_name, array $parameters = []): string; 39 40 /** 41 * @return Map<Route> 42 */ 43 public function routeMap(): Map; 44} 45