Passed
Push — develop ( e21e10...4cbe0a )
by Greg
10:46 queued 03:19
created

RouteFactory::routeMap()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 6
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 3
nc 1
nop 0
dl 0
loc 6
rs 10
c 0
b 0
f 0
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
18
declare(strict_types=1);
19
20
namespace Fisharebest\Webtrees\Factories;
21
22
use Aura\Router\Map;
23
use Aura\Router\Route;
24
use Aura\Router\RouterContainer;
25
use Fisharebest\Webtrees\Contracts\RouteFactoryInterface;
26
use Fisharebest\Webtrees\Html;
27
use Fisharebest\Webtrees\Registry;
28
use Fisharebest\Webtrees\Validator;
29
use Psr\Http\Message\ServerRequestInterface;
30
31
use function app;
32
use function array_filter;
33
use function assert;
34
use function intval;
35
use function is_bool;
36
use function parse_url;
37
use function strlen;
38
use function substr;
39
40
use const ARRAY_FILTER_USE_KEY;
41
use const PHP_URL_PATH;
42
43
/**
44
 * Make a URL for a route.
45
 */
46
class RouteFactory implements RouteFactoryInterface
47
{
48
    /**
49
     * Generate a URL for a named route.
50
     *
51
     * @param string                                    $route_name
52
     * @param array<bool|int|string|array<string>|null> $parameters
53
     *
54
     * @return string
55
     */
56
    public function route(string $route_name, array $parameters = []): string
57
    {
58
        $request = app(ServerRequestInterface::class);
59
        assert($request instanceof ServerRequestInterface);
60
61
        $base_url = Validator::attributes($request)->string('base_url');
62
63
        $route = $this->routeMap()->getRoute($route_name);
64
65
        // Generate the URL.
66
        $router_container = app(RouterContainer::class);
67
        assert($router_container instanceof RouterContainer);
68
69
        // webtrees uses http_build_query() to generate URLs - which maps false onto "0".
70
        // Aura uses rawurlencode(), which maps false onto "" - which does not work as an aura URL parameter.
71
        $parameters = array_map(static fn ($var) => is_bool($var) ? (int) $var : $var, $parameters);
72
73
        $url = $router_container->getGenerator()->generate($route_name, $parameters);
74
75
        // Aura ignores parameters that are not tokens.  We need to add them as query parameters.
76
        $parameters = array_filter($parameters, static function (string $key) use ($route): bool {
77
            return !str_contains($route->path, '{' . $key . '}') && !str_contains($route->path, '{/' . $key . '}');
78
        }, ARRAY_FILTER_USE_KEY);
79
80
        if (Validator::attributes($request)->boolean('rewrite_urls', false)) {
81
            // Make the pretty URL absolute.
82
            $base_path = parse_url($base_url, PHP_URL_PATH) ?: '';
83
            $url       = $base_url . substr($url, strlen($base_path));
84
        } else {
85
            // Turn the pretty URL into an ugly one.
86
            $path       = parse_url($url, PHP_URL_PATH);
87
            $parameters = ['route' => $path] + $parameters;
88
            $url        = $base_url . '/index.php';
89
        }
90
91
        return Html::url($url, $parameters);
92
    }
93
94
    /**
95
     * @return Map<Route>
96
     */
97
    public function routeMap(): Map
98
    {
99
        $router_container = app(RouterContainer::class);
100
        assert($router_container instanceof RouterContainer);
101
102
        return $router_container->getMap();
103
    }
104
}
105