-
-
Notifications
You must be signed in to change notification settings - Fork 64
/
PersistentObjectFactory.php
354 lines (297 loc) · 9.02 KB
/
PersistentObjectFactory.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
<?php
/*
* This file is part of the zenstruck/foundry package.
*
* (c) Kevin Bond <kevinbond@gmail.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Zenstruck\Foundry\Persistence;
use Doctrine\Persistence\ObjectRepository;
use Symfony\Component\VarExporter\Exception\LogicException as VarExportLogicException;
use Zenstruck\Foundry\Configuration;
use Zenstruck\Foundry\Exception\PersistenceDisabled;
use Zenstruck\Foundry\Exception\PersistenceNotAvailable;
use Zenstruck\Foundry\Factory;
use Zenstruck\Foundry\FactoryCollection;
use Zenstruck\Foundry\ObjectFactory;
use Zenstruck\Foundry\Persistence\Exception\NoPersistenceStrategy;
use Zenstruck\Foundry\Persistence\Exception\NotEnoughObjects;
use Zenstruck\Foundry\Persistence\Exception\RefreshObjectFailed;
/**
* @author Kevin Bond <kevinbond@gmail.com>
*
* @template T of object
* @extends ObjectFactory<T>
*
* @phpstan-import-type Parameters from Factory
*/
abstract class PersistentObjectFactory extends ObjectFactory
{
private bool $persist;
/** @var list<callable(T):void> */
private array $afterPersist = [];
/** @var list<callable(T):void> */
private array $tempAfterPersist = [];
/**
* @final
*
* @param mixed|Parameters $criteriaOrId
*
* @return T
*
* @throws \RuntimeException If no object found
*/
public static function find(mixed $criteriaOrId): object
{
return static::repository()->findOrFail($criteriaOrId);
}
/**
* @final
*
* @param Parameters $criteria
*
* @return T
*/
public static function findOrCreate(array $criteria): object
{
try {
$object = static::repository()->findOneBy($criteria);
} catch (PersistenceNotAvailable|PersistenceDisabled) {
$object = null;
}
return $object ?? static::createOne($criteria);
}
/**
* @final
*
* @param Parameters $criteria
*
* @return T
*/
public static function randomOrCreate(array $criteria = []): object
{
try {
return static::repository()->random($criteria);
} catch (NotEnoughObjects|PersistenceNotAvailable|PersistenceDisabled) {
return static::createOne($criteria);
}
}
/**
* @final
*
* @param positive-int $count
* @param Parameters $criteria
*
* @return T[]
*/
public static function randomSet(int $count, array $criteria = []): array
{
return static::repository()->randomSet($count, $criteria);
}
/**
* @final
*
* @param int<0, max> $min
* @param int<0, max> $max
* @param Parameters $criteria
*
* @return T[]
*/
public static function randomRange(int $min, int $max, array $criteria = []): array
{
return static::repository()->randomRange($min, $max, $criteria);
}
/**
* @final
*
* @param Parameters $criteria
*
* @return T[]
*/
public static function findBy(array $criteria): array
{
return static::repository()->findBy($criteria);
}
/**
* @final
*
* @param Parameters $criteria
*
* @return T
*/
public static function random(array $criteria = []): object
{
return static::repository()->random($criteria);
}
/**
* @final
*
* @return T
*
* @throws \RuntimeException If no objects exist
*/
public static function first(string $sortBy = 'id'): object
{
return static::repository()->firstOrFail($sortBy);
}
/**
* @final
*
* @return T
*
* @throws \RuntimeException If no objects exist
*/
public static function last(string $sortBy = 'id'): object
{
return static::repository()->lastOrFail($sortBy);
}
/**
* @final
*
* @return T[]
*/
public static function all(): array
{
return static::repository()->findAll();
}
/**
* @final
*
* @return RepositoryDecorator<T,ObjectRepository<T>>
*/
public static function repository(): ObjectRepository
{
Configuration::instance()->assertPersistanceEnabled();
return new RepositoryDecorator(static::class()); // @phpstan-ignore-line
}
final public static function assert(): RepositoryAssertions
{
return static::repository()->assert();
}
/**
* @param Parameters $criteria
*/
final public static function count(array $criteria = []): int
{
return static::repository()->count($criteria);
}
final public static function truncate(): void
{
static::repository()->truncate();
}
final public function create(callable|array $attributes = []): object
{
$object = parent::create($attributes);
if (!$this->isPersisting()) {
return $this->proxy($object);
}
$configuration = Configuration::instance();
if (!$configuration->isPersistenceAvailable()) {
throw new \LogicException('Persistence cannot be used in unit tests.');
}
$configuration->persistence()->save($object);
foreach ($this->tempAfterPersist as $callback) {
$callback($object);
}
$this->tempAfterPersist = [];
foreach ($this->afterPersist as $callback) {
$callback($object);
}
if ($this->afterPersist) {
$configuration->persistence()->save($object);
}
return $this->proxy($object);
}
final public function andPersist(): static
{
$clone = clone $this;
$clone->persist = true;
return $clone;
}
final public function withoutPersisting(): static
{
$clone = clone $this;
$clone->persist = false;
return $clone;
}
/**
* @param callable(T):void $callback
*/
final public function afterPersist(callable $callback): static
{
$clone = clone $this;
$clone->afterPersist[] = $callback;
return $clone;
}
protected function normalizeParameter(string $field, mixed $value): mixed
{
if (!Configuration::instance()->isPersistenceAvailable()) {
return unproxy(parent::normalizeParameter($field, $value));
}
if ($value instanceof self && isset($this->persist)) {
$value->persist = $this->persist; // todo - breaks immutability
}
if ($value instanceof self && Configuration::instance()->persistence()->relationshipMetadata(static::class(), $value::class(), $field)?->isCascadePersist) {
$value->persist = false;
}
return unproxy(parent::normalizeParameter($field, $value));
}
protected function normalizeCollection(string $field, FactoryCollection $collection): array
{
if (!$this->isPersisting() || !$collection->factory instanceof self) {
return parent::normalizeCollection($field, $collection);
}
$pm = Configuration::instance()->persistence();
if ($inverseField = $pm->relationshipMetadata($collection->factory::class(), static::class(), $field)?->inverseField) {
$this->tempAfterPersist[] = static function(object $object) use ($collection, $inverseField, $pm) {
$collection->create([$inverseField => $object]);
$pm->refresh($object);
};
// creation delegated to afterPersist hook - return empty array here
return [];
}
return parent::normalizeCollection($field, $collection);
}
/**
* @internal
*/
protected function normalizeObject(object $object): object
{
$reflectionClass = new \ReflectionClass($object::class);
if ($reflectionClass->isFinal()) {
return $object;
}
// readonly classes exist since php 8.2 and proxyHelper supports them since 8.3
if (80200 <= \PHP_VERSION_ID && \PHP_VERSION_ID < 80300 && $reflectionClass->isReadonly()) {
return $object;
}
try {
return proxy($object)->_refresh()->_real();
} catch (PersistenceNotAvailable|RefreshObjectFailed|NoPersistenceStrategy|VarExportLogicException) {
return $object;
}
}
final protected function isPersisting(): bool
{
$config = Configuration::instance();
if ($config->isPersistenceAvailable() && !$config->persistence()->isEnabled()) {
return false;
}
return $this->persist ?? $config->isPersistenceAvailable() && $config->persistence()->isEnabled() && $config->persistence()->autoPersist(static::class());
}
/**
* @param T $object
*
* @return T
*/
private function proxy(object $object): object
{
if (!$this instanceof PersistentProxyObjectFactory) {
return $object;
}
$object = proxy($object);
return $this->isPersisting() ? $object : $object->_disableAutoRefresh();
}
}