Passed
Push — master ( 53c413...1211a5 )
by Taosikai
15:08
created

src/Request/Request.php (1 issue)

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

1
<?php
2
/*
3
 * This file is part of the slince/smartqq package.
4
 *
5
 * (c) Slince <[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
11
namespace Slince\SmartQQ\Request;
12
13
class Request implements RequestInterface
14
{
15
    /**
16
     * 请求地址
17
     *
18
     * @var string
19
     */
20
    protected $uri;
21
22
    /**
23
     * referer.
24
     *
25
     * @var string
26
     */
27
    protected $referer;
28
29
    /**
30
     * 请求方式.
31
     *
32
     * @var string
33
     */
34
    protected $method = RequestInterface::REQUEST_METHOD_GET;
35
36
    /**
37
     * 请求参数.
38
     *
39
     * @var array
40
     */
41
    protected $parameters = [];
42
43
    /**
44
     * 处理占位符.
45
     *
46
     * @var array
47
     */
48
    protected $tokens = [];
49
50
    /**
51
     * 获取请求地址
52
     *
53
     * @return string
54
     */
55
    public function getUri()
56
    {
57
        return $this->processUri($this->uri);
58
    }
59
60
    /**
61
     * 获取referer.
62
     *
63
     * @return string
64
     */
65
    public function getReferer()
66
    {
67
        return $this->processUri($this->referer);
68
    }
69
70
    /**
71
     * 设置uri.
72
     *
73
     * @param string $uri
74
     */
75
    public function setUri($uri)
76
    {
77
        $this->uri = $uri;
78
    }
79
80
    /**
81
     * 设置referer.
82
     *
83
     * @param string $referer
84
     */
85
    public function setReferer($referer)
86
    {
87
        $this->referer = $referer;
88
    }
89
90
    /**
91
     * 获取请求方式.
92
     *
93
     * @return string
94
     */
95
    public function getMethod()
96
    {
97
        return $this->method;
98
    }
99
100
    /**
101
     * 获取请求参数.
102
     *
103
     * @return array
104
     */
105
    public function getParameters()
106
    {
107
        return $this->parameters;
0 ignored issues
show
Bug Best Practice introduced by
The return type of return $this->parameters; (array) is incompatible with the return type declared by the interface Slince\SmartQQ\Request\R...nterface::getParameters of type string.

If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.

Let’s take a look at an example:

class Author {
    private $name;

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

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}

Our function my_function expects a Post object, and outputs the author of the post. The base class Post returns a simple string and outputting a simple string will work just fine. However, the child class BlogPost which is a sub-type of Post instead decided to return an object, and is therefore violating the SOLID principles. If a BlogPost were passed to my_function, PHP would not complain, but ultimately fail when executing the strtoupper call in its body.

Loading history...
108
    }
109
110
    /**
111
     * 设置参数.
112
     *
113
     * @param array $parameters
114
     */
115
    public function setParameters(array $parameters)
116
    {
117
        $this->parameters = $parameters;
118
    }
119
120
    /**
121
     * 设置请求参数.
122
     *
123
     * @param string $name
124
     * @param string $parameter
125
     */
126
    public function setParameter($name, $parameter)
127
    {
128
        $this->parameters[$name] = $parameter;
129
    }
130
131
    /**
132
     * 设置链接中的占位符.
133
     *
134
     * @param array $tokens
135
     */
136
    public function setTokens(array $tokens)
137
    {
138
        $this->tokens = $tokens;
139
    }
140
141
    /**
142
     * 获取所有的token.
143
     *
144
     * @return array
145
     */
146
    public function getTokens()
147
    {
148
        return $this->tokens;
149
    }
150
151
    /**
152
     * 设置链接中的指定占位符.
153
     *
154
     * @param string $name
155
     * @param string $token
156
     */
157
    public function setToken($name, $token)
158
    {
159
        $this->tokens[$name] = $token;
160
    }
161
162
    /**
163
     * 处理链接中的占位符.
164
     *
165
     * @param string $uri
166
     *
167
     * @return string
168
     */
169
    protected function processUri($uri)
170
    {
171
        return preg_replace_callback('#\{([a-zA-Z0-9_,]*)\}#i', function($matches) {
172
            return isset($this->tokens[$matches[1]]) ? $this->tokens[$matches[1]] : '';
173
        }, $uri);
174
    }
175
}
176