HttpRoute::getMethod()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 2
CRAP Score 1

Importance

Changes 0
Metric Value
dl 0
loc 3
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
/*
4
 * Copyright (c) 2011-2015, Celestino Diaz <[email protected]>
5
 *
6
 * Permission is hereby granted, free of charge, to any person obtaining a copy
7
 * of this software and associated documentation files (the "Software"), to deal
8
 * in the Software without restriction, including without limitation the rights
9
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10
 * copies of the Software, and to permit persons to whom the Software is
11
 * furnished to do so, subject to the following conditions:
12
 *
13
 * The above copyright notice and this permission notice shall be included in
14
 * all copies or substantial portions of the Software.
15
 *
16
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22
 * THE SOFTWARE.
23
 */
24
25
namespace Brickoo\Component\Routing\Route;
26
27
use Brickoo\Component\Common\Assert;
28
29
/**
30
 * HttpRoute
31
 *
32
 * Implements a http route which can be configured to match http requests.
33
 * @author Celestino Diaz <[email protected]>
34
 */
35
class HttpRoute extends GenericRoute {
36
37
    /** @var string */
38
    private $method;
39
40
    /** @var string */
41
    private $scheme;
42
43
    /** @var string */
44
    private $hostname;
45
46
    /**
47
     * Returns the http method(s) allowed listening to.
48
     * @return string the http methods allowed as a regular expression
49
     */
50 1
    public function getMethod() {
51 1
        return $this->method;
52
    }
53
54
    /**
55
     * Sets the route method listening to.
56
     * @param string $method
57
     * @throws \InvalidArgumentException
58
     * @return \Brickoo\Component\Routing\Route\HttpRoute
59
     */
60 1
    public function setMethod($method) {
61 1
        Assert::isString($method);
62 1
        $this->method = strtoupper($method);
63 1
        return $this;
64
    }
65
66
    /**
67
     * Returns the scheme allowed listening to.
68
     * @return string the scheme allowed as a regular expression
69
     */
70 1
    public function getScheme() {
71 1
        return $this->scheme;
72
    }
73
74
    /**
75
     * Sets the scheme required.
76
     * @param string $scheme
77
     * @throws \InvalidArgumentException
78
     * @return \Brickoo\Component\Routing\Route\HttpRoute
79
     */
80 1
    public function setScheme($scheme) {
81 1
        Assert::isString($scheme);
82 1
        $this->scheme = $scheme;
83 1
        return $this;
84
    }
85
86
    /**
87
     * Returns the hostname(s) allowed listening to.
88
     * @return string the host names allowed as a regular expression
89
     */
90 1
    public function getHostname() {
91 1
        return $this->hostname;
92
    }
93
94
    /**
95
     * Sets the hostname listening to.
96
     * @param string $hostname
97
     * @throws \InvalidArgumentException
98
     * @return \Brickoo\Component\Routing\Route\HttpRoute
99
     */
100 1
    public function setHostname($hostname) {
101 1
        Assert::isString($hostname);
102 1
        $this->hostname = $hostname;
103 1
        return $this;
104
    }
105
106
}
107