Route::getPattern()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 2
CRAP Score 1

Importance

Changes 0
Metric Value
dl 0
loc 4
ccs 2
cts 2
cp 1
rs 10
c 0
b 0
f 0
cc 1
eloc 2
nc 1
nop 0
crap 1
1
<?php
2
/**
3
 * This file is part of the DS Framework.
4
 *
5
 * (c) Dan Smith <[email protected]>
6
 *
7
 * For the full copyright and license information, please view the LICENSE
8
 * file that was distributed with this source code.
9
 */
10
namespace Ds\Router;
11
12
use Ds\Router\Interfaces\RouteInterface;
13
14
/**
15
 * Route Class
16
 *
17
 * @package Ds\Router
18
 * @author  Dan Smith    <[email protected]>
19
 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
20
 *
21
 * @see RouteInterface
22
 * @see RouteCollectionInterface
23
 */
24
class Route implements RouteInterface
25
{
26
    /**
27
     * Route Http Method
28
     *
29
     * @var string
30
     */
31
    protected $method;
32
33
    /**
34
     * Route Path Pattern
35
     *
36
     * @var string
37
     */
38
    protected $pattern;
39
40
    /**
41
     * Route Handler
42
     *
43
     * @var string|\Closure
44
     */
45
    protected $handler;
46
47
    /**
48
     * Route Names
49
     *
50
     * @var array $routeNames
51
     */
52
    protected $names;
53
54
    /**
55
     * Create a new route.
56
     *
57
     * @param string|array $method Route Http Method
58
     * @param string $pattern Route Path / Pattern
59
     * @param string|\Closure $handler Route Handler.
60
     * @param array $names Route Names
61
     */
62 30
    public function __construct($method, $pattern, $handler, array $names = [])
63
    {
64 30
        $this->method = $method;
0 ignored issues
show
Documentation Bug introduced by
It seems like $method can also be of type array. However, the property $method is declared as type string. Maybe add an additional type check?

Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly.

For example, imagine you have a variable $accountId that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the id property of an instance of the Account class. This class holds a proper account, so the id value must no longer be false.

Either this assignment is in error or a type check should be added for that assignment.

class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
Loading history...
65 30
        $this->pattern = $pattern;
66 30
        $this->handler = $handler;
67 30
        $this->names = $names;
68 30
    }
69
70
    /**
71
     * @inheritdoc
72
     */
73 1
    public function withMethod($method = '')
74
    {
75 1
        $new = clone $this;
76 1
        $new->method = (string)$method;
77 1
        return $new;
78
    }
79
80
    /**
81
     * @inheritdoc
82
     */
83 3
    public function withHandler($handler)
84
    {
85 3
        $new = clone $this;
86 3
        $new->handler = $handler;
87 3
        return $new;
88
    }
89
90
    /**
91
     * @inheritdoc
92
     */
93 1
    public function withPattern($pattern = '')
94
    {
95 1
        $new = clone $this;
96 1
        $new->pattern = (string)$pattern;
97 1
        return $new;
98
    }
99
100
    /**
101
     * @inheritdoc
102
     */
103 1
    public function withNames(array $name = [])
104
    {
105 1
        $new = clone $this;
106 1
        $new->names = $name;
107 1
        return $new;
108
    }
109
110
    /**
111
     * @inheritdoc
112
     */
113 12
    public function getMethod()
114
    {
115 12
        return (string)$this->method;
116
    }
117
118
    /**
119
     * @inheritdoc
120
     */
121 3
    public function getHandler()
122
    {
123 3
        return $this->handler;
124
    }
125
126
    /**
127
     * @inheritdoc
128
     */
129 2
    public function getHandlerType()
130
    {
131 2
        return \gettype($this->handler);
132
    }
133
134
    /**
135
     * @inheritdoc
136
     */
137 6
    public function getPattern()
138
    {
139 6
        return (string)$this->pattern;
140
    }
141
142
    /**
143
     * @inheritdoc
144
     */
145 2
    public function getNames()
146
    {
147 2
        return (array)$this->names;
148
    }
149
}
150