1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
|
<?php
/**
* webtrees: online genealogy
* Copyright (C) 2026 webtrees development team
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace Fisharebest\Webtrees\Factories;
use Aura\Router\Map;
use Aura\Router\Route;
use Aura\Router\RouterContainer;
use Fisharebest\Webtrees\Contracts\RouteFactoryInterface;
use Fisharebest\Webtrees\Html;
use Fisharebest\Webtrees\Registry;
use Fisharebest\Webtrees\Validator;
use Psr\Http\Message\ServerRequestInterface;
use function array_filter;
use function array_map;
use function is_bool;
use function parse_url;
use function strlen;
use function substr;
use const ARRAY_FILTER_USE_KEY;
use const PHP_URL_PATH;
/**
* Make a URL for a route.
*/
class RouteFactory implements RouteFactoryInterface
{
/**
* Generate a URL for a named route.
*
* @param string $route_name
* @param array<bool|int|string|array<string>|null> $parameters
*
* @return string
*/
public function route(string $route_name, array $parameters = []): string
{
$request = Registry::container()->get(ServerRequestInterface::class);
$base_url = Validator::attributes($request)->string('base_url');
$route = $this->routeMap()->getRoute($route_name);
// Generate the URL.
$router_container = Registry::container()->get(RouterContainer::class);
// webtrees uses http_build_query() to generate URLs - which maps false onto "0".
// Aura uses rawurlencode(), which maps false onto "" - which does not work as an aura URL parameter.
$parameters = array_map(static fn ($var) => is_bool($var) ? (int) $var : $var, $parameters);
// Aura doesn't work with empty/optional URL parameters - but we need empty ones for query parameters.
$url_parameters = array_map(static fn ($var) => $var === '' ? null : $var, $parameters);
$url = $router_container->getGenerator()->generate($route_name, $url_parameters);
// Aura ignores parameters that are not tokens. We need to add them as query parameters.
$parameters = array_filter($parameters, static fn (string $key): bool => !str_contains($route->path, '{' . $key . '}') && !str_contains($route->path, '{/' . $key . '}'), ARRAY_FILTER_USE_KEY);
if (Validator::attributes($request)->boolean('rewrite_urls', false)) {
// Make the pretty URL absolute.
$base_path = parse_url($base_url, PHP_URL_PATH) ?: '';
$url = $base_url . substr($url, strlen($base_path));
} else {
// Turn the pretty URL into an ugly one.
$path = parse_url($url, PHP_URL_PATH);
$parameters = ['route' => $path] + $parameters;
$url = $base_url . '/index.php';
}
return Html::url($url, $parameters);
}
/**
* @return Map<Route>
*/
public function routeMap(): Map
{
$router_container = Registry::container()->get(RouterContainer::class);
return $router_container->getMap();
}
}
|
