1 | <?php |
||
9 | class Response |
||
10 | { |
||
11 | /** |
||
12 | * Properties |
||
13 | * |
||
14 | */ |
||
15 | private $headers = []; // Set all headers to send |
||
16 | private $statusCode; // Set statuscode to use |
||
17 | private $body; // Body to send with response |
||
18 | |||
19 | |||
20 | |||
21 | /** |
||
22 | * Set headers. |
||
23 | * |
||
24 | * @param string $header type of header to set |
||
|
|||
25 | * |
||
26 | * @return $this |
||
27 | */ |
||
28 | 1 | public function setStatusCode($value) |
|
36 | |||
37 | |||
38 | |||
39 | /** |
||
40 | * Set headers. |
||
41 | * |
||
42 | * @param string $header type of header to set |
||
43 | * |
||
44 | * @return $this |
||
45 | */ |
||
46 | public function addHeader($header) |
||
47 | { |
||
48 | $this->headers[] = $header; |
||
49 | } |
||
50 | |||
51 | |||
52 | |||
53 | /** |
||
54 | * Check if headers are already sent and throw exception if it is. |
||
55 | * |
||
56 | * @return void |
||
57 | * |
||
58 | * @throws Exception |
||
59 | */ |
||
60 | 1 | public function checkIfHeadersAlreadySent() |
|
66 | |||
67 | |||
68 | |||
69 | /** |
||
70 | * Send headers. |
||
71 | * |
||
72 | * @return $this |
||
73 | */ |
||
74 | public function sendHeaders() |
||
95 | |||
96 | |||
97 | |||
98 | /** |
||
99 | * Set the body. |
||
100 | * |
||
101 | * @param string $body |
||
102 | * |
||
103 | * @return this |
||
104 | */ |
||
105 | 1 | public function setBody($body) |
|
110 | |||
111 | |||
112 | |||
113 | /** |
||
114 | * Get the body. |
||
115 | * |
||
116 | * @return void |
||
117 | */ |
||
118 | 1 | public function getBody() |
|
122 | |||
123 | |||
124 | |||
125 | /** |
||
126 | * Send response with an optional statuscode. |
||
127 | * |
||
128 | * @param integer $statusCode optional statuscode to send. |
||
129 | * |
||
130 | * @return void |
||
131 | */ |
||
132 | public function send($statusCode = null) |
||
140 | |||
141 | |||
142 | |||
143 | /** |
||
144 | * Send JSON response with an optional statuscode. |
||
145 | * |
||
146 | * @param mixed $data to be encoded as json. |
||
147 | * @param integer $statusCode optional statuscode to send. |
||
148 | * |
||
149 | * @return void |
||
150 | */ |
||
151 | public function sendJson($data, $statusCode = null) |
||
161 | |||
162 | |||
163 | |||
164 | /** |
||
165 | * Redirect to another page. |
||
166 | * |
||
167 | * @param string $url to redirect to |
||
168 | * |
||
169 | * @return void |
||
170 | */ |
||
171 | public function redirect($url) |
||
176 | } |
||
177 |
This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.
Consider the following example. The parameter
$italy
is not defined by the methodfinale(...)
.The most likely cause is that the parameter was removed, but the annotation was not.