Passed
Push — develop ( 1125ee...8bca93 )
by Greg
20:39 queued 07:22
created

RouteFactory::route()   B

Complexity

Conditions 6
Paths 2

Size

Total Lines 39
Code Lines 20

Duplication

Lines 0
Ratio 0 %

Importance

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