1 | <?php |
||
11 | class RestResponse |
||
12 | { |
||
13 | /** |
||
14 | * The HTTP status code, such as 200. |
||
15 | * |
||
16 | * @var int |
||
17 | */ |
||
18 | private $status; |
||
19 | |||
20 | /** |
||
21 | * The response payload, if set. |
||
22 | * |
||
23 | * @var RestPayload|null |
||
24 | */ |
||
25 | private $payload; |
||
26 | |||
27 | /** |
||
28 | * Response headers. |
||
29 | * |
||
30 | * @var array |
||
31 | */ |
||
32 | private $headers = []; |
||
33 | |||
34 | /** |
||
35 | * Constructor. |
||
36 | * |
||
37 | * @param int $status |
||
38 | * @param RestPayload|null $payload |
||
39 | */ |
||
40 | public function __construct($status, RestPayload $payload = null) |
||
45 | |||
46 | /** |
||
47 | * Adds a response header. |
||
48 | * |
||
49 | * @param string $name |
||
50 | * @param string $value |
||
51 | * @return self |
||
52 | */ |
||
53 | public function addHeader($name, $value) |
||
59 | |||
60 | /** |
||
61 | * Sets an array of response headers. |
||
62 | * |
||
63 | * @param array $headers |
||
64 | * @return self |
||
65 | */ |
||
66 | public function setHeaders(array $headers) |
||
73 | |||
74 | /** |
||
75 | * Gets the response headers. |
||
76 | * |
||
77 | * @return array |
||
78 | */ |
||
79 | public function getHeaders() |
||
83 | |||
84 | /** |
||
85 | * Gets the HTTP status code. |
||
86 | * |
||
87 | * @return int |
||
88 | */ |
||
89 | public function getStatus() |
||
93 | |||
94 | /** |
||
95 | * Gets the response payload. |
||
96 | * |
||
97 | * @return RestPayload|null |
||
98 | */ |
||
99 | public function getPayload() |
||
103 | |||
104 | /** |
||
105 | * Gets the response content, from the payload. |
||
106 | * |
||
107 | * @return string|null |
||
108 | */ |
||
109 | public function getContent() |
||
116 | } |
||
117 |
This check looks from parameters that have been defined for a function or method, but which are not used in the method body.