forked from FriendsOfSymfony/FOSRestBundle
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathView.php
507 lines (441 loc) · 9.29 KB
/
View.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
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
<?php
/*
* This file is part of the FOSRestBundle package.
*
* (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace FOS\RestBundle\View;
use FOS\RestBundle\Context\Context;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Templating\TemplateReferenceInterface;
/**
* Default View implementation.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
* @author Lukas K. Smith <smith@pooteeweet.org>
*/
class View
{
/**
* @var mixed|null
*/
private $data;
/**
* @var int|null
*/
private $statusCode;
/**
* @var mixed|null
*/
private $templateData = [];
/**
* @var TemplateReference|string|null
*/
private $template;
/**
* @var string|null
*/
private $templateVar;
/**
* @var string|null
*/
private $engine;
/**
* @var string|null
*/
private $format;
/**
* @var string|null
*/
private $location;
/**
* @var string|null
*/
private $route;
/**
* @var array|null
*/
private $routeParameters;
/**
* @var Context
*/
private $context;
/**
* @var Response
*/
private $response;
/**
* Convenience method to allow for a fluent interface.
*
* @param mixed $data
* @param int $statusCode
* @param array $headers
*
* @return static
*/
public static function create($data = null, $statusCode = null, array $headers = [])
{
return new static($data, $statusCode, $headers);
}
/**
* Convenience method to allow for a fluent interface while creating a redirect to a
* given url.
*
* @param string $url
* @param int $statusCode
* @param array $headers
*
* @return static
*/
public static function createRedirect($url, $statusCode = Response::HTTP_FOUND, array $headers = [])
{
$view = static::create(null, $statusCode, $headers);
$view->setLocation($url);
return $view;
}
/**
* Convenience method to allow for a fluent interface while creating a redirect to a
* given route.
*
* @param string $route
* @param array $parameters
* @param int $statusCode
* @param array $headers
*
* @return static
*/
public static function createRouteRedirect(
$route,
array $parameters = [],
$statusCode = Response::HTTP_FOUND,
array $headers = []
) {
$view = static::create(null, $statusCode, $headers);
$view->setRoute($route);
$view->setRouteParameters($parameters);
return $view;
}
/**
* Constructor.
*
* @param mixed $data
* @param int $statusCode
* @param array $headers
*/
public function __construct($data = null, $statusCode = null, array $headers = [])
{
$this->setData($data);
$this->setStatusCode($statusCode);
$this->setTemplateVar('data');
if (!empty($headers)) {
$this->getResponse()->headers->replace($headers);
}
}
/**
* Sets the data.
*
* @param mixed $data
*
* @return View
*/
public function setData($data)
{
$this->data = $data;
return $this;
}
/**
* Set template variable.
*
* @param array|callable $data
*
* @return View
*/
public function setTemplateData($data = [])
{
$this->templateData = $data;
return $this;
}
/**
* Sets a header.
*
* @param string $name
* @param string $value
*
* @return View
*/
public function setHeader($name, $value)
{
$this->getResponse()->headers->set($name, $value);
return $this;
}
/**
* Sets the headers.
*
* @param array $headers
*
* @return View
*/
public function setHeaders(array $headers)
{
$this->getResponse()->headers->replace($headers);
return $this;
}
/**
* Sets the HTTP status code.
*
* @param int|null $code
*
* @return View
*/
public function setStatusCode($code)
{
if (null !== $code) {
$this->statusCode = $code;
}
return $this;
}
/**
* Sets the serialization context.
*
* @param Context $context
*
* @return View
*/
public function setContext(Context $context)
{
$this->context = $context;
return $this;
}
/**
* Sets template to use for the encoding.
*
* @param string|TemplateReferenceInterface $template
*
* @return View
*
* @throws \InvalidArgumentException if the template is neither a string nor an instance of TemplateReferenceInterface
*/
public function setTemplate($template)
{
if (!(is_string($template) || $template instanceof TemplateReferenceInterface)) {
throw new \InvalidArgumentException('The template should be a string or implement TemplateReferenceInterface');
}
$this->template = $template;
return $this;
}
/**
* Sets template variable name to be used in templating formats.
*
* @param string $templateVar
*
* @return View
*/
public function setTemplateVar($templateVar)
{
$this->templateVar = $templateVar;
return $this;
}
/**
* Sets the engine.
*
* @param string $engine
*
* @return View
*/
public function setEngine($engine)
{
$this->engine = $engine;
return $this;
}
/**
* Sets the format.
*
* @param string $format
*
* @return View
*/
public function setFormat($format)
{
$this->format = $format;
return $this;
}
/**
* Sets the location (implicitly removes the route).
*
* @param string $location
*
* @return View
*/
public function setLocation($location)
{
$this->location = $location;
$this->route = null;
return $this;
}
/**
* Sets the route (implicitly removes the location).
*
* @param string $route
*
* @return View
*/
public function setRoute($route)
{
$this->route = $route;
$this->location = null;
return $this;
}
/**
* Sets route data.
*
* @param array $parameters
*
* @return View
*/
public function setRouteParameters($parameters)
{
$this->routeParameters = $parameters;
return $this;
}
/**
* Sets the response.
*
* @param Response $response
*
* @return View
*/
public function setResponse(Response $response)
{
$this->response = $response;
return $this;
}
/**
* Gets the data.
*
* @return mixed|null
*/
public function getData()
{
return $this->data;
}
/**
* Gets the template data.
*
* @return mixed|null
*/
public function getTemplateData()
{
return $this->templateData;
}
/**
* Gets the HTTP status code.
*
* @return int|null
*/
public function getStatusCode()
{
return $this->statusCode;
}
/**
* Gets the headers.
*
* @return array
*/
public function getHeaders()
{
return $this->getResponse()->headers->all();
}
/**
* Gets the template.
*
* @return TemplateReferenceInterface|string|null
*/
public function getTemplate()
{
return $this->template;
}
/**
* Gets the template variable name.
*
* @return string|null
*/
public function getTemplateVar()
{
return $this->templateVar;
}
/**
* Gets the engine.
*
* @return string|null
*/
public function getEngine()
{
return $this->engine;
}
/**
* Gets the format.
*
* @return string|null
*/
public function getFormat()
{
return $this->format;
}
/**
* Gets the location.
*
* @return string|null
*/
public function getLocation()
{
return $this->location;
}
/**
* Gets the route.
*
* @return string|null
*/
public function getRoute()
{
return $this->route;
}
/**
* Gets route parameters.
*
* @return array|null
*/
public function getRouteParameters()
{
return $this->routeParameters;
}
/**
* Gets the response.
*
* @return Response
*/
public function getResponse()
{
if (null === $this->response) {
$this->response = new Response();
if (null !== ($code = $this->getStatusCode())) {
$this->response->setStatusCode($code);
}
}
return $this->response;
}
/**
* Gets the serialization context.
*
* @return Context
*/
public function getContext()
{
if (null === $this->context) {
$this->context = new Context();
}
return $this->context;
}
}