/
Fractal.php
506 lines (421 loc) · 12 KB
/
Fractal.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
<?php
namespace Spatie\Fractalistic;
use Traversable;
use JsonSerializable;
use League\Fractal\Manager;
use League\Fractal\Pagination\CursorInterface;
use League\Fractal\Pagination\PaginatorInterface;
use Spatie\Fractalistic\Exceptions\InvalidTransformation;
use Spatie\Fractalistic\Exceptions\NoTransformerSpecified;
class Fractal implements JsonSerializable
{
/** @var \League\Fractal\Manager */
protected $manager;
/** @var int */
protected $recursionLimit = 10;
/** @var string|\League\Fractal\Serializer\SerializerAbstract */
protected $serializer;
/** @var string|callable|\League\Fractal\TransformerAbstract */
protected $transformer;
/** @var \League\Fractal\Pagination\PaginatorInterface */
protected $paginator;
/** @var \League\Fractal\Pagination\CursorInterface */
protected $cursor;
/** @var array */
protected $includes = [];
/** @var array */
protected $excludes = [];
/** @var array */
protected $fieldsets = [];
/** @var string */
protected $dataType;
/** @var mixed */
protected $data;
/** @var string */
protected $resourceName;
/** @var array */
protected $meta = [];
/**
* @param null|mixed $data
* @param null|string|callable|\League\Fractal\TransformerAbstract $transformer
* @param null|string|\League\Fractal\Serializer\SerializerAbstract $serializer
*
* @return \Spatie\Fractalistic\Fractal
*/
public static function create($data = null, $transformer = null, $serializer = null)
{
$instance = new static(new Manager());
$instance->data = $data;
$instance->dataType = $instance->determineDataType($data);
$instance->transformer = $transformer ?: null;
$instance->serializer = $serializer ?: null;
return $instance;
}
/** @param \League\Fractal\Manager $manager */
public function __construct(Manager $manager)
{
$this->manager = $manager;
}
/**
* Set the collection data that must be transformed.
*
* @param mixed $data
* @param null|string|callable|\League\Fractal\TransformerAbstract $transformer
* @param null|string $resourceName
*
* @return $this
*/
public function collection($data, $transformer = null, $resourceName = null)
{
if (! is_null($resourceName)) {
$this->resourceName = $resourceName;
}
return $this->data('collection', $data, $transformer);
}
/**
* Set the item data that must be transformed.
*
* @param mixed $data
* @param null|string|callable|\League\Fractal\TransformerAbstract $transformer
* @param null|string $resourceName
*
* @return $this
*/
public function item($data, $transformer = null, $resourceName = null)
{
if (! is_null($resourceName)) {
$this->resourceName = $resourceName;
}
return $this->data('item', $data, $transformer);
}
/**
* Set the primitive data that must be transformed.
*
* @param mixed $data
* @param null|string|callable|\League\Fractal\TransformerAbstract $transformer
* @param null|string $resourceName
*
* @return $this
*/
public function primitive($data, $transformer = null, $resourceName = null)
{
if (! is_null($resourceName)) {
$this->resourceName = $resourceName;
}
return $this->data('primitive', $data, $transformer);
}
/**
* Set the data that must be transformed.
*
* @param string $dataType
* @param mixed $data
* @param null|string|callable|\League\Fractal\TransformerAbstract $transformer
*
* @return $this
*/
public function data($dataType, $data, $transformer = null)
{
$this->dataType = $dataType;
$this->data = $data;
if (! is_null($transformer)) {
$this->transformer = $transformer;
}
return $this;
}
/**
* @param mixed $data
*
* @return string
*/
protected function determineDataType($data)
{
if (is_null($data)) {
return 'NullResource';
}
if (is_array($data)) {
return 'collection';
}
if ($data instanceof Traversable) {
return 'collection';
}
return 'item';
}
/**
* Set the class or function that will perform the transform.
*
* @param string|callable|\League\Fractal\TransformerAbstract $transformer
*
* @return $this
*/
public function transformWith($transformer)
{
$this->transformer = $transformer;
return $this;
}
/**
* Set the serializer to be used.
*
* @param string|\League\Fractal\Serializer\SerializerAbstract $serializer
*
* @return $this
*/
public function serializeWith($serializer)
{
$this->serializer = $serializer;
return $this;
}
/**
* Set a Fractal paginator for the data.
*
* @param \League\Fractal\Pagination\PaginatorInterface $paginator
*
* @return $this
*/
public function paginateWith(PaginatorInterface $paginator)
{
$this->paginator = $paginator;
return $this;
}
/**
* Set a Fractal cursor for the data.
*
* @param \League\Fractal\Pagination\CursorInterface $cursor
*
* @return $this
*/
public function withCursor(CursorInterface $cursor)
{
$this->cursor = $cursor;
return $this;
}
/**
* Specify the includes.
*
* @param array|string $includes Array or string of resources to include.
*
* @return $this
*/
public function parseIncludes($includes)
{
$includes = $this->normalizeIncludesOrExcludes($includes);
$this->includes = array_merge($this->includes, (array) $includes);
return $this;
}
/**
* Specify the excludes.
*
* @param array|string $excludes Array or string of resources to exclude.
*
* @return $this
*/
public function parseExcludes($excludes)
{
$excludes = $this->normalizeIncludesOrExcludes($excludes);
$this->excludes = array_merge($this->excludes, (array) $excludes);
return $this;
}
/**
* Specify the fieldsets to include in the response.
*
* @param array $fieldsets array with key = resourceName and value = fields to include
* (array or comma separated string with field names)
*
* @return $this
*/
public function parseFieldsets(array $fieldsets)
{
foreach ($fieldsets as $key => $fields) {
if (is_array($fields)) {
$fieldsets[$key] = implode(',', $fields);
}
}
$this->fieldsets = array_merge($this->fieldsets, $fieldsets);
return $this;
}
/**
* Normalize the includes an excludes.
*
* @param array|string $includesOrExcludes
*
* @return array|string
*/
protected function normalizeIncludesOrExcludes($includesOrExcludes = '')
{
if (! is_string($includesOrExcludes)) {
return $includesOrExcludes;
}
return array_map(function ($value) {
return trim($value);
}, explode(',', $includesOrExcludes));
}
/**
* Set the meta data.
*
* @param $array,...
*
* @return $this
*/
public function addMeta()
{
foreach (func_get_args() as $meta) {
if (is_array($meta)) {
$this->meta += $meta;
}
}
return $this;
}
/**
* Set the resource name, to replace 'data' as the root of the collection or item.
*
* @param string $resourceName
*
* @return $this
*/
public function withResourceName($resourceName)
{
$this->resourceName = $resourceName;
return $this;
}
/**
* Upper limit to how many levels of included data are allowed.
*
* @param int $recursionLimit
*
* @return $this
*/
public function limitRecursion(int $recursionLimit)
{
$this->recursionLimit = $recursionLimit;
return $this;
}
/**
* Perform the transformation to json.
*
* @param int $options
*
* @return string
*/
public function toJson($options = 0)
{
return $this->createData()->toJson($options);
}
/**
* Perform the transformation to array.
*
* @return array
*/
public function toArray()
{
return $this->createData()->toArray();
}
/**
* Create fractal data.
*
* @return \League\Fractal\Scope
*
* @throws \Spatie\Fractalistic\Exceptions\InvalidTransformation
* @throws \Spatie\Fractalistic\Exceptions\NoTransformerSpecified
*/
public function createData()
{
if (is_null($this->transformer)) {
throw new NoTransformerSpecified();
}
if (is_string($this->serializer)) {
$this->serializer = new $this->serializer;
}
if (! is_null($this->serializer)) {
$this->manager->setSerializer($this->serializer);
}
$this->manager->setRecursionLimit($this->recursionLimit);
if (! empty($this->includes)) {
$this->manager->parseIncludes($this->includes);
}
if (! empty($this->excludes)) {
$this->manager->parseExcludes($this->excludes);
}
if (! empty($this->fieldsets)) {
$this->manager->parseFieldsets($this->fieldsets);
}
return $this->manager->createData($this->getResource());
}
/**
* Get the resource.
*
* @return \League\Fractal\Resource\ResourceInterface
*
* @throws \Spatie\Fractalistic\Exceptions\InvalidTransformation
*/
public function getResource()
{
$resourceClass = 'League\\Fractal\\Resource\\'.ucfirst($this->dataType);
if (! class_exists($resourceClass)) {
throw new InvalidTransformation();
}
if (is_string($this->transformer)) {
$this->transformer = new $this->transformer;
}
$resource = new $resourceClass($this->data, $this->transformer, $this->resourceName);
$resource->setMeta($this->meta);
if (! is_null($this->paginator)) {
$resource->setPaginator($this->paginator);
}
if (! is_null($this->cursor)) {
$resource->setCursor($this->cursor);
}
return $resource;
}
/**
* Return the name of the resource.
*
* @return string
*/
public function getResourceName()
{
return $this->resourceName;
}
/**
* Convert the object into something JSON serializable.
*/
public function jsonSerialize()
{
return $this->toArray();
}
/**
* Support for magic methods to included data.
*
* @param string $name
* @param array $arguments
*
* @return $this
*/
public function __call($name, array $arguments)
{
if ($this->startsWith($name, ['include'])) {
$includeName = lcfirst(substr($name, strlen('include')));
return $this->parseIncludes($includeName);
}
if ($this->startsWith($name, ['exclude'])) {
$excludeName = lcfirst(substr($name, strlen('exclude')));
return $this->parseExcludes($excludeName);
}
trigger_error('Call to undefined method '.__CLASS__.'::'.$name.'()', E_USER_ERROR);
}
/**
* Determine if a given string starts with a given substring.
*
* @param string $haystack
* @param string|array $needles
*
* @return bool
*/
protected function startsWith($haystack, $needles)
{
foreach ((array) $needles as $needle) {
if ($needle != '' && substr($haystack, 0, strlen($needle)) === (string) $needle) {
return true;
}
}
return false;
}
}