Chris@0
|
1 <?php
|
Chris@0
|
2 /**
|
Chris@12
|
3 * @see https://github.com/zendframework/zend-diactoros for the canonical source repository
|
Chris@12
|
4 * @copyright Copyright (c) 2015-2017 Zend Technologies USA Inc. (http://www.zend.com)
|
Chris@0
|
5 * @license https://github.com/zendframework/zend-diactoros/blob/master/LICENSE.md New BSD License
|
Chris@0
|
6 */
|
Chris@0
|
7
|
Chris@0
|
8 namespace Zend\Diactoros;
|
Chris@0
|
9
|
Chris@0
|
10 use InvalidArgumentException;
|
Chris@0
|
11 use Psr\Http\Message\ServerRequestInterface;
|
Chris@0
|
12 use Psr\Http\Message\StreamInterface;
|
Chris@0
|
13 use Psr\Http\Message\UploadedFileInterface;
|
Chris@0
|
14 use Psr\Http\Message\UriInterface;
|
Chris@0
|
15
|
Chris@16
|
16 use function array_key_exists;
|
Chris@16
|
17 use function is_array;
|
Chris@16
|
18
|
Chris@0
|
19 /**
|
Chris@0
|
20 * Server-side HTTP request
|
Chris@0
|
21 *
|
Chris@0
|
22 * Extends the Request definition to add methods for accessing incoming data,
|
Chris@0
|
23 * specifically server parameters, cookies, matched path parameters, query
|
Chris@0
|
24 * string arguments, body parameters, and upload file information.
|
Chris@0
|
25 *
|
Chris@0
|
26 * "Attributes" are discovered via decomposing the request (and usually
|
Chris@0
|
27 * specifically the URI path), and typically will be injected by the application.
|
Chris@0
|
28 *
|
Chris@0
|
29 * Requests are considered immutable; all methods that might change state are
|
Chris@0
|
30 * implemented such that they retain the internal state of the current
|
Chris@0
|
31 * message and return a new instance that contains the changed state.
|
Chris@0
|
32 */
|
Chris@0
|
33 class ServerRequest implements ServerRequestInterface
|
Chris@0
|
34 {
|
Chris@0
|
35 use RequestTrait;
|
Chris@0
|
36
|
Chris@0
|
37 /**
|
Chris@0
|
38 * @var array
|
Chris@0
|
39 */
|
Chris@0
|
40 private $attributes = [];
|
Chris@0
|
41
|
Chris@0
|
42 /**
|
Chris@0
|
43 * @var array
|
Chris@0
|
44 */
|
Chris@0
|
45 private $cookieParams = [];
|
Chris@0
|
46
|
Chris@0
|
47 /**
|
Chris@0
|
48 * @var null|array|object
|
Chris@0
|
49 */
|
Chris@0
|
50 private $parsedBody;
|
Chris@0
|
51
|
Chris@0
|
52 /**
|
Chris@0
|
53 * @var array
|
Chris@0
|
54 */
|
Chris@0
|
55 private $queryParams = [];
|
Chris@0
|
56
|
Chris@0
|
57 /**
|
Chris@0
|
58 * @var array
|
Chris@0
|
59 */
|
Chris@0
|
60 private $serverParams;
|
Chris@0
|
61
|
Chris@0
|
62 /**
|
Chris@0
|
63 * @var array
|
Chris@0
|
64 */
|
Chris@0
|
65 private $uploadedFiles;
|
Chris@0
|
66
|
Chris@0
|
67 /**
|
Chris@0
|
68 * @param array $serverParams Server parameters, typically from $_SERVER
|
Chris@0
|
69 * @param array $uploadedFiles Upload file information, a tree of UploadedFiles
|
Chris@0
|
70 * @param null|string|UriInterface $uri URI for the request, if any.
|
Chris@0
|
71 * @param null|string $method HTTP method for the request, if any.
|
Chris@0
|
72 * @param string|resource|StreamInterface $body Message body, if any.
|
Chris@0
|
73 * @param array $headers Headers for the message, if any.
|
Chris@0
|
74 * @param array $cookies Cookies for the message, if any.
|
Chris@0
|
75 * @param array $queryParams Query params for the message, if any.
|
Chris@0
|
76 * @param null|array|object $parsedBody The deserialized body parameters, if any.
|
Chris@0
|
77 * @param string $protocol HTTP protocol version.
|
Chris@0
|
78 * @throws InvalidArgumentException for any invalid value.
|
Chris@0
|
79 */
|
Chris@0
|
80 public function __construct(
|
Chris@0
|
81 array $serverParams = [],
|
Chris@0
|
82 array $uploadedFiles = [],
|
Chris@0
|
83 $uri = null,
|
Chris@0
|
84 $method = null,
|
Chris@0
|
85 $body = 'php://input',
|
Chris@0
|
86 array $headers = [],
|
Chris@0
|
87 array $cookies = [],
|
Chris@0
|
88 array $queryParams = [],
|
Chris@0
|
89 $parsedBody = null,
|
Chris@0
|
90 $protocol = '1.1'
|
Chris@0
|
91 ) {
|
Chris@0
|
92 $this->validateUploadedFiles($uploadedFiles);
|
Chris@0
|
93
|
Chris@0
|
94 if ($body === 'php://input') {
|
Chris@0
|
95 $body = new PhpInputStream();
|
Chris@0
|
96 }
|
Chris@0
|
97
|
Chris@0
|
98 $this->initialize($uri, $method, $body, $headers);
|
Chris@0
|
99 $this->serverParams = $serverParams;
|
Chris@0
|
100 $this->uploadedFiles = $uploadedFiles;
|
Chris@0
|
101 $this->cookieParams = $cookies;
|
Chris@0
|
102 $this->queryParams = $queryParams;
|
Chris@0
|
103 $this->parsedBody = $parsedBody;
|
Chris@0
|
104 $this->protocol = $protocol;
|
Chris@0
|
105 }
|
Chris@0
|
106
|
Chris@0
|
107 /**
|
Chris@0
|
108 * {@inheritdoc}
|
Chris@0
|
109 */
|
Chris@0
|
110 public function getServerParams()
|
Chris@0
|
111 {
|
Chris@0
|
112 return $this->serverParams;
|
Chris@0
|
113 }
|
Chris@0
|
114
|
Chris@0
|
115 /**
|
Chris@0
|
116 * {@inheritdoc}
|
Chris@0
|
117 */
|
Chris@0
|
118 public function getUploadedFiles()
|
Chris@0
|
119 {
|
Chris@0
|
120 return $this->uploadedFiles;
|
Chris@0
|
121 }
|
Chris@0
|
122
|
Chris@0
|
123 /**
|
Chris@0
|
124 * {@inheritdoc}
|
Chris@0
|
125 */
|
Chris@0
|
126 public function withUploadedFiles(array $uploadedFiles)
|
Chris@0
|
127 {
|
Chris@0
|
128 $this->validateUploadedFiles($uploadedFiles);
|
Chris@0
|
129 $new = clone $this;
|
Chris@0
|
130 $new->uploadedFiles = $uploadedFiles;
|
Chris@0
|
131 return $new;
|
Chris@0
|
132 }
|
Chris@0
|
133
|
Chris@0
|
134 /**
|
Chris@0
|
135 * {@inheritdoc}
|
Chris@0
|
136 */
|
Chris@0
|
137 public function getCookieParams()
|
Chris@0
|
138 {
|
Chris@0
|
139 return $this->cookieParams;
|
Chris@0
|
140 }
|
Chris@0
|
141
|
Chris@0
|
142 /**
|
Chris@0
|
143 * {@inheritdoc}
|
Chris@0
|
144 */
|
Chris@0
|
145 public function withCookieParams(array $cookies)
|
Chris@0
|
146 {
|
Chris@0
|
147 $new = clone $this;
|
Chris@0
|
148 $new->cookieParams = $cookies;
|
Chris@0
|
149 return $new;
|
Chris@0
|
150 }
|
Chris@0
|
151
|
Chris@0
|
152 /**
|
Chris@0
|
153 * {@inheritdoc}
|
Chris@0
|
154 */
|
Chris@0
|
155 public function getQueryParams()
|
Chris@0
|
156 {
|
Chris@0
|
157 return $this->queryParams;
|
Chris@0
|
158 }
|
Chris@0
|
159
|
Chris@0
|
160 /**
|
Chris@0
|
161 * {@inheritdoc}
|
Chris@0
|
162 */
|
Chris@0
|
163 public function withQueryParams(array $query)
|
Chris@0
|
164 {
|
Chris@0
|
165 $new = clone $this;
|
Chris@0
|
166 $new->queryParams = $query;
|
Chris@0
|
167 return $new;
|
Chris@0
|
168 }
|
Chris@0
|
169
|
Chris@0
|
170 /**
|
Chris@0
|
171 * {@inheritdoc}
|
Chris@0
|
172 */
|
Chris@0
|
173 public function getParsedBody()
|
Chris@0
|
174 {
|
Chris@0
|
175 return $this->parsedBody;
|
Chris@0
|
176 }
|
Chris@0
|
177
|
Chris@0
|
178 /**
|
Chris@0
|
179 * {@inheritdoc}
|
Chris@0
|
180 */
|
Chris@0
|
181 public function withParsedBody($data)
|
Chris@0
|
182 {
|
Chris@17
|
183 if (! is_array($data) && ! is_object($data) && null !== $data) {
|
Chris@17
|
184 throw new InvalidArgumentException(sprintf(
|
Chris@17
|
185 '%s expects a null, array, or object argument; received %s',
|
Chris@17
|
186 __METHOD__,
|
Chris@17
|
187 gettype($data)
|
Chris@17
|
188 ));
|
Chris@17
|
189 }
|
Chris@17
|
190
|
Chris@0
|
191 $new = clone $this;
|
Chris@0
|
192 $new->parsedBody = $data;
|
Chris@0
|
193 return $new;
|
Chris@0
|
194 }
|
Chris@0
|
195
|
Chris@0
|
196 /**
|
Chris@0
|
197 * {@inheritdoc}
|
Chris@0
|
198 */
|
Chris@0
|
199 public function getAttributes()
|
Chris@0
|
200 {
|
Chris@0
|
201 return $this->attributes;
|
Chris@0
|
202 }
|
Chris@0
|
203
|
Chris@0
|
204 /**
|
Chris@0
|
205 * {@inheritdoc}
|
Chris@0
|
206 */
|
Chris@0
|
207 public function getAttribute($attribute, $default = null)
|
Chris@0
|
208 {
|
Chris@0
|
209 if (! array_key_exists($attribute, $this->attributes)) {
|
Chris@0
|
210 return $default;
|
Chris@0
|
211 }
|
Chris@0
|
212
|
Chris@0
|
213 return $this->attributes[$attribute];
|
Chris@0
|
214 }
|
Chris@0
|
215
|
Chris@0
|
216 /**
|
Chris@0
|
217 * {@inheritdoc}
|
Chris@0
|
218 */
|
Chris@0
|
219 public function withAttribute($attribute, $value)
|
Chris@0
|
220 {
|
Chris@0
|
221 $new = clone $this;
|
Chris@0
|
222 $new->attributes[$attribute] = $value;
|
Chris@0
|
223 return $new;
|
Chris@0
|
224 }
|
Chris@0
|
225
|
Chris@0
|
226 /**
|
Chris@0
|
227 * {@inheritdoc}
|
Chris@0
|
228 */
|
Chris@0
|
229 public function withoutAttribute($attribute)
|
Chris@0
|
230 {
|
Chris@0
|
231 $new = clone $this;
|
Chris@0
|
232 unset($new->attributes[$attribute]);
|
Chris@0
|
233 return $new;
|
Chris@0
|
234 }
|
Chris@0
|
235
|
Chris@0
|
236 /**
|
Chris@0
|
237 * Proxy to receive the request method.
|
Chris@0
|
238 *
|
Chris@0
|
239 * This overrides the parent functionality to ensure the method is never
|
Chris@0
|
240 * empty; if no method is present, it returns 'GET'.
|
Chris@0
|
241 *
|
Chris@0
|
242 * @return string
|
Chris@0
|
243 */
|
Chris@0
|
244 public function getMethod()
|
Chris@0
|
245 {
|
Chris@0
|
246 if (empty($this->method)) {
|
Chris@0
|
247 return 'GET';
|
Chris@0
|
248 }
|
Chris@0
|
249 return $this->method;
|
Chris@0
|
250 }
|
Chris@0
|
251
|
Chris@0
|
252 /**
|
Chris@0
|
253 * Set the request method.
|
Chris@0
|
254 *
|
Chris@0
|
255 * Unlike the regular Request implementation, the server-side
|
Chris@0
|
256 * normalizes the method to uppercase to ensure consistency
|
Chris@0
|
257 * and make checking the method simpler.
|
Chris@0
|
258 *
|
Chris@0
|
259 * This methods returns a new instance.
|
Chris@0
|
260 *
|
Chris@0
|
261 * @param string $method
|
Chris@0
|
262 * @return self
|
Chris@0
|
263 */
|
Chris@0
|
264 public function withMethod($method)
|
Chris@0
|
265 {
|
Chris@0
|
266 $this->validateMethod($method);
|
Chris@0
|
267 $new = clone $this;
|
Chris@0
|
268 $new->method = $method;
|
Chris@0
|
269 return $new;
|
Chris@0
|
270 }
|
Chris@0
|
271
|
Chris@0
|
272 /**
|
Chris@0
|
273 * Recursively validate the structure in an uploaded files array.
|
Chris@0
|
274 *
|
Chris@0
|
275 * @param array $uploadedFiles
|
Chris@0
|
276 * @throws InvalidArgumentException if any leaf is not an UploadedFileInterface instance.
|
Chris@0
|
277 */
|
Chris@0
|
278 private function validateUploadedFiles(array $uploadedFiles)
|
Chris@0
|
279 {
|
Chris@0
|
280 foreach ($uploadedFiles as $file) {
|
Chris@0
|
281 if (is_array($file)) {
|
Chris@0
|
282 $this->validateUploadedFiles($file);
|
Chris@0
|
283 continue;
|
Chris@0
|
284 }
|
Chris@0
|
285
|
Chris@0
|
286 if (! $file instanceof UploadedFileInterface) {
|
Chris@0
|
287 throw new InvalidArgumentException('Invalid leaf in uploaded files structure');
|
Chris@0
|
288 }
|
Chris@0
|
289 }
|
Chris@0
|
290 }
|
Chris@0
|
291 }
|