/
Model.php
executable file
·426 lines (385 loc) · 11.8 KB
/
Model.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
<?php
namespace Bdf\Prime\Entity;
use Bdf\Prime\Exception\PrimeException;
use Bdf\Prime\PrimeSerializable;
use Bdf\Prime\Query\Contract\ReadOperation;
use Bdf\Prime\Query\Contract\WriteOperation;
use Bdf\Prime\Query\QueryInterface;
use Bdf\Prime\Relations\EntityRelation;
use Bdf\Prime\Repository\EntityRepository;
use Bdf\Prime\Repository\RepositoryEventsSubscriberInterface;
use Bdf\Prime\Repository\RepositoryInterface;
use Bdf\Serializer\Metadata\Builder\ClassMetadataBuilder;
/**
* Model
*
* Active record pattern
*
* @psalm-type EntityCollection = \Bdf\Prime\Collection\EntityCollection<static>
* @psalm-type EntityQuery = QueryInterface<\Bdf\Prime\Connection\ConnectionInterface, static>
*
* @method static \Bdf\Prime\Collection\EntityCollection collection(array $entities = [])
* @psalm-method static EntityCollection collection(array<self> $entities = [])
* @method static Criteria criteria(array $criteria = [])
*
* @method static static|null get(mixed $key)
* @method static static getOrNew(mixed $key)
* @method static static getOrFail(mixed $key)
* @method static static|null findById(mixed $key)
* @method static static findByIdOrNew(mixed $key)
* @method static static findByIdOrFail(mixed $key)
* @method static static|null findOne(array $criteria, ?array $attributes = null)
*
* @method static QueryInterface where(string|array|callable $column, mixed|null $operator = null, mixed $value = null)
* @psalm-method static EntityQuery where(string|array|callable $column, mixed|null $operator = null, mixed $value = null)
* @method static QueryInterface with(string|array $relations)
* @psalm-method static EntityQuery with(string|array $relations)
* @method static QueryInterface by(string $attribute, bool $combine = false)
* @psalm-method static EntityQuery by(string $attribute, bool $combine = false)
* @method static QueryInterface filter(\Closure $filter)
* @psalm-method static EntityQuery filter(\Closure $filter)
*
* @method static int updateBy(array $attributes, array $criteria = [])
* @method static int count(array $criteria = [], $attributes = null)
* @method static bool exists(self $entity)
* @method static static|null refresh(self $entity)
*/
class Model extends PrimeSerializable implements EntityInterface, ImportableInterface
{
/**
* Exclude all properties from serialization
*
* @param ClassMetadataBuilder $builder
*
* @throws PrimeException
*
* @return void
*/
public static function loadSerializerMetadata(ClassMetadataBuilder $builder): void
{
if (!$repository = self::locator()->repository($builder->name())) {
return;
}
$mapperInfo = $repository->mapper()->info();
foreach ($mapperInfo->all() as $property) {
$groups = ['all'];
if ($property->isObject()) {
/** @var \Bdf\Prime\Mapper\Info\ObjectPropertyInfo $property */
if (!$property->belongsToRoot()) {
continue;
}
$type = $property->className();
if ($property->isArray()) {
$wrapper = $property->wrapper();
// Set wrapper class, if can be resolved (a custom wrapper, with a closure, cannot be serialized)
if ($wrapper && is_string($wrapper)) {
$type = self::locator()->repository($type)->collectionFactory()->wrapperClass($wrapper).'<'.ltrim($type, '\\').'>';
} else {
$type .= '[]';
}
}
} else {
/** @var \Bdf\Prime\Mapper\Info\PropertyInfo $property */
$type = $property->phpType();
if ($property->isPrimary()) {
$groups[] = 'identifier';
}
}
$builder->add($property->name(), ltrim($type, '\\'), ['groups' => $groups]);
}
}
/**
* {@inheritdoc}
*/
public function import(array $data): void
{
if (empty($data)) {
return;
}
self::locator()->hydrator($this)->hydrate($this, $data);
}
/**
* {@inheritdoc}
*/
public function export(array $attributes = []): array
{
return self::locator()->hydrator($this)->extract($this, $attributes);
}
/**
* Get the associated repository
*
* @return EntityRepository<static>
*/
public static function repository()
{
return self::locator()->repository(static::class);
}
/**
* Call method on this entity's repository
*
* @param string $name
* @param array $arguments
*
* @return EntityRepository|QueryInterface|mixed
*/
public static function __callStatic($name, $arguments)
{
return static::repository()->$name(...$arguments);
}
/**
* Save this entity
*
* @return int
* @throws PrimeException
*/
#[WriteOperation]
public function save(): int
{
return static::repository()->save($this);
}
/**
* Insert this entity
*
* @param bool $ignore
*
* @return int
* @throws PrimeException
*/
#[WriteOperation]
public function insert(bool $ignore = false): int
{
return static::repository()->insert($this, $ignore);
}
/**
* Update this entity
*
* @param list<string>|null $attributes
*
* @return int
* @throws PrimeException
*/
#[WriteOperation]
public function update(array $attributes = null): int
{
return static::repository()->update($this, $attributes);
}
/**
* Replace this entity
*
* @return int
* @throws PrimeException
*/
#[WriteOperation]
public function replace(): int
{
return static::repository()->replace($this);
}
/**
* Duplicate this entity
*
* @return int
* @throws PrimeException
*/
#[WriteOperation]
public function duplicate(): int
{
return static::repository()->duplicate($this);
}
/**
* Delete this entity
*
* @return int
* @throws PrimeException
*/
#[WriteOperation]
public function delete(): int
{
return static::repository()->delete($this);
}
//---- relations
/**
* Load entity relations
* If a relation is already loaded, the entity will be kept
* You can force loading using reload()
*
* @param string|array $relations
*
* @return $this
* @throws PrimeException
*
* @see Model::reload() For force loading
*/
#[ReadOperation]
public function load($relations)
{
static::repository()->loadRelations($this, $relations);
return $this;
}
/**
* For loading entity relations
*
* @param string|array $relations
*
* @return $this
* @throws PrimeException
*/
#[ReadOperation]
public function reload($relations)
{
static::repository()->reloadRelations($this, $relations);
return $this;
}
/**
* Load entity relations
*
* @param string $relation
*
* @return EntityRelation<static, object>
*/
public function relation(string $relation): EntityRelation
{
return static::repository()->onRelation($relation, $this);
}
/**
* Save this entity and its relations
*
* @param string|array $relations
*
* @return int
* @throws PrimeException
*/
#[WriteOperation]
public function saveAll($relations): int
{
return static::repository()->saveAll($this, $relations);
}
/**
* Delete this entity and its relations
*
* @param string|array $relations
*
* @return int
* @throws PrimeException
*/
#[WriteOperation]
public function deleteAll($relations): int
{
return static::repository()->deleteAll($this, $relations);
}
/**
* @deprecated This method is empty and will be removed in 3.0
*/
public function __destruct()
{
// No-op
}
//---- events
/**
* Register post load event
*
* @param callable(static,RepositoryInterface<static>):(bool|null) $listener
* @param bool $once Register on event once
*
* @return EntityRepository<static>
*/
public static function loaded(callable $listener, bool $once = true): RepositoryEventsSubscriberInterface
{
return static::repository()->loaded($listener, $once);
}
/**
* Register pre save event
*
* @param callable(static,RepositoryInterface<static>,bool):(bool|null) $listener
* @param bool $once Register on event once
*
* @return EntityRepository<static>
*/
public static function saving(callable $listener, bool $once = true): RepositoryEventsSubscriberInterface
{
return static::repository()->saving($listener, $once);
}
/**
* Register post save event
*
* @param callable(static,RepositoryInterface<static>,int,bool):(bool|null) $listener
* @param bool $once Register on event once
*
* @return EntityRepository<static>
*/
public static function saved(callable $listener, bool $once = true): RepositoryEventsSubscriberInterface
{
return static::repository()->saved($listener, $once);
}
/**
* Register post insert event
*
* @param callable(static,RepositoryInterface<static>):(bool|null) $listener
* @param bool $once Register on event once
*
* @return EntityRepository<static>
*/
public static function inserting(callable $listener, bool $once = true): RepositoryEventsSubscriberInterface
{
return static::repository()->inserting($listener, $once);
}
/**
* Register post insert event
*
* @param callable(static,RepositoryInterface<static>,int):(bool|null) $listener
* @param bool $once Register on event once
*
* @return EntityRepository<static>
*/
public static function inserted(callable $listener, bool $once = true): RepositoryEventsSubscriberInterface
{
return static::repository()->inserted($listener, $once);
}
/**
* Register post update event
*
* @param callable(static,RepositoryInterface<static>,\ArrayObject<int,string>):(bool|null) $listener
* @param bool $once Register on event once
*
* @return EntityRepository<static>
*/
public static function updating(callable $listener, bool $once = true): RepositoryEventsSubscriberInterface
{
return static::repository()->updating($listener, $once);
}
/**
* Register post update event
*
* @param callable(static,RepositoryInterface<static>,int):(bool|null) $listener
* @param bool $once Register on event once
*
* @return EntityRepository<static>
*/
public static function updated(callable $listener, bool $once = true): RepositoryEventsSubscriberInterface
{
return static::repository()->updated($listener, $once);
}
/**
* Register post delete event
*
* @param callable(static,RepositoryInterface<static>):(bool|null) $listener
* @param bool $once Register on event once
*
* @return EntityRepository<static>
*/
public static function deleting(callable $listener, bool $once = true): RepositoryEventsSubscriberInterface
{
return static::repository()->deleting($listener, $once);
}
/**
* Register post delete event
*
* @param callable(static,RepositoryInterface<static>,int):(bool|null) $listener
* @param bool $once Register on event once
*
* @return EntityRepository<static>
*/
public static function deleted(callable $listener, bool $once = true): RepositoryEventsSubscriberInterface
{
return static::repository()->deleted($listener, $once);
}
}