|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
namespace Flugg\Responder\Resources; |
|
4
|
|
|
|
|
5
|
|
|
use Flugg\Responder\Contracts\Resources\ResourceFactory as ResourceFactoryContract; |
|
6
|
|
|
use Flugg\Responder\Contracts\Resources\ResourceKeyResolver as ResourceKeyResolverContract; |
|
7
|
|
|
use Flugg\Responder\Contracts\Transformers\TransformerResolver; |
|
8
|
|
|
use Illuminate\Support\Arr; |
|
9
|
|
|
use League\Fractal\Resource\Collection as CollectionResource; |
|
10
|
|
|
use League\Fractal\Resource\Item as ItemResource; |
|
11
|
|
|
use League\Fractal\Resource\NullResource; |
|
12
|
|
|
use League\Fractal\Resource\ResourceInterface; |
|
13
|
|
|
use Traversable; |
|
14
|
|
|
|
|
15
|
|
|
/** |
|
16
|
|
|
* This class is responsible for making Fractal resources from a variety of data types. |
|
17
|
|
|
* |
|
18
|
|
|
* @package flugger/laravel-responder |
|
19
|
|
|
* @author Alexander Tømmerås <[email protected]> |
|
20
|
|
|
* @license The MIT License |
|
21
|
|
|
*/ |
|
22
|
|
|
class ResourceFactory implements ResourceFactoryContract |
|
23
|
|
|
{ |
|
24
|
|
|
/** |
|
25
|
|
|
* A service class, used to normalize data. |
|
26
|
|
|
* |
|
27
|
|
|
* @var \Flugg\Responder\Resources\DataNormalizer |
|
28
|
|
|
*/ |
|
29
|
|
|
protected $normalizer; |
|
30
|
|
|
|
|
31
|
|
|
/** |
|
32
|
|
|
* A resolver class, used to resolve resource keys. |
|
33
|
|
|
* |
|
34
|
|
|
* @var \Flugg\Responder\Contracts\Transformers\TransformerResolver |
|
35
|
|
|
*/ |
|
36
|
|
|
protected $transformerResolver; |
|
37
|
|
|
|
|
38
|
|
|
/** |
|
39
|
|
|
* A resolver class, used to resolve resource keys. |
|
40
|
|
|
* |
|
41
|
|
|
* @var \Flugg\Responder\Contracts\Resources\ResourceKeyResolver |
|
42
|
|
|
*/ |
|
43
|
|
|
protected $resourceKeyResolver; |
|
44
|
|
|
|
|
45
|
|
|
/** |
|
46
|
|
|
* Construct the factory class. |
|
47
|
|
|
* |
|
48
|
|
|
* @param \Flugg\Responder\Resources\DataNormalizer $normalizer |
|
49
|
|
|
* @param \Flugg\Responder\Contracts\Transformers\TransformerResolver $transformerResolver |
|
50
|
|
|
* @param \Flugg\Responder\Contracts\Resources\ResourceKeyResolver $resourceKeyResolver |
|
51
|
|
|
*/ |
|
52
|
6 |
|
public function __construct(DataNormalizer $normalizer, TransformerResolver $transformerResolver, ResourceKeyResolverContract $resourceKeyResolver) |
|
53
|
|
|
{ |
|
54
|
6 |
|
$this->normalizer = $normalizer; |
|
55
|
6 |
|
$this->transformerResolver = $transformerResolver; |
|
56
|
6 |
|
$this->resourceKeyResolver = $resourceKeyResolver; |
|
57
|
6 |
|
} |
|
58
|
|
|
|
|
59
|
|
|
/** |
|
60
|
|
|
* Make resource from the given data. |
|
61
|
|
|
* |
|
62
|
|
|
* @param mixed $data |
|
63
|
|
|
* @param \Flugg\Responder\Transformers\Transformer|string|callable|null $transformer |
|
64
|
|
|
* @param string|null $resourceKey |
|
65
|
|
|
* @return \League\Fractal\Resource\ResourceInterface |
|
66
|
|
|
*/ |
|
67
|
6 |
|
public function make($data = null, $transformer = null, string $resourceKey = null): ResourceInterface |
|
68
|
|
|
{ |
|
69
|
6 |
|
if ($data instanceof ResourceInterface) { |
|
70
|
1 |
|
return $this->makeFromResource($data, $transformer, $resourceKey); |
|
71
|
5 |
|
} elseif (is_null($data = $this->normalizer->normalize($data))) { |
|
72
|
1 |
|
return $this->instatiateResource($data, null, $resourceKey); |
|
73
|
|
|
} |
|
74
|
|
|
|
|
75
|
4 |
|
$transformer = $this->resolveTransformer($data, $transformer); |
|
76
|
4 |
|
$resourceKey = $this->resolveResourceKey($data, $resourceKey); |
|
77
|
|
|
|
|
78
|
4 |
|
return $this->instatiateResource($data, $transformer, $resourceKey); |
|
79
|
|
|
} |
|
80
|
|
|
|
|
81
|
|
|
/** |
|
82
|
|
|
* Make resource from the given resource. |
|
83
|
|
|
* |
|
84
|
|
|
* @param \League\Fractal\Resource\ResourceInterface $resource |
|
85
|
|
|
* @param \Flugg\Responder\Transformers\Transformer|string|callable|null $transformer |
|
86
|
|
|
* @param string|null $resourceKey |
|
87
|
|
|
* @return \League\Fractal\Resource\ResourceInterface |
|
88
|
|
|
*/ |
|
89
|
1 |
|
public function makeFromResource(ResourceInterface $resource, $transformer = null, string $resourceKey = null): ResourceInterface |
|
90
|
|
|
{ |
|
91
|
1 |
|
$transformer = $this->resolveTransformer($resource->getData(), $transformer ?: $resource->getTransformer()); |
|
92
|
1 |
|
$resourceKey = $this->resolveResourceKey($resource->getData(), $resourceKey ?: $resource->getResourceKey()); |
|
93
|
|
|
|
|
94
|
1 |
|
return $resource->setTransformer($transformer)->setResourceKey($resourceKey); |
|
95
|
|
|
} |
|
96
|
|
|
|
|
97
|
|
|
/** |
|
98
|
|
|
* Instatiate a new resource instance. |
|
99
|
|
|
* |
|
100
|
|
|
* @param mixed $data |
|
101
|
|
|
* @param \Flugg\Responder\Transformers\Transformer|callable|null $transformer |
|
102
|
|
|
* @param string|null $resourceKey |
|
103
|
|
|
* @return \League\Fractal\Resource\ResourceInterface |
|
104
|
|
|
*/ |
|
105
|
5 |
|
protected function instatiateResource($data, $transformer = null, string $resourceKey = null): ResourceInterface |
|
106
|
|
|
{ |
|
107
|
5 |
|
if (is_null($data)) { |
|
108
|
1 |
|
return new NullResource(null, null, $resourceKey); |
|
109
|
4 |
|
} elseif ($this->shouldCreateCollection($data)) { |
|
110
|
1 |
|
return new CollectionResource($data, $transformer, $resourceKey); |
|
111
|
|
|
} |
|
112
|
|
|
|
|
113
|
3 |
|
return new ItemResource($data, $transformer, $resourceKey); |
|
114
|
|
|
} |
|
115
|
|
|
|
|
116
|
|
|
/** |
|
117
|
|
|
* Indicates if the data belongs to a collection resource. |
|
118
|
|
|
* |
|
119
|
|
|
* @param mixed $data |
|
120
|
|
|
* @return bool |
|
121
|
|
|
*/ |
|
122
|
4 |
|
protected function shouldCreateCollection($data): bool |
|
123
|
|
|
{ |
|
124
|
4 |
|
if (is_array($data)) { |
|
125
|
2 |
|
return ! is_scalar(Arr::first($data)); |
|
126
|
|
|
} |
|
127
|
|
|
|
|
128
|
2 |
|
return $data instanceof Traversable; |
|
129
|
|
|
} |
|
130
|
|
|
|
|
131
|
|
|
/** |
|
132
|
|
|
* Resolve a transformer. |
|
133
|
|
|
* |
|
134
|
|
|
* @param mixed $data |
|
135
|
|
|
* @param \Flugg\Responder\Transformers\Transformer|string|callable|null $transformer |
|
136
|
|
|
* @return \Flugg\Responder\Transformers\Transformer|callable |
|
137
|
|
|
*/ |
|
138
|
5 |
|
protected function resolveTransformer($data, $transformer) |
|
139
|
|
|
{ |
|
140
|
5 |
|
if (isset($transformer)) { |
|
141
|
3 |
|
return $this->transformerResolver->resolve($transformer); |
|
142
|
|
|
} |
|
143
|
|
|
|
|
144
|
2 |
|
return $this->transformerResolver->resolveFromData($data); |
|
145
|
|
|
} |
|
146
|
|
|
|
|
147
|
|
|
/** |
|
148
|
|
|
* Resolve a resource key. |
|
149
|
|
|
* |
|
150
|
|
|
* @param mixed $data |
|
151
|
|
|
* @param string|null $resourceKey |
|
152
|
|
|
* @return null|string |
|
153
|
|
|
*/ |
|
154
|
5 |
|
protected function resolveResourceKey($data, string $resourceKey = null) |
|
155
|
|
|
{ |
|
156
|
5 |
|
return isset($resourceKey) ? $resourceKey : $this->resourceKeyResolver->resolve($data); |
|
157
|
|
|
} |
|
158
|
|
|
} |
flugger /
laravel-responder
