-
Notifications
You must be signed in to change notification settings - Fork 106
Expand file tree
/
Copy pathClientSerializer.php
More file actions
306 lines (263 loc) · 7.59 KB
/
Copy pathClientSerializer.php
File metadata and controls
306 lines (263 loc) · 7.59 KB
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
<?php
/*
* Copyright 2024 Cloud Creativity Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
namespace CloudCreativity\LaravelJsonApi\Client;
use CloudCreativity\LaravelJsonApi\Contracts\Http\Query\QueryParametersInterface;
use CloudCreativity\LaravelJsonApi\Contracts\Encoder\SerializerInterface;
use CloudCreativity\LaravelJsonApi\Factories\Factory;
use Illuminate\Support\Collection;
/**
* Class ClientSerializer
*
* @package CloudCreativity\LaravelJsonApi
*/
class ClientSerializer
{
/**
* @var SerializerInterface
*/
protected $serializer;
/**
* @var Factory;
*/
protected $factory;
/**
* @var bool
*/
private $links;
/**
* @var array|null
*/
private $includePaths;
/**
* @var bool
*/
private $compoundDocuments;
/**
* @var array|null
*/
private $fieldsets;
/**
* ClientSerializer constructor.
*
* @param SerializerInterface $serializer
* @param Factory $factory
*/
public function __construct(SerializerInterface $serializer, Factory $factory)
{
$this->serializer = $serializer;
$this->factory = $factory;
$this->links = false;
$this->includePaths = null;
$this->fieldsets = null;
$this->compoundDocuments = false;
}
/**
* @param bool $links
* @return ClientSerializer
*/
public function withLinks($links = true)
{
$copy = clone $this;
$copy->links = $links;
return $copy;
}
/**
* @param string ...$paths
* @return ClientSerializer
*/
public function withIncludePaths(...$paths)
{
$copy = clone $this;
$copy->includePaths = $paths ?: null;
return $copy;
}
/**
* @param bool $bool
* @return ClientSerializer
*/
public function withCompoundDocuments($bool = true)
{
$copy = clone $this;
$copy->compoundDocuments = $bool;
return $copy;
}
/**
* @param string $resourceType
* @param string|string[] $fields
* @return ClientSerializer
*/
public function withFieldsets($resourceType, $fields)
{
$fieldsets = $this->fieldsets ?: [];
if ($fields) {
$fieldsets[$resourceType] = (array) $fields;
} else {
unset($fieldsets[$resourceType]);
}
$copy = clone $this;
$copy->fieldsets = $fieldsets ?: null;
return $copy;
}
/**
* Serialize a domain record.
*
* @param $record
* @param mixed|null $meta
* @param mixed|null $links
* @return array
*/
public function serialize($record, $meta = null, array $links = [])
{
$serializer = $this->setupSerializer();
$serializer->withMeta($meta)->withLinks($links);
$serialized = $serializer->serializeData($record, $this->createEncodingParameters());
$resourceLinks = null;
if (empty($serialized['data']['id'])) {
unset($serialized['data']['id']);
$resourceLinks = false; // links will not be valid so strip them out.
}
$resource = $this->parsePrimaryResource($serialized['data'], $resourceLinks);
$document = ['data' => $resource];
if (isset($serialized['included']) && $this->doesSerializeCompoundDocuments()) {
$document['included'] = $this->parseIncludedResources($serialized['included']);
}
return $document;
}
/**
* Serialize related record(s).
*
* @param object|iterable|array|null $related
* @param mixed|null $meta
* @param array $links
* @return array
*/
public function serializeRelated($related, $meta = null, array $links = [])
{
$serializer = $this->setupSerializer();
$serializer->withMeta($meta)->withLinks($links);
return $serializer->serializeIdentifiers($related);
}
/**
* @param array $resource
* @param bool|null $links
* @return array
*/
protected function parsePrimaryResource(array $resource, $links = null)
{
return $this->parseResource($resource, true, $links);
}
/**
* @param array $resources
* @return Collection
*/
protected function parseIncludedResources(array $resources)
{
return $this->parseResources($resources, false);
}
/**
* @param array $resources
* @param bool $primary
* @return Collection
*/
protected function parseResources(array $resources, $primary = false)
{
return collect($resources)->map(function (array $resource) use ($primary) {
return $this->parseResource($resource, $primary);
});
}
/**
* @param array $resource
* @param bool $primary
* @param bool|null $links
* @return array
*/
protected function parseResource(array $resource, $primary = false, $links = null)
{
if (false === $links || $this->doesRemoveLinks()) {
unset($resource['links']);
}
$relationships = isset($resource['relationships']) ?
$this->parseRelationships($resource['relationships'], $primary, $links) : [];
if ($relationships) {
$resource['relationships'] = $relationships;
} else {
unset($resource['relationships']);
}
return $resource;
}
/**
* @param array $relationships
* @param bool $primary
* @param bool|null $links
* @return array
*/
protected function parseRelationships(array $relationships, $primary = false, $links = null)
{
return collect($relationships)->reject(function (array $relation) use ($primary) {
return $primary && !array_key_exists('data', $relation);
})->map(function (array $relation) use ($primary, $links) {
return $this->parseRelationship($relation, $primary, $links);
})->filter()->all();
}
/**
* @param array $relationship
* @param bool $primary
* @param null $links
* @return array|null
*/
protected function parseRelationship(array $relationship, $primary = false, $links = null)
{
if (false === $links || $this->doesRemoveLinks()) {
unset($relationship['links']);
}
return $relationship ?: null;
}
/**
* @return bool
*/
protected function doesSerializeCompoundDocuments()
{
return $this->compoundDocuments;
}
/**
* @return bool
*/
protected function doesRemoveLinks()
{
return !$this->links;
}
/**
* @return QueryParametersInterface
*/
protected function createEncodingParameters()
{
return $this->factory->createQueryParameters(
$this->includePaths,
$this->fieldsets
);
}
/**
* @return SerializerInterface
*/
private function setupSerializer(): SerializerInterface
{
$serializer = clone $this->serializer;
$serializer->withIncludedPaths($this->includePaths ?? []);
$serializer->withFieldSets($this->fieldsets ?? []);
return $serializer;
}
}