Repository navigation
Expand file tree
/
Copy pathRelation.php
More file actions
executable file
·445 lines (391 loc) · 10.6 KB
/
Copy pathRelation.php
File metadata and controls
executable file
·445 lines (391 loc) · 10.6 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
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
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
<?php
declare(strict_types=1);
/**
* This file is part of Hyperf.
*
* @link https://www.hyperf.io
* @document https://hyperf.wiki
* @contact [email protected]
* @license https://github.com/hyperf/hyperf/blob/master/LICENSE
*/
namespace Hyperf\Database\Model\Relations;
use Closure;
use Hyperf\Collection\Arr;
use Hyperf\Database\Model\Builder;
use Hyperf\Database\Model\Collection;
use Hyperf\Database\Model\Model;
use Hyperf\Database\Query\Expression;
use Hyperf\Macroable\Macroable;
use Hyperf\Support\Traits\ForwardsCalls;
use function Hyperf\Collection\collect;
use function Hyperf\Collection\last;
/**
* @template TRelatedModel of \Hyperf\Database\Model\Model
* @template TParentModel of \Hyperf\Database\Model\Model
* @template TResult
*
* @mixin \Hyperf\Database\Model\Builder<TRelatedModel>
*/
abstract class Relation
{
use ForwardsCalls, Macroable {
__call as macroCall;
}
/**
* An array to map class names to their morph names in database.
*
* @var array
*/
public static $morphMap = [];
/**
* Prevents morph relationships without a morph map.
*/
protected static bool $requireMorphMap = false;
/**
* The Model query builder instance.
*
* @var Builder
*/
protected $query;
/**
* The parent model instance.
*
* @var Model
*/
protected $parent;
/**
* The related model instance.
*
* @var Model
*/
protected $related;
/**
* Create a new relation instance.
*/
public function __construct(Builder $query, Model $parent)
{
$this->query = $query;
$this->parent = $parent;
$this->related = $query->getModel();
$this->addConstraints();
}
/**
* Handle dynamic method calls to the relationship.
*
* @param string $method
* @param array $parameters
*/
public function __call($method, $parameters)
{
if (static::hasMacro($method)) {
return $this->macroCall($method, $parameters);
}
$result = $this->forwardCallTo($this->query, $method, $parameters);
if ($result === $this->query) {
return $this;
}
return $result;
}
/**
* Force a clone of the underlying query builder when cloning.
*/
public function __clone()
{
$this->query = clone $this->query;
}
/**
* Run a callback with constraints disabled on the relation.
*
* @template TCallbackReturn
* @param Closure():TCallbackReturn $callback
* @return TCallbackReturn
*/
public static function noConstraints(Closure $callback)
{
$previous = Constraint::isConstraint();
Constraint::setConstraint(false);
// When resetting the relation where clause, we want to shift the first element
// off of the bindings, leaving only the constraints that the developers put
// as "extra" on the relationships, and not original relation constraints.
try {
return call_user_func($callback);
} finally {
Constraint::setConstraint($previous);
}
}
/**
* Set the base constraints on the relation query.
*/
abstract public function addConstraints();
/**
* Set the constraints for an eager load of the relation.
*/
abstract public function addEagerConstraints(array $models);
/**
* Initialize the relation on a set of models.
*
* @param string $relation
* @return array
*/
abstract public function initRelation(array $models, $relation);
/**
* Match the eagerly loaded results to their parents.
*
* @param string $relation
* @return array
*/
abstract public function match(array $models, Collection $results, $relation);
/**
* Get the results of the relationship.
*
* @return TResult
*/
abstract public function getResults();
/**
* Get the relationship for eager loading.
*
* @return Collection<int, TRelatedModel>
*/
public function getEager()
{
return $this->get();
}
/**
* Execute the query as a "select" statement.
*
* @param array $columns
* @return Collection<int, TRelatedModel>
*/
public function get($columns = ['*'])
{
return $this->query->get($columns);
}
/**
* Touch all of the related models for the relationship.
*/
public function touch()
{
$model = $this->getRelated();
if (! $model::isIgnoringTouch()) {
$this->rawUpdate([
$model->getUpdatedAtColumn() => $model->freshTimestampString(),
]);
}
}
/**
* Run a raw update against the base query.
*
* @return int
*/
public function rawUpdate(array $attributes = [])
{
return $this->query->withoutGlobalScopes()->update($attributes);
}
/**
* Add the constraints for a relationship count query.
*
* @return Builder
*/
public function getRelationExistenceCountQuery(Builder $query, Builder $parentQuery)
{
return $this->getRelationExistenceQuery(
$query,
$parentQuery,
new Expression('count(*)')
)->setBindings([], 'select');
}
/**
* Add the constraints for an internal relationship existence query.
*
* Essentially, these queries compare on column names like whereColumn.
*
* @param array|mixed $columns
* @return Builder
*/
public function getRelationExistenceQuery(Builder $query, Builder $parentQuery, $columns = ['*'])
{
return $query->select($columns)->whereColumn(
$this->getQualifiedParentKeyName(),
'=',
$this->getExistenceCompareKey()
);
}
/**
* Get the underlying query for the relation.
*
* @return Builder
*/
public function getQuery()
{
return $this->query;
}
/**
* Get the base query builder driving the Model builder.
*
* @return \Hyperf\Database\Query\Builder
*/
public function getBaseQuery()
{
return $this->query->getQuery();
}
/**
* Get the parent model of the relation.
*
* @return TParentModel
*/
public function getParent()
{
return $this->parent;
}
/**
* Get the fully qualified parent key name.
*
* @return string
*/
public function getQualifiedParentKeyName()
{
return $this->parent->getQualifiedKeyName();
}
/**
* Get the related model of the relation.
*
* @return TRelatedModel
*/
public function getRelated()
{
return $this->related;
}
/**
* Get the name of the "created at" column.
*
* @return string
*/
public function createdAt()
{
return $this->parent->getCreatedAtColumn();
}
/**
* Get the name of the "updated at" column.
*
* @return string
*/
public function updatedAt()
{
return $this->parent->getUpdatedAtColumn();
}
/**
* Get the name of the related model's "updated at" column.
*
* @return string
*/
public function relatedUpdatedAt()
{
return $this->related->getUpdatedAtColumn();
}
/**
* Set or get the morph map for polymorphic relations.
*
* @param bool $merge
* @return array
*/
public static function morphMap(?array $map = null, $merge = true)
{
$map = static::buildMorphMapFromModels($map);
if (is_array($map)) {
static::$morphMap = $merge && static::$morphMap
? $map + static::$morphMap : $map;
}
return static::$morphMap;
}
/**
* Get the model associated with a custom polymorphic type.
*
* @param string $alias
* @return null|string
*/
public static function getMorphedModel($alias)
{
return self::$morphMap[$alias] ?? null;
}
/**
* Get a relationship join table hash.
*
* For safety, The relationship ensures this method is only used in the same coroutine.
*
* @return string
*/
public function getRelationCountHash(bool $incrementJoinCount = true)
{
return 'hyperf_reserved_' . ($incrementJoinCount ? static::$selfJoinCount++ : static::$selfJoinCount);
}
/**
* Get the alias associated with a custom polymorphic class.
*/
public static function getMorphAlias(string $className): string
{
return array_search($className, static::$morphMap, strict: true) ?: $className;
}
/**
* Prevent polymorphic relationships from being used without model mappings.
*/
public static function requireMorphMap(bool $requireMorphMap = true): void
{
static::$requireMorphMap = $requireMorphMap;
}
/**
* Determine if polymorphic relationships require explicit model mapping.
*/
public static function requiresMorphMap(): bool
{
return static::$requireMorphMap;
}
/**
* Define the morph map for polymorphic relations and require all morphed models to be explicitly mapped.
*/
public static function enforceMorphMap(?array $map, bool $merge = true): array
{
static::requireMorphMap();
return static::morphMap($map, $merge);
}
/**
* Get all of the primary keys for an array of models.
*
* @param string $key
* @return array
*/
protected function getKeys(array $models, $key = null)
{
return collect($models)->map(function ($value) use ($key) {
return $key ? $value->getAttribute($key) : $value->getKey();
})->values()->unique(null, true)->sort()->all();
}
/**
* Get the name of the "where in" method for eager loading.
*
* @param string $key
* @return string
*/
protected function whereInMethod(Model $model, $key)
{
return $model->getKeyName() === last(explode('.', $key))
&& $model->getIncrementing()
&& in_array($model->getKeyType(), ['int', 'integer'])
? 'whereIntegerInRaw'
: 'whereIn';
}
/**
* Builds a table-keyed array from model class names.
*
* @param null|string[] $models
* @return null|array
*/
protected static function buildMorphMapFromModels(?array $models = null)
{
if (is_null($models) || Arr::isAssoc($models)) {
return $models;
}
return array_combine(array_map(function ($model) {
return (new $model())->getTable();
}, $models), $models);
}
}