-
Notifications
You must be signed in to change notification settings - Fork 48
/
GeneratesUuid.php
175 lines (156 loc) · 4.66 KB
/
GeneratesUuid.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
<?php
namespace Dyrynda\Database\Support;
use Illuminate\Contracts\Support\Arrayable;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Support\Arr;
use Illuminate\Support\Str;
use Ramsey\Uuid\Uuid;
/**
* UUID generation trait.
*
* Include this trait in any Eloquent model where you wish to automatically set
* a UUID field. When saving, if the UUID field has not been set, generate a
* new UUID value, which will be set on the model and saved by Eloquent.
*
* @copyright 2017 Michael Dyrynda
* @author Michael Dyrynda <michael@dyrynda.com.au>
* @license MIT
*
* @property string $uuidVersion
*/
trait GeneratesUuid
{
/**
* The UUID versions.
*
* @var array
*/
protected $uuidVersions = [
'uuid1',
'uuid3',
'uuid4',
'uuid5',
'ordered',
];
/**
* Determine whether an attribute should be cast to a native type.
*
* @param string $key
* @param array|string|null $types
* @return bool
*/
abstract public function hasCast($key, $types = null);
/**
* Boot the trait, adding a creating observer.
*
* When persisting a new model instance, we resolve the UUID field, then set
* a fresh UUID, taking into account if we need to cast to binary or not.
*
* @return void
*/
public static function bootGeneratesUuid(): void
{
static::creating(function ($model) {
/* @var \Illuminate\Database\Eloquent\Model|static $model */
$uuid = $model->resolveUuid();
foreach ($model->uuidColumns() as $item) {
if (isset($model->attributes[$item]) && ! is_null($model->attributes[$item])) {
/* @var \Ramsey\Uuid\Uuid $uuid */
$uuid = $uuid->fromString(strtolower($model->attributes[$item]));
}
$model->attributes[$item] = $model->hasCast($item, 'uuid') ? $uuid->getBytes() : $uuid->toString();
}
});
}
/**
* The name of the column that should be used for the UUID.
*
* @return string
*/
public function uuidColumn(): string
{
return 'uuid';
}
/**
* The names of the columns that should be used for the UUID.
*
* @return array
*/
public function uuidColumns(): array
{
return [$this->uuidColumn()];
}
/**
* Resolve a UUID instance for the configured version.
*
* @return \Ramsey\Uuid\Uuid
*/
public function resolveUuid(): Uuid
{
if (($version = $this->resolveUuidVersion()) == 'ordered') {
return Str::orderedUuid();
}
return call_user_func([Uuid::class, $version]);
}
/**
* Resolve the UUID version to use when setting the UUID value. Default to uuid4.
*
* @return string
*/
public function resolveUuidVersion(): string
{
if (property_exists($this, 'uuidVersion') && in_array($this->uuidVersion, $this->uuidVersions)) {
return $this->uuidVersion;
}
return 'uuid4';
}
/**
* Scope queries to find by UUID.
*
* @param \Illuminate\Database\Eloquent\Builder $query
* @param string $uuid
* @param string $uuidColumn
*
* @return \Illuminate\Database\Eloquent\Builder
*/
public function scopeWhereUuid($query, $uuid, $uuidColumn = null): Builder
{
$uuidColumn = ! is_null($uuidColumn) && in_array($uuidColumn, $this->uuidColumns())
? $uuidColumn
: $this->uuidColumns()[0];
if ($this->hasCast($uuidColumn)) {
$uuid = $this->bytesFromUuid($uuid);
}
return $query->whereIn($uuidColumn, Arr::wrap($uuid));
}
/**
* Convert a single UUID or array of UUIDs to bytes.
*
* @param \Illuminate\Contracts\Support\Arrayable|array|string $uuid
* @return array
*/
protected function bytesFromUuid($uuid): array
{
if (is_array($uuid) || $uuid instanceof Arrayable) {
array_walk($uuid, function (&$uuid) {
$uuid = $this->resolveUuid()->fromString($uuid)->getBytes();
});
return $uuid;
}
return Arr::wrap($this->resolveUuid()->fromString($uuid)->getBytes());
}
/**
* Cast an attribute to a native PHP type.
*
* @param string $key
* @param mixed $value
* @return mixed
*/
protected function castAttribute($key, $value)
{
if (in_array($key, $this->uuidColumns()) && ! empty($value)) {
return $this->resolveUuid()->fromBytes($value)->toString();
}
return parent::castAttribute($key, $value);
}
}