-
-
Notifications
You must be signed in to change notification settings - Fork 4
/
ModelMetadata.php
290 lines (258 loc) · 9.14 KB
/
ModelMetadata.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
<?php
/*
* This file is part of the API Platform project.
*
* (c) Kévin Dunglas <dunglas@gmail.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
declare(strict_types=1);
namespace ApiPlatform\Laravel\Eloquent\Metadata;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\Relation;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\Gate;
use Illuminate\Support\Str;
/**
* Inspired from Illuminate\Database\Console\ShowModelCommand.
*
* @internal
*/
final class ModelMetadata
{
/**
* The methods that can be called in a model to indicate a relation.
*
* @var string[]
*/
public const RELATION_METHODS = [
'hasMany',
'hasManyThrough',
'hasOneThrough',
'belongsToMany',
'hasOne',
'belongsTo',
'morphOne',
'morphTo',
'morphMany',
'morphToMany',
'morphedByMany',
];
/**
* Gets the first policy associated with this model.
*/
public function getPolicy(Model $model): ?string
{
$policy = Gate::getPolicyFor($model::class);
return $policy ? $policy::class : null;
}
/**
* Gets the column attributes for the given model.
*
* @return Collection<string, mixed>
*/
public function getAttributes(Model $model): Collection
{
$connection = $model->getConnection();
$schema = $connection->getSchemaBuilder();
$table = $model->getTable();
$columns = $schema->getColumns($table);
$indexes = $schema->getIndexes($table);
return collect($columns)
->map(fn ($column) => [
'name' => $column['name'],
'type' => $column['type'],
'increments' => $column['auto_increment'],
'nullable' => $column['nullable'],
'default' => $this->getColumnDefault($column, $model),
'unique' => $this->columnIsUnique($column['name'], $indexes),
'fillable' => $model->isFillable($column['name']),
'hidden' => $this->attributeIsHidden($column['name'], $model),
'appended' => null,
'cast' => $this->getCastType($column['name'], $model),
'primary' => $this->isColumnPrimaryKey($indexes, $column['name']),
])
->merge($this->getVirtualAttributes($model, $columns));
}
/**
* @param array<int, array{columns: string[]}> $indexes
*/
private function isColumnPrimaryKey(array $indexes, string $column): bool
{
foreach ($indexes as $index) {
if (\in_array($column, $index['columns'], true)) {
return true;
}
}
return false;
}
/**
* Get the virtual (non-column) attributes for the given model.
*
* @param array<string, mixed> $columns
*
* @return Collection<int, mixed>
*/
public function getVirtualAttributes(Model $model, array $columns): Collection
{
$class = new \ReflectionClass($model);
return collect($class->getMethods())
->reject(
fn (\ReflectionMethod $method) => $method->isStatic()
|| $method->isAbstract()
|| Model::class === $method->getDeclaringClass()->getName()
)
->mapWithKeys(function (\ReflectionMethod $method) use ($model) {
if (1 === preg_match('/^get(.+)Attribute$/', $method->getName(), $matches)) {
return [Str::snake($matches[1]) => 'accessor'];
}
if ($model->hasAttributeMutator($method->getName())) {
return [Str::snake($method->getName()) => 'attribute'];
}
return [];
})
->reject(fn ($cast, $name) => collect($columns)->contains('name', $name))
->map(fn ($cast, $name) => [
'name' => $name,
'type' => null,
'increments' => false,
'nullable' => null,
'default' => null,
'unique' => null,
'fillable' => $model->isFillable($name),
'hidden' => $this->attributeIsHidden($name, $model),
'appended' => $model->hasAppended($name),
'cast' => $cast,
])
->values();
}
/**
* Gets the relations from the given model.
*
* @return Collection<int, mixed>
*/
public function getRelations(Model $model): Collection
{
return collect(get_class_methods($model))
->map(fn ($method) => new \ReflectionMethod($model, $method))
->reject(
fn (\ReflectionMethod $method) => $method->isStatic()
|| $method->isAbstract()
|| Model::class === $method->getDeclaringClass()->getName()
|| $method->getNumberOfParameters() > 0
)
->filter(function (\ReflectionMethod $method) {
if ($method->getReturnType() instanceof \ReflectionNamedType
&& is_subclass_of($method->getReturnType()->getName(), Relation::class)) {
return true;
}
if (false === $method->getFileName()) {
return false;
}
$file = new \SplFileObject($method->getFileName());
$file->seek($method->getStartLine() - 1);
$code = '';
while ($file->key() < $method->getEndLine()) {
$current = $file->current();
if (\is_string($current)) {
$code .= trim($current);
}
$file->next();
}
return collect(self::RELATION_METHODS)
->contains(fn ($relationMethod) => str_contains($code, '$this->'.$relationMethod.'('));
})
->map(function (\ReflectionMethod $method) use ($model) {
$relation = $method->invoke($model);
if (!$relation instanceof Relation) {
return null;
}
return [
'name' => $method->getName(),
'type' => $relation::class,
'related' => \get_class($relation->getRelated()),
'foreign_key' => method_exists($relation, 'getForeignKeyName') ? $relation->getForeignKeyName() : null,
];
})
->filter()
->values();
}
/**
* Gets the Events that the model dispatches.
*
* @return Collection<int, mixed>
*/
public function getEvents(Model $model): Collection
{
return collect($model->dispatchesEvents())
->map(fn (string $class, string $event) => [
'event' => $event,
'class' => $class,
])->values();
}
/**
* Gets the cast type for the given column.
*/
private function getCastType(string $column, Model $model): ?string
{
if ($model->hasGetMutator($column) || $model->hasSetMutator($column)) {
return 'accessor';
}
if ($model->hasAttributeMutator($column)) {
return 'attribute';
}
return $this->getCastsWithDates($model)->get($column) ?? null;
}
/**
* Gets the model casts, including any date casts.
*
* @return Collection<string, mixed>
*/
private function getCastsWithDates(Model $model): Collection
{
return collect($model->getDates())
->filter()
->flip()
->map(fn () => 'datetime')
->merge($model->getCasts());
}
/**
* Gets the default value for the given column.
*
* @param array<string, mixed>&array{name: string, default: string} $column
*/
private function getColumnDefault(array $column, Model $model): mixed
{
$attributeDefault = $model->getAttributes()[$column['name']] ?? null;
return match (true) {
$attributeDefault instanceof \BackedEnum => $attributeDefault->value,
$attributeDefault instanceof \UnitEnum => $attributeDefault->name,
default => $attributeDefault ?? $column['default'],
};
}
/**
* Determines if the given attribute is hidden.
*/
private function attributeIsHidden(string $attribute, Model $model): bool
{
if ($visible = $model->getVisible()) {
return !\in_array($attribute, $visible, true);
}
if ($hidden = $model->getHidden()) {
return \in_array($attribute, $hidden, true);
}
return false;
}
/**
* Determines if the given attribute is unique.
*
* @param array<int, array{columns: string[], unique: bool}> $indexes
*/
private function columnIsUnique(string $column, array $indexes): bool
{
return collect($indexes)->contains(
fn ($index) => 1 === \count($index['columns']) && $index['columns'][0] === $column && $index['unique']
);
}
}