1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
namespace MaksimM\MultiUnitModels\Traits; |
4
|
|
|
|
5
|
|
|
use Illuminate\Database\Eloquent\Model; |
6
|
|
|
use Illuminate\Support\Arr; |
7
|
|
|
use MaksimM\MultiUnitModels\Exceptions\NotSupportedMultiUnitField; |
8
|
|
|
use UnitConverter\Unit\AbstractUnit; |
9
|
|
|
|
10
|
|
|
trait MultiUnitSupport |
11
|
|
|
{ |
12
|
|
|
protected $unitAttributePostfix = '_units'; |
13
|
|
|
protected $unitConversionDataPostfix = '_ucd'; |
14
|
|
|
protected $multiUnitColumns = []; |
15
|
|
|
|
16
|
|
|
private function getUnitConversionDataColumns() |
17
|
|
|
{ |
18
|
|
|
return array_map(function ($column) { |
19
|
|
|
return $column.$this->getUnitConversionDataPostfix(); |
20
|
|
|
}, array_keys($this->getMultiUnitColumns())); |
21
|
|
|
} |
22
|
|
|
|
23
|
|
|
private function getUnitConversionUnitColumns() |
24
|
|
|
{ |
25
|
|
|
return array_map(function ($column) { |
26
|
|
|
return $column.$this->getUnitAttributePostfix(); |
27
|
|
|
}, array_keys($this->getMultiUnitColumns())); |
28
|
|
|
} |
29
|
|
|
|
30
|
|
|
/** |
31
|
|
|
* Allows to set input units and process them before multi-unit field. |
32
|
|
|
* |
33
|
|
|
* @param array $attributes |
34
|
|
|
* |
35
|
|
|
* @return array |
36
|
|
|
*/ |
37
|
|
|
protected function fillableFromArray(array $attributes) |
38
|
|
|
{ |
39
|
|
|
return array_merge(array_intersect_key($attributes, array_flip($this->getUnitConversionUnitColumns())), parent::fillableFromArray($attributes)); |
40
|
|
|
} |
41
|
|
|
|
42
|
|
|
/** |
43
|
|
|
* @return array |
44
|
|
|
*/ |
45
|
|
|
public function getFillable() |
46
|
|
|
{ |
47
|
|
|
return array_merge($this->getUnitConversionDataColumns(), $this->getUnitConversionUnitColumns(), parent::getFillable()); |
48
|
|
|
} |
49
|
|
|
|
50
|
|
|
/** |
51
|
|
|
* @return mixed |
52
|
|
|
*/ |
53
|
|
|
public function getHidden() |
54
|
|
|
{ |
55
|
|
|
return array_merge(parent::getHidden(), $this->getUnitConversionDataColumns()); |
56
|
|
|
} |
57
|
|
|
|
58
|
|
|
protected static function bootMultiUnitSupport() |
59
|
|
|
{ |
60
|
|
|
//save conversion table if base value is changed |
61
|
|
|
static::creating(function ($model) { |
62
|
|
|
/** |
63
|
|
|
* @var Model|MultiUnitSupport $model |
64
|
|
|
*/ |
65
|
|
|
foreach ($model->getMultiUnitColumns() as $unitBasedColumn => $options) { |
66
|
|
|
if(isset($model->attributes[$unitBasedColumn])) { |
67
|
|
|
$model->{$unitBasedColumn.$model->getUnitConversionDataPostfix()} = json_encode( |
68
|
|
|
$model->calculateMultiUnitConversionData( |
69
|
|
|
$model->attributes[$unitBasedColumn], |
70
|
|
|
$model->getMultiUnitFieldUnit($unitBasedColumn), |
71
|
|
|
$options['supported_units'] |
72
|
|
|
) |
73
|
|
|
); |
74
|
|
|
$model->{$unitBasedColumn} = $model->processMultiUnitFieldChanges( |
75
|
|
|
$unitBasedColumn, |
76
|
|
|
$model->{$unitBasedColumn} |
77
|
|
|
); |
78
|
|
|
} |
79
|
|
|
} |
80
|
|
|
//prevent saving of unit columns |
81
|
|
|
foreach ($model->getUnitConversionUnitColumns() as $unitColumn) { |
82
|
|
|
if(isset($model->attributes[$unitColumn])) |
83
|
|
|
unset($model->attributes[$unitColumn]); |
84
|
|
|
} |
85
|
|
|
}); |
86
|
|
|
static::updating(function ($model) { |
87
|
|
|
/** |
88
|
|
|
* @var Model|MultiUnitSupport $model |
89
|
|
|
*/ |
90
|
|
|
foreach (Arr::only($model->getMultiUnitColumns(), array_keys($model->getDirty())) as $unitBasedColumn => $options) { |
|
|
|
|
91
|
|
|
$model->{$unitBasedColumn.$model->getUnitConversionDataPostfix()} = json_encode($model->calculateMultiUnitConversionData($model->getDirty()[$unitBasedColumn], new $options['default_unit'](), $options['supported_units'])); |
|
|
|
|
92
|
|
|
} |
93
|
|
|
}); |
94
|
|
|
} |
95
|
|
|
|
96
|
|
|
/** |
97
|
|
|
* @param $value |
98
|
|
|
* @param AbstractUnit $unit |
99
|
|
|
* @param string[] $requiredUnits |
100
|
|
|
* |
101
|
|
|
* @return array |
102
|
|
|
*/ |
103
|
|
|
private function calculateMultiUnitConversionData($value, AbstractUnit $unit, $requiredUnits) |
104
|
|
|
{ |
105
|
|
|
$conversionData = []; |
106
|
|
|
foreach ($requiredUnits as $requiredUnitClass) { |
107
|
|
|
/** |
108
|
|
|
* @var AbstractUnit $requiredUnit |
109
|
|
|
*/ |
110
|
|
|
$requiredUnit = new $requiredUnitClass(); |
111
|
|
|
$conversionData[$requiredUnit->getSymbol()] = (new $unit($value))->as($requiredUnit); |
112
|
|
|
} |
113
|
|
|
|
114
|
|
|
return $conversionData; |
115
|
|
|
} |
116
|
|
|
|
117
|
|
|
public function getMultiUnitExistingConversionData($field) |
|
|
|
|
118
|
|
|
{ |
119
|
|
|
return json_decode($this->{$field.$this->getUnitConversionDataPostfix()} ?? null); |
120
|
|
|
} |
121
|
|
|
|
122
|
|
|
/** |
123
|
|
|
* @return string |
124
|
|
|
*/ |
125
|
|
|
public function getUnitAttributePostfix() |
126
|
|
|
{ |
127
|
|
|
return $this->unitAttributePostfix; |
128
|
|
|
} |
129
|
|
|
|
130
|
|
|
/** |
131
|
|
|
* @return string |
132
|
|
|
*/ |
133
|
|
|
protected function getUnitConversionDataPostfix() |
134
|
|
|
{ |
135
|
|
|
return $this->unitConversionDataPostfix; |
136
|
|
|
} |
137
|
|
|
|
138
|
|
|
/** |
139
|
|
|
* @return array |
140
|
|
|
*/ |
141
|
|
|
protected function getMultiUnitColumns() |
142
|
|
|
{ |
143
|
|
|
return $this->multiUnitColumns; |
144
|
|
|
} |
145
|
|
|
|
146
|
|
|
/** |
147
|
|
|
* @param $field |
148
|
|
|
* |
149
|
|
|
* @throws NotSupportedMultiUnitField |
150
|
|
|
* |
151
|
|
|
* @return AbstractUnit[] |
152
|
|
|
*/ |
153
|
|
|
public function getMultiUnitFieldSupportedUnits($field) |
154
|
|
|
{ |
155
|
|
|
if ($this->isMultiUnitField($field)) { |
156
|
|
|
return $this->getMultiUnitColumns()[$field]['supported_units']; |
157
|
|
|
} |
158
|
|
|
|
159
|
|
|
throw new NotSupportedMultiUnitField($field); |
160
|
|
|
} |
161
|
|
|
|
162
|
|
|
/** |
163
|
|
|
* @param $field |
164
|
|
|
* |
165
|
|
|
* @throws NotSupportedMultiUnitField |
166
|
|
|
* |
167
|
|
|
* @return AbstractUnit |
168
|
|
|
*/ |
169
|
|
|
public function getMultiUnitFieldDefaultUnit($field) |
170
|
|
|
{ |
171
|
|
|
if ($this->isMultiUnitField($field)) { |
172
|
|
|
$unitClass = $this->getMultiUnitColumns()[$field]['default_unit']; |
173
|
|
|
|
174
|
|
|
return new $unitClass(); |
175
|
|
|
} |
176
|
|
|
|
177
|
|
|
throw new NotSupportedMultiUnitField($field); |
178
|
|
|
} |
179
|
|
|
|
180
|
|
|
/** |
181
|
|
|
* @param $field |
182
|
|
|
* @param AbstractUnit|null $unit |
183
|
|
|
* |
184
|
|
|
* @throws NotSupportedMultiUnitField |
185
|
|
|
* |
186
|
|
|
* @return mixed |
187
|
|
|
*/ |
188
|
|
|
public function getMultiUnitFieldValue($field, AbstractUnit $unit = null) |
189
|
|
|
{ |
190
|
|
|
if ($this->isMultiUnitField($field)) { |
191
|
|
|
if (isset($this->{$field})) { |
192
|
|
|
if (is_null($unit)) { |
193
|
|
|
$unit = $this->getMultiUnitFieldUnit($field); |
194
|
|
|
} |
195
|
|
|
$existingConversionData = $this->getMultiUnitExistingConversionData($field); |
196
|
|
|
if (!is_null($existingConversionData) && !is_null($existingConversionData->{$unit->getSymbol()})) { |
197
|
|
|
return $existingConversionData->{$unit->getSymbol()}; |
198
|
|
|
} |
199
|
|
|
|
200
|
|
|
return ($this->getMultiUnitFieldDefaultUnit($field)->setValue($this->{$field}))->as(new $unit()); |
201
|
|
|
} else { |
202
|
|
|
return; |
203
|
|
|
} |
204
|
|
|
} |
205
|
|
|
|
206
|
|
|
throw new NotSupportedMultiUnitField($field); |
207
|
|
|
} |
208
|
|
|
|
209
|
|
|
protected function isMultiUnitField($field) |
210
|
|
|
{ |
211
|
|
|
return isset($this->getMultiUnitColumns()[$field]); |
212
|
|
|
} |
213
|
|
|
|
214
|
|
|
/** |
215
|
|
|
* @param $field |
216
|
|
|
* |
217
|
|
|
* @throws NotSupportedMultiUnitField |
218
|
|
|
* |
219
|
|
|
* @return AbstractUnit |
220
|
|
|
*/ |
221
|
|
|
protected function getMultiUnitFieldUnit($field) |
222
|
|
|
{ |
223
|
|
|
if (isset($this->{$field.$this->getUnitAttributePostfix()})) { |
224
|
|
|
foreach ($this->getMultiUnitFieldSupportedUnits($field) as $unitClass) { |
225
|
|
|
/** |
226
|
|
|
* @var AbstractUnit $unit |
227
|
|
|
*/ |
228
|
|
|
$unit = new $unitClass(); |
229
|
|
|
if (strtolower($unit->getSymbol()) == strtolower($this->{$field.$this->getUnitAttributePostfix()})) { |
230
|
|
|
return $unit; |
231
|
|
|
} |
232
|
|
|
} |
233
|
|
|
} |
234
|
|
|
|
235
|
|
|
return $this->getMultiUnitFieldDefaultUnit($field); |
236
|
|
|
} |
237
|
|
|
|
238
|
|
|
protected function forgetMultiUnitFieldUnitInput($field) |
239
|
|
|
{ |
240
|
|
|
//prevent column_units to by saved to DB |
241
|
|
|
if (isset($this->attributes[$field.$this->getUnitAttributePostfix()])) { |
|
|
|
|
242
|
|
|
$this->syncOriginalAttribute($field.$this->getUnitAttributePostfix()); |
|
|
|
|
243
|
|
|
} |
244
|
|
|
} |
245
|
|
|
|
246
|
|
|
protected function setMultiUnitFieldUnit($field, AbstractUnit $unit) |
247
|
|
|
{ |
248
|
|
|
$this->{$field.$this->getUnitAttributePostfix()} = $unit->getSymbol(); |
249
|
|
|
$this->forgetMultiUnitFieldUnitInput($field); |
250
|
|
|
} |
251
|
|
|
|
252
|
|
|
/** |
253
|
|
|
* @param $field |
254
|
|
|
* |
255
|
|
|
* @throws NotSupportedMultiUnitField |
256
|
|
|
*/ |
257
|
|
|
protected function resetMultiUnitFieldUnit($field) |
258
|
|
|
{ |
259
|
|
|
$this->setMultiUnitFieldUnit($field, $this->getMultiUnitFieldDefaultUnit($field)); |
260
|
|
|
} |
261
|
|
|
|
262
|
|
|
/** |
263
|
|
|
* Determine if a set mutator exists for an attribute. |
264
|
|
|
* |
265
|
|
|
* @param string $key |
266
|
|
|
* |
267
|
|
|
* @return bool |
268
|
|
|
*/ |
269
|
|
|
public function hasSetMutator($key) |
270
|
|
|
{ |
271
|
|
|
if ($this->isMultiUnitField($key)) { |
272
|
|
|
return true; |
273
|
|
|
} |
274
|
|
|
|
275
|
|
|
return parent::hasSetMutator($key); |
276
|
|
|
} |
277
|
|
|
|
278
|
|
|
/** |
279
|
|
|
* Set the value of an attribute using its mutator. |
280
|
|
|
* |
281
|
|
|
* @param string $key |
282
|
|
|
* @param mixed $value |
283
|
|
|
* |
284
|
|
|
* @throws NotSupportedMultiUnitField |
285
|
|
|
* |
286
|
|
|
* @return mixed |
287
|
|
|
*/ |
288
|
|
|
protected function setMutatedAttributeValue($key, $value) |
289
|
|
|
{ |
290
|
|
|
if ($this->isMultiUnitField($key)) { |
291
|
|
|
$value = $this->processMultiUnitFieldChanges($key, $value); |
292
|
|
|
$this->attributes[$key] = $value; |
293
|
|
|
|
294
|
|
|
return $value; |
295
|
|
|
} |
296
|
|
|
|
297
|
|
|
parent::setMutatedAttributeValue($key, $value); |
298
|
|
|
} |
299
|
|
|
|
300
|
|
|
/** |
301
|
|
|
* Detect changes and set proper base value. |
302
|
|
|
* |
303
|
|
|
* @param $field |
304
|
|
|
* @param $value |
305
|
|
|
* |
306
|
|
|
* @throws NotSupportedMultiUnitField |
307
|
|
|
* |
308
|
|
|
* @return mixed |
309
|
|
|
*/ |
310
|
|
|
private function processMultiUnitFieldChanges($field, $value) |
311
|
|
|
{ |
312
|
|
|
$existingConversionData = $this->getMultiUnitExistingConversionData($field); |
313
|
|
|
if (!is_null($existingConversionData)) { |
314
|
|
|
$inputUnit = $this->getMultiUnitFieldUnit($field); |
315
|
|
|
//change existing value only in case if new value doesn't match with stored conversion table or not exists |
316
|
|
|
if (!isset($existingConversionData->{$inputUnit->getSymbol()}) || $value != $existingConversionData->{$inputUnit->getSymbol()}) { |
317
|
|
|
$this->resetMultiUnitFieldUnit($field); |
318
|
|
|
|
319
|
|
|
return (new $inputUnit($value))->as($this->getMultiUnitFieldDefaultUnit($field)); |
320
|
|
|
} elseif ($value == $existingConversionData->{$inputUnit->getSymbol()}) { |
321
|
|
|
//forget changes if value actually isn't changed |
322
|
|
|
$this->resetMultiUnitFieldUnit($field); |
323
|
|
|
$originalValue = $existingConversionData->{$this->getMultiUnitFieldDefaultUnit($field)->getSymbol()}; |
324
|
|
|
$this->attributes[$field] = $originalValue; |
325
|
|
|
$this->syncOriginalAttribute($field); |
|
|
|
|
326
|
|
|
|
327
|
|
|
return $originalValue; |
328
|
|
|
} |
329
|
|
|
$this->resetMultiUnitFieldUnit($field); |
330
|
|
|
} |
331
|
|
|
|
332
|
|
|
return $value; |
333
|
|
|
} |
334
|
|
|
|
335
|
|
|
/** |
336
|
|
|
* Determine if a get mutator exists for an attribute. |
337
|
|
|
*coo. |
338
|
|
|
* |
339
|
|
|
* @param string $key |
340
|
|
|
* |
341
|
|
|
* @return bool |
342
|
|
|
*/ |
343
|
|
|
public function hasGetMutator($key) |
344
|
|
|
{ |
345
|
|
|
if ($this->isMultiUnitField($key) && isset($this->{$key})) { |
346
|
|
|
return true; |
347
|
|
|
} |
348
|
|
|
|
349
|
|
|
return parent::hasGetMutator($key); |
350
|
|
|
} |
351
|
|
|
|
352
|
|
|
/** |
353
|
|
|
* Get the value of an attribute using its mutator. |
354
|
|
|
* |
355
|
|
|
* @param string $key |
356
|
|
|
* @param mixed $value |
357
|
|
|
* |
358
|
|
|
* @throws NotSupportedMultiUnitField |
359
|
|
|
* |
360
|
|
|
* @return mixed |
361
|
|
|
*/ |
362
|
|
|
public function mutateAttribute($key, $value) |
363
|
|
|
{ |
364
|
|
|
if ($this->isMultiUnitField($key)) { |
365
|
|
|
$requestedUnit = $this->getMultiUnitFieldUnit($key); |
366
|
|
|
|
367
|
|
|
return $this->getMultiUnitFieldValue($key, new $requestedUnit()); |
368
|
|
|
} |
369
|
|
|
|
370
|
|
|
return parent::mutateAttribute($key, $value); |
371
|
|
|
} |
372
|
|
|
} |
373
|
|
|
|
This check looks for methods that are used by a trait but not required by it.
To illustrate, let’s look at the following code example
The trait
Idable
provides a methodequalsId
that in turn relies on the methodgetId()
. If this method does not exist on a class mixing in this trait, the method will fail.Adding the
getId()
as an abstract method to the trait will make sure it is available.