-
-
Notifications
You must be signed in to change notification settings - Fork 24
/
DataProvider.php
403 lines (349 loc) · 12.7 KB
/
DataProvider.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
<?php
declare(strict_types=1);
namespace Cundd\Rest\DataProvider;
use Cundd\Rest\Domain\Model\ResourceType;
use Cundd\Rest\Exception\ClassLoadingException;
use Cundd\Rest\Exception\InvalidArgumentException;
use Cundd\Rest\Exception\InvalidPropertyException;
use Cundd\Rest\ObjectManagerInterface;
use Cundd\Rest\Persistence\Generic\RestQuerySettings;
use Cundd\Rest\SingletonInterface;
use Exception;
use Psr\Log\LoggerInterface;
use Psr\Log\LogLevel;
use TYPO3\CMS\Core\Log\LogManager;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface;
use TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface;
use TYPO3\CMS\Extbase\Persistence\PersistenceManagerInterface;
use TYPO3\CMS\Extbase\Persistence\RepositoryInterface;
use TYPO3\CMS\Extbase\Property\Exception as ExtbaseException;
use TYPO3\CMS\Extbase\Property\PropertyMapper;
use TYPO3\CMS\Extbase\Property\PropertyMappingConfiguration;
use TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationBuilder;
use function sprintf;
/**
* Data Provider implementation for Extbase based Models
*/
class DataProvider implements DataProviderInterface, ClassLoadingInterface, SingletonInterface
{
/**
* @var ObjectManagerInterface
*/
protected $objectManager;
/**
* @var ExtractorInterface
*/
protected $extractor;
/**
* Logger instance
*
* @var LoggerInterface
*/
protected $logger;
/**
* @var IdentityProviderInterface
*/
protected $identityProvider;
/**
* Data Provider constructor
*
* @param ObjectManagerInterface $objectManager
* @param ExtractorInterface $extractor
* @param IdentityProviderInterface $identityProvider
* @param LoggerInterface|null $logger
*/
public function __construct(
ObjectManagerInterface $objectManager,
ExtractorInterface $extractor,
IdentityProviderInterface $identityProvider,
LoggerInterface $logger = null
) {
$this->objectManager = $objectManager;
$this->extractor = $extractor;
$this->logger = $logger;
$this->identityProvider = $identityProvider;
}
public function getModelData($model)
{
return $this->extractor->extract($model);
}
public function getRepositoryClassForResourceType(ResourceType $resourceType): string
{
[$vendor, $extension, $model] = Utility::getClassNamePartsForResourceType($resourceType);
return ($vendor ? $vendor . '\\' : '') . $extension . '\\Domain\\Repository\\' . $model . 'Repository';
}
public function getRepositoryForResourceType(ResourceType $resourceType)
{
$repositoryClass = $this->getRepositoryClassForResourceType($resourceType);
$repository = null;
$exception = null;
/** @var RepositoryInterface|null $repository */
try {
$repository = $this->objectManager->get($repositoryClass);
} catch (Exception $exception) {
}
if (!$repository) {
$triedClasses = sprintf('Tried the following classes: "%s"', $repositoryClass);
if ($exception) {
$message = sprintf(
'Repository for resource type "%s" could not be created: %s %s',
$resourceType,
$exception->getMessage(),
$triedClasses
);
throw new ClassLoadingException($message, 1542116783, $exception);
} else {
$message = sprintf(
'Repository for resource type "%s" could not be found. %s',
$resourceType,
$triedClasses
);
throw new ClassLoadingException($message, 1542116782);
}
}
/** @var QuerySettingsInterface $defaultQuerySettings */
$defaultQuerySettings = $this->objectManager->get(RestQuerySettings::class);
$repository->setDefaultQuerySettings($defaultQuerySettings);
return $repository;
}
public function getModelClassForResourceType(ResourceType $resourceType): string
{
$modelEntityForResourceType = Utility::getModelEntityForResourceType($resourceType);
if ($modelEntityForResourceType && class_exists($modelEntityForResourceType)) {
return $modelEntityForResourceType;
}
return '';
}
public function fetchAllModels(ResourceType $resourceType): iterable
{
return $this->getRepositoryForResourceType($resourceType)->findAll();
}
public function countAllModels(ResourceType $resourceType): int
{
return $this->getRepositoryForResourceType($resourceType)->countAll();
}
public function fetchModel($identifier, ResourceType $resourceType): ?object
{
if ($identifier && is_scalar($identifier)) { // If it is a scalar treat it as identity
return $this->getModelWithIdentityForResourceType($identifier, $resourceType);
}
return null;
}
public function createModel(array $data, ResourceType $resourceType)
{
// If no data is given return a new empty instance
if (!$data) {
return $this->getEmptyModelForResourceType($resourceType);
}
// It is **not** allowed to insert Models with a defined UID
if (isset($data['__identity']) && $data['__identity']) {
return new InvalidPropertyException('Invalid property "__identity"');
} elseif (isset($data['uid']) && $data['uid']) {
return new InvalidPropertyException('Invalid property "uid"');
}
// Get a fresh model
return $this->convertIntoModel($data, $resourceType);
}
public function getModelProperty(object $model, string $propertyParameter)
{
InvalidArgumentException::assertObject($model);
$propertyKey = $this->convertPropertyParameterToKey($propertyParameter);
$normalizedGetter = 'get' . ucfirst($propertyKey);
if (method_exists($model, $normalizedGetter) && is_callable([$model, $normalizedGetter])) {
return $this->getModelData($model->$normalizedGetter());
}
$getter = 'get' . ucfirst($propertyParameter);
if (method_exists($model, $getter) && is_callable([$model, $getter])) {
return $this->getModelData($model->$getter());
}
if ($model instanceof DomainObjectInterface) {
$value = $model->_getProperty($propertyKey);
if (null !== $value) {
return $this->getModelData($value);
} else {
return $this->getModelData($model->_getProperty($propertyParameter));
}
}
return null;
}
public function saveModel(object $model, ResourceType $resourceType): void
{
$repository = $this->getRepositoryForResourceType($resourceType);
if ($this->isModelNew($model)) {
$repository->add($model);
} else {
$repository->update($model);
}
$this->persistAllChanges();
}
/**
* @param object $updatedModel
* @param ResourceType $resourceType
*/
public function updateModel(
object $updatedModel,
ResourceType $resourceType
): void {
$repository = $this->getRepositoryForResourceType($resourceType);
$repository->update($updatedModel);
$this->persistAllChanges();
}
public function removeModel(object $model, ResourceType $resourceType): void
{
InvalidArgumentException::assertObjectOrNull($model);
$repository = $this->getRepositoryForResourceType($resourceType);
$repository->remove($model);
$this->persistAllChanges();
}
public function convertIntoModel(array $data, ResourceType $resourceType): ?object
{
$propertyMapper = $this->objectManager->get(PropertyMapper::class);
try {
return $propertyMapper->convert(
$this->prepareModelData($data),
$this->getModelClassForResourceType($resourceType),
$this->getPropertyMappingConfigurationForResourceType($resourceType)
);
} catch (ExtbaseException $exception) {
$this->logException($exception);
return null;
}
}
public function getEmptyModelForResourceType(ResourceType $resourceType)
{
return $this->objectManager->get($this->getModelClassForResourceType($resourceType));
}
/**
* Persist all changes to the database
*/
protected function persistAllChanges(): void
{
$persistenceManager = $this->objectManager->get(PersistenceManagerInterface::class);
$persistenceManager->persistAll();
}
/**
* Return the UID of the model with the given identifier
*
* @param mixed $identifier The identifier
* @param ResourceType $resourceType The resource type
* @return int|string|null Returns the UID or NULL if the object couldn't be found
*/
protected function getUidOfModelWithIdentityForResourceType($identifier, ResourceType $resourceType)
{
$model = $this->getModelWithIdentityForResourceType($identifier, $resourceType);
return $model ? $model->getUid() : null;
}
/**
* Convert incoming property parameter names into property keys
*
* Example:
* 'dog-name' => 'dogName'
*
* @param string $propertyParameter
* @return string
*/
protected function convertPropertyParameterToKey(string $propertyParameter): string
{
return str_replace(' ', '', ucwords(str_replace(['_', '-'], ' ', $propertyParameter)));
}
/**
* Return the configuration for property mapping
*
* @param ResourceType|string $resourceType
* @return PropertyMappingConfiguration
*/
protected function getPropertyMappingConfigurationForResourceType(
/** @noinspection PhpUnusedParameterInspection */
ResourceType $resourceType
): object {
return $this->objectManager->get(PropertyMappingConfigurationBuilder::class)->build();
}
/**
* Load the model with the given identifier
*
* @param mixed $identifier
* @param ResourceType|string $resourceType
* @return null|object
*/
protected function getModelWithIdentityForResourceType($identifier, ResourceType $resourceType): ?object
{
$repository = $this->getRepositoryForResourceType($resourceType);
// Tries to fetch the object by UID
$object = $repository->findByUid($identifier);
if ($object) {
return $object;
}
[$property, $type] = $this->identityProvider->getIdentityProperty(
$this->getModelClassForResourceType($resourceType)
);
switch ($type) {
case 'string':
$typeMatching = is_string($identifier);
break;
case 'boolean':
$typeMatching = is_bool($identifier);
break;
case 'integer':
$typeMatching = is_int($identifier);
break;
case 'float':
$typeMatching = is_float($identifier);
break;
case 'array':
default:
$typeMatching = false;
}
if ($typeMatching) {
$findMethod = 'findOneBy' . ucfirst($property);
return call_user_func([$repository, $findMethod], $identifier);
}
return null;
}
/**
* Prepares the given data before transforming it to a model
*
* @param array $data
* @return array
*/
protected function prepareModelData(array $data): array
{
return $data;
}
/**
* Returns the logger
*
* @return LoggerInterface
*/
protected function getLogger(): LoggerInterface
{
if (!$this->logger) {
$this->logger = GeneralUtility::makeInstance(LogManager::class)->getLogger(__CLASS__);
}
return $this->logger;
}
/**
* @param $exception
*/
protected function logException(Exception $exception)
{
$message = 'Uncaught exception #' . $exception->getCode() . ': ' . $exception->getMessage();
$this->getLogger()->log(LogLevel::ERROR, $message, ['exception' => $exception]);
}
/**
* Return if the given instance is not yet stored in the database
*
* @param object|DomainObjectInterface $model
* @return bool
*/
protected function isModelNew(object $model): bool
{
if ($model instanceof DomainObjectInterface) {
return $model->_isNew();
}
if (is_callable($model, 'getUid')) {
return $model->getUid() === null;
}
return true;
}
}