generated from yiisoft/package-template
-
-
Notifications
You must be signed in to change notification settings - Fork 12
/
DataResponse.php
408 lines (362 loc) · 10.6 KB
/
DataResponse.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
<?php
declare(strict_types=1);
namespace Yiisoft\DataResponse;
use Psr\Http\Message\ResponseFactoryInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\StreamFactoryInterface;
use Psr\Http\Message\StreamInterface;
use RuntimeException;
use function ftruncate;
use function is_callable;
use function is_object;
use function is_resource;
use function is_string;
use function rewind;
use function sprintf;
/**
* A wrapper around PSR-7 response that is assigned raw data to be formatted with a formatter later.
*
* For example, `['name' => 'Dmitriy']` to be formatted as JSON using
* {@see \Yiisoft\DataResponse\Formatter\JsonDataResponseFormatter} when {@see DataResponse::getBody()} is called.
*/
final class DataResponse implements ResponseInterface
{
/**
* @var resource
*/
private $resource;
private bool $formatted = false;
private bool $forcedBody = false;
private ResponseInterface $response;
private ?StreamInterface $dataStream = null;
private ?DataResponseFormatterInterface $responseFormatter = null;
/**
* @param mixed $data The response data.
* @param int $code The response status code.
* @param string $reasonPhrase The response reason phrase associated with the status code.
* @param ResponseFactoryInterface $responseFactory The response factory instance.
* @param StreamFactoryInterface $streamFactory The stream factory instance.
*/
public function __construct(
private mixed $data,
int $code,
string $reasonPhrase,
ResponseFactoryInterface $responseFactory,
StreamFactoryInterface $streamFactory
) {
$this->createResponse($code, $reasonPhrase, $responseFactory, $streamFactory);
}
public function getBody(): StreamInterface
{
if ($this->dataStream !== null) {
return $this->dataStream;
}
if ($this->hasResponseFormatter()) {
$this->formatResponse();
return $this->dataStream = $this->response->getBody();
}
if ($this->data === null) {
$this->clearResponseBody();
return $this->dataStream = $this->response->getBody();
}
$data = $this->getData();
if (is_string($data)) {
$this->clearResponseBody();
$this->response
->getBody()
->write($data);
return $this->dataStream = $this->response->getBody();
}
throw new RuntimeException(sprintf(
'The data is "%s" not a string. To get non-string data, use the "%s::getData()" method.',
get_debug_type($data),
self::class,
));
}
/**
* @inheritDoc
*
* @param string $name
*
* @return string[]
*/
public function getHeader($name): array
{
$this->formatResponse();
return $this->response->getHeader($name);
}
/**
* @inheritDoc
*
* @param string $name
*/
public function getHeaderLine($name): string
{
$this->formatResponse();
return $this->response->getHeaderLine($name);
}
/**
* @inheritDoc
*
* @return string[][]
*/
public function getHeaders(): array
{
$this->formatResponse();
return $this->response->getHeaders();
}
public function getProtocolVersion(): string
{
$this->formatResponse();
return $this->response->getProtocolVersion();
}
public function getReasonPhrase(): string
{
$this->formatResponse();
return $this->response->getReasonPhrase();
}
public function getStatusCode(): int
{
$this->formatResponse();
return $this->response->getStatusCode();
}
/**
* @inheritDoc
*
* @param string $name
*/
public function hasHeader($name): bool
{
$this->formatResponse();
return $this->response->hasHeader($name);
}
/**
* @inheritDoc
*
* @param string $name
* @param string|string[] $value
*
* @return self
*/
public function withAddedHeader($name, $value): self
{
$new = clone $this;
$new->response = $this->response->withAddedHeader($name, $value);
$new->formatted = false;
return $new;
}
/**
* @inheritDoc
*
* @return self
*/
public function withBody(StreamInterface $body): self
{
$new = clone $this;
$new->response = $this->response->withBody($body);
$new->dataStream = $body;
$new->forcedBody = true;
$new->formatted = false;
$new->data = null;
return $new;
}
/**
* @inheritDoc
*
* @param string $name
* @param string|string[] $value
*
* @return self
*/
public function withHeader($name, $value): self
{
$new = clone $this;
$new->response = $this->response->withHeader($name, $value);
$new->formatted = false;
return $new;
}
/**
* @inheritDoc
*
* @param string $name
*
* @return self
*/
public function withoutHeader($name): self
{
$new = clone $this;
$new->formatResponse();
$new->response = $new->response->withoutHeader($name);
return $new;
}
/**
* @inheritDoc
*
* @param string $version
*
* @return self
*/
public function withProtocolVersion($version): self
{
$new = clone $this;
$new->response = $this->response->withProtocolVersion($version);
$new->formatted = false;
return $new;
}
/**
* @inheritDoc
*
* @param int $code
* @param string $reasonPhrase
*
* @return self
*/
public function withStatus($code, $reasonPhrase = ''): self
{
$new = clone $this;
$new->response = $this->response->withStatus($code, $reasonPhrase);
$new->formatted = false;
return $new;
}
/**
* Returns a new instance with the specified response formatter.
*/
public function withResponseFormatter(DataResponseFormatterInterface $responseFormatter): self
{
$new = clone $this;
$new->responseFormatter = $responseFormatter;
$new->formatted = false;
return $new;
}
/**
* Returns the original instance of the response.
*
* @return ResponseInterface The original instance of the response.
*/
public function getResponse(): ResponseInterface
{
return $this->response;
}
/**
* Checks whether the response formatter has been set {@see withResponseFormatter()}.
*
* @return bool Whether the formatter has been set.
*/
public function hasResponseFormatter(): bool
{
return $this->responseFormatter !== null;
}
/**
* Returns a new instance with the specified response data.
*
* @param mixed $data The response data.
*
* @throws RuntimeException If the body was previously forced to be set {@see withBody()}.
*
* @return self
*/
public function withData(mixed $data): self
{
if ($this->forcedBody) {
throw new RuntimeException(sprintf(
'The data cannot be set because the body was previously'
. ' forced to be set using the "%s::withBody()" method.',
self::class,
));
}
$new = clone $this;
$new->data = $data;
$new->dataStream = null;
$new->formatted = false;
return $new;
}
/**
* Returns the response data.
*
* If the response data is a PHP callable, the result of the PHP callable execute will be returned.
* If the response data or the result of the execution of the PHP callable is an object,
* a cloned copy of this object will be returned.
*
* @return mixed
*/
public function getData()
{
if (is_callable($this->data)) {
$this->data = ($this->data)();
}
return is_object($this->data) ? clone $this->data : $this->data;
}
/**
* Checks whether the response data has been set.
*
* @return bool Whether the response data has been set.
*/
public function hasData(): bool
{
return $this->getData() !== null;
}
/**
* Formats the response, if necessary.
*/
private function formatResponse(): void
{
if ($this->formatted || !$this->hasResponseFormatter()) {
return;
}
/** @psalm-var DataResponseFormatterInterface $this->responseFormatter */
$this->clearResponseBody();
$this->formatted = true;
$response = $this->responseFormatter->format($this);
if ($response instanceof self) {
throw new RuntimeException(sprintf(
'The "%s::format()" method should not return instance of "%s".',
DataResponseFormatterInterface::class,
self::class,
));
}
$this->response = $response;
}
/**
* Clears a response body.
*/
private function clearResponseBody(): void
{
if (!$this->forcedBody) {
ftruncate($this->resource, 0);
rewind($this->resource);
}
}
/**
* Creates a new response by retrieving and validating the stream resource.
*
* @param int $code The response status code.
* @param string $reasonPhrase The response reason phrase associated with the status code.
* @param ResponseFactoryInterface $responseFactory The response factory instance.
* @param StreamFactoryInterface $streamFactory The stream factory instance.
*
* @throws RuntimeException If the stream resource is not valid.
*/
private function createResponse(
int $code,
string $reasonPhrase,
ResponseFactoryInterface $responseFactory,
StreamFactoryInterface $streamFactory
): void {
$response = $responseFactory->createResponse($code, $reasonPhrase);
$stream = $response->getBody();
if (!$stream->isReadable()) {
throw new RuntimeException('Stream is not readable.');
}
if (!$stream->isSeekable()) {
throw new RuntimeException('Stream is not seekable.');
}
if (!$stream->isWritable()) {
throw new RuntimeException('Stream is not writable.');
}
if (!is_resource($resource = $stream->detach())) {
throw new RuntimeException('Resource was not separated from the stream.');
}
$this->resource = $resource;
$this->response = $response->withBody($streamFactory->createStreamFromResource($this->resource));
}
}