Test Failed
Push — develop ( c96bee...f90d20 )
by nguereza
02:20
created

RouteHelper::generateUrl()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 1
eloc 1
c 1
b 0
f 0
nc 1
nop 2
dl 0
loc 3
rs 10
1
<?php
2
3
/**
4
 * Platine Framework
5
 *
6
 * Platine Framework is a lightweight, high-performance, simple and elegant
7
 * PHP Web framework
8
 *
9
 * This content is released under the MIT License (MIT)
10
 *
11
 * Copyright (c) 2020 Platine Framework
12
 *
13
 * Permission is hereby granted, free of charge, to any person obtaining a copy
14
 * of this software and associated documentation files (the "Software"), to deal
15
 * in the Software without restriction, including without limitation the rights
16
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
17
 * copies of the Software, and to permit persons to whom the Software is
18
 * furnished to do so, subject to the following conditions:
19
 *
20
 * The above copyright notice and this permission notice shall be included in all
21
 * copies or substantial portions of the Software.
22
 *
23
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
24
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
26
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
28
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29
 * SOFTWARE.
30
 */
31
32
/**
33
 *  @file RouteHelper.php
34
 *
35
 * This route helper class that contains some useful methods to manage the
36
 * route data.
37
 *
38
 *  @package    Platine\Framework\Http
39
 *  @author Platine Developers team
40
 *  @copyright  Copyright (c) 2020
41
 *  @license    http://opensource.org/licenses/MIT  MIT License
42
 *  @link   http://www.iacademy.cf
43
 *  @version 1.0.0
44
 *  @filesource
45
 */
46
47
declare(strict_types=1);
48
49
namespace Platine\Framework\Http;
50
51
use Platine\Route\Router;
52
53
54
/**
55
 * class RouteHelper
56
 * @package Platine\Framework\Http
57
 */
58
class RouteHelper
59
{
60
61
    /**
62
     * The router instance
63
     * @var Router
64
     */
65
    protected Router $router;
66
67
    /**
68
     * Create new instance
69
     * @param Router $router
70
     */
71
    public function __construct(Router $router)
72
    {
73
        $this->router = $router;
74
    }
75
76
    /**
77
     * Generate the URL using route name
78
     * @param string $name
79
     * @param array<string, mixed> $parameters
80
     * @return string
81
     */
82
    public function generateUrl(string $name, array $parameters = []): string
83
    {
84
        return $this->router->path($name, $parameters);
85
    }
86
}
87