1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
namespace MaksimM\MultiUnitModels\Traits; |
4
|
|
|
|
5
|
|
|
use MaksimM\MultiUnitModels\Exceptions\NotSupportedMultiUnitField; |
6
|
|
|
|
7
|
|
|
trait ModelConfiguration |
8
|
|
|
{ |
9
|
|
|
/** |
10
|
|
|
* @return array |
11
|
|
|
*/ |
12
|
|
|
public function getFillable() |
13
|
|
|
{ |
14
|
|
|
return array_merge($this->getUnitConversionDataColumns(), parent::getFillable()); |
|
|
|
|
15
|
|
|
} |
16
|
|
|
|
17
|
|
|
/** |
18
|
|
|
* @return mixed |
19
|
|
|
*/ |
20
|
|
|
public function getHidden() |
21
|
|
|
{ |
22
|
|
|
return array_merge(parent::getHidden(), $this->getUnitConversionDataColumns()); |
|
|
|
|
23
|
|
|
} |
24
|
|
|
|
25
|
|
|
public function scopeSelectedUnits($query, $units) |
26
|
|
|
{ |
27
|
|
|
foreach ($units as $unitBasedColumn => $unit) { |
28
|
|
|
$query->getModel()->setMultiUnitFieldSelectedUnit($unitBasedColumn, $unit); |
29
|
|
|
} |
30
|
|
|
} |
31
|
|
|
|
32
|
|
|
/** |
33
|
|
|
* Create a new instance of the given model. |
34
|
|
|
* |
35
|
|
|
* @param array $attributes |
36
|
|
|
* @param bool $exists |
37
|
|
|
* |
38
|
|
|
* @throws NotSupportedMultiUnitField |
39
|
|
|
* |
40
|
|
|
* @return static |
41
|
|
|
*/ |
42
|
|
|
public function newInstance($attributes = [], $exists = false) |
43
|
|
|
{ |
44
|
|
|
$model = parent::newInstance($attributes, $exists); |
45
|
|
|
foreach ($this->getMultiUnitColumns() as $unitBasedColumn => $options) { |
|
|
|
|
46
|
|
|
$model->setMultiUnitFieldSelectedUnit($unitBasedColumn, $this->getMultiUnitFieldSelectedUnit($unitBasedColumn)->getId()); |
|
|
|
|
47
|
|
|
} |
48
|
|
|
|
49
|
|
|
return $model; |
50
|
|
|
} |
51
|
|
|
|
52
|
|
|
/** |
53
|
|
|
* Determine if a get mutator exists for an attribute. |
54
|
|
|
*coo. |
55
|
|
|
* |
56
|
|
|
* @param string $key |
57
|
|
|
* |
58
|
|
|
* @return bool |
59
|
|
|
*/ |
60
|
|
|
public function hasGetMutator($key) |
61
|
|
|
{ |
62
|
|
|
if ($this->isMultiUnitField($key) && isset($this->{$key})) { |
|
|
|
|
63
|
|
|
return true; |
64
|
|
|
} |
65
|
|
|
|
66
|
|
|
return parent::hasGetMutator($key); |
67
|
|
|
} |
68
|
|
|
|
69
|
|
|
/** |
70
|
|
|
* Get the value of an attribute using its mutator. |
71
|
|
|
* |
72
|
|
|
* @param string $key |
73
|
|
|
* @param mixed $value |
74
|
|
|
* |
75
|
|
|
* @throws NotSupportedMultiUnitField |
76
|
|
|
* |
77
|
|
|
* @return mixed |
78
|
|
|
*/ |
79
|
|
|
public function mutateAttribute($key, $value) |
80
|
|
|
{ |
81
|
|
|
if ($this->isMultiUnitField($key)) { |
|
|
|
|
82
|
|
|
$requestedUnit = $this->getMultiUnitFieldUnit($key); |
|
|
|
|
83
|
|
|
|
84
|
|
|
$value = $this->getMultiUnitFieldValue($key, new $requestedUnit()); |
|
|
|
|
85
|
|
|
if (parent::hasGetMutator($key)) { |
|
|
|
|
86
|
|
|
return parent::mutateAttribute($key, $value); |
87
|
|
|
} |
88
|
|
|
|
89
|
|
|
return $value; |
90
|
|
|
} |
91
|
|
|
|
92
|
|
|
return parent::mutateAttribute($key, $value); |
93
|
|
|
} |
94
|
|
|
|
95
|
|
|
/** |
96
|
|
|
* Allows to set input units and process them before multi-unit field. |
97
|
|
|
* |
98
|
|
|
* @param array $attributes |
99
|
|
|
* |
100
|
|
|
* @return array |
101
|
|
|
*/ |
102
|
|
|
protected function fillableFromArray(array $attributes) |
103
|
|
|
{ |
104
|
|
|
return array_merge($attributes, parent::fillableFromArray($attributes)); |
105
|
|
|
} |
106
|
|
|
|
107
|
|
|
/** |
108
|
|
|
* Detect changes and set proper database value. |
109
|
|
|
* |
110
|
|
|
* @param $field |
111
|
|
|
* @param $value |
112
|
|
|
* |
113
|
|
|
* @throws NotSupportedMultiUnitField |
114
|
|
|
* |
115
|
|
|
* @return mixed |
116
|
|
|
*/ |
117
|
|
|
private function processMultiUnitFieldChanges($field, $value) |
118
|
|
|
{ |
119
|
|
|
if (!is_null($value)) { |
120
|
|
|
$existingConversionData = $this->getMultiUnitExistingConversionData($field); |
|
|
|
|
121
|
|
|
if (!is_null($existingConversionData)) { |
122
|
|
|
$inputUnit = $this->getMultiUnitFieldUnit($field); |
|
|
|
|
123
|
|
|
//change existing value only in case if new value doesn't match with stored conversion table or not exists |
124
|
|
|
if (!isset( |
125
|
|
|
$existingConversionData->{$inputUnit->getId()} |
126
|
|
|
) || $value != $existingConversionData->{$inputUnit->getId()}) { |
127
|
|
|
$defaultUnitValue = (new $inputUnit($value))->as($this->getMultiUnitFieldDefaultUnit($field)); |
|
|
|
|
128
|
|
|
$this->attributes[$field] = $defaultUnitValue; |
|
|
|
|
129
|
|
|
} elseif ($value == $existingConversionData->{$inputUnit->getId()}) { |
130
|
|
|
//forget changes if value actually isn't changed |
131
|
|
|
$defaultUnitValue = $existingConversionData->{$this->getMultiUnitFieldDefaultUnit($field)->getId()}; |
|
|
|
|
132
|
|
|
$this->attributes[$field] = $defaultUnitValue; |
133
|
|
|
$this->syncOriginalAttribute($field); |
|
|
|
|
134
|
|
|
} |
135
|
|
|
|
136
|
|
|
return $defaultUnitValue; |
|
|
|
|
137
|
|
|
} |
138
|
|
|
} |
139
|
|
|
|
140
|
|
|
$this->attributes[$field] = $value; |
141
|
|
|
|
142
|
|
|
return $value; |
143
|
|
|
} |
144
|
|
|
} |
145
|
|
|
|
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.