|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
namespace Backpack\CRUD\PanelTraits; |
|
4
|
|
|
|
|
5
|
|
|
use Illuminate\Database\Eloquent\Model; |
|
6
|
|
|
use Illuminate\Database\Eloquent\Relations\HasOne; |
|
7
|
|
|
use Illuminate\Database\Eloquent\Relations\HasMany; |
|
8
|
|
|
use Illuminate\Database\Eloquent\Relations\BelongsTo; |
|
9
|
|
|
|
|
10
|
|
|
trait Create |
|
11
|
|
|
{ |
|
12
|
|
|
/* |
|
13
|
|
|
|-------------------------------------------------------------------------- |
|
14
|
|
|
| CREATE |
|
15
|
|
|
|-------------------------------------------------------------------------- |
|
16
|
|
|
*/ |
|
17
|
|
|
|
|
18
|
|
|
/** |
|
19
|
|
|
* Insert a row in the database. |
|
20
|
|
|
* |
|
21
|
|
|
* @param [Request] All input values to be inserted. |
|
22
|
|
|
* |
|
23
|
|
|
* @return [Eloquent Collection] |
|
|
|
|
|
|
24
|
|
|
*/ |
|
25
|
5 |
|
public function create($data) |
|
|
|
|
|
|
26
|
|
|
{ |
|
27
|
5 |
|
$data = $this->decodeJsonCastedAttributes($data, 'create'); |
|
|
|
|
|
|
28
|
5 |
|
$data = $this->compactFakeFields($data, 'create'); |
|
|
|
|
|
|
29
|
|
|
|
|
30
|
|
|
// omit the n-n relationships when updating the eloquent item |
|
31
|
5 |
|
$nn_relationships = array_pluck($this->getRelationFieldsWithPivot('create'), 'name'); |
|
32
|
5 |
|
$item = $this->model->create(array_except($data, $nn_relationships)); |
|
|
|
|
|
|
33
|
|
|
|
|
34
|
|
|
// if there are any relationships available, also sync those |
|
35
|
5 |
|
$this->createRelations($item, $data); |
|
36
|
|
|
|
|
37
|
5 |
|
return $item; |
|
38
|
|
|
} |
|
39
|
|
|
|
|
40
|
|
|
/** |
|
41
|
|
|
* Get all fields needed for the ADD NEW ENTRY form. |
|
42
|
|
|
* |
|
43
|
|
|
* @return [array] The fields with attributes and fake attributes. |
|
|
|
|
|
|
44
|
|
|
*/ |
|
45
|
23 |
|
public function getCreateFields() |
|
|
|
|
|
|
46
|
|
|
{ |
|
47
|
23 |
|
return $this->create_fields; |
|
|
|
|
|
|
48
|
|
|
} |
|
49
|
|
|
|
|
50
|
|
|
/** |
|
51
|
|
|
* Get all fields with relation set (model key set on field). |
|
52
|
|
|
* |
|
53
|
|
|
* @param [string: create/update/both] |
|
54
|
|
|
* |
|
55
|
|
|
* @return [array] The fields with model key set. |
|
|
|
|
|
|
56
|
|
|
*/ |
|
57
|
16 |
|
public function getRelationFields($form = 'create') |
|
58
|
|
|
{ |
|
59
|
16 |
|
if ($form == 'create') { |
|
60
|
14 |
|
$fields = $this->create_fields; |
|
61
|
|
|
} else { |
|
62
|
2 |
|
$fields = $this->update_fields; |
|
|
|
|
|
|
63
|
|
|
} |
|
64
|
|
|
|
|
65
|
16 |
|
$relationFields = []; |
|
66
|
|
|
|
|
67
|
16 |
|
foreach ($fields as $field) { |
|
68
|
15 |
|
if (isset($field['model'])) { |
|
69
|
9 |
|
array_push($relationFields, $field); |
|
70
|
|
|
} |
|
71
|
|
|
|
|
72
|
15 |
|
if (isset($field['subfields']) && |
|
73
|
15 |
|
is_array($field['subfields']) && |
|
74
|
15 |
|
count($field['subfields'])) { |
|
75
|
|
|
foreach ($field['subfields'] as $subfield) { |
|
76
|
15 |
|
array_push($relationFields, $subfield); |
|
77
|
|
|
} |
|
78
|
|
|
} |
|
79
|
|
|
} |
|
80
|
|
|
|
|
81
|
16 |
|
return $relationFields; |
|
82
|
|
|
} |
|
83
|
|
|
|
|
84
|
|
|
/** |
|
85
|
|
|
* Get all fields with n-n relation set (pivot table is true). |
|
86
|
|
|
* |
|
87
|
|
|
* @param [string: create/update/both] |
|
88
|
|
|
* |
|
89
|
|
|
* @return [array] The fields with n-n relationships. |
|
|
|
|
|
|
90
|
|
|
*/ |
|
91
|
8 |
|
public function getRelationFieldsWithPivot($form = 'create') |
|
92
|
|
|
{ |
|
93
|
8 |
|
$all_relation_fields = $this->getRelationFields($form); |
|
94
|
|
|
|
|
95
|
8 |
|
return array_where($all_relation_fields, function ($value, $key) { |
|
|
|
|
|
|
96
|
4 |
|
return isset($value['pivot']) && $value['pivot']; |
|
97
|
8 |
|
}); |
|
98
|
|
|
} |
|
99
|
|
|
|
|
100
|
|
|
/** |
|
101
|
|
|
* Create the relations for the current model. |
|
102
|
|
|
* |
|
103
|
|
|
* @param \Illuminate\Database\Eloquent\Model $item The current CRUD model. |
|
104
|
|
|
* @param array $data The form data. |
|
105
|
|
|
* @param string $form Optional form type. Can be either 'create', 'update' or 'both'. Default is 'create'. |
|
106
|
|
|
*/ |
|
107
|
6 |
|
public function createRelations($item, $data, $form = 'create') |
|
108
|
|
|
{ |
|
109
|
6 |
|
$this->syncPivot($item, $data, $form); |
|
110
|
6 |
|
$this->createDirectRelations($item, $data, $form); |
|
111
|
6 |
|
} |
|
112
|
|
|
|
|
113
|
|
|
/** |
|
114
|
|
|
* Sync the declared many-to-many associations through the pivot field. |
|
115
|
|
|
* |
|
116
|
|
|
* @param \Illuminate\Database\Eloquent\Model $model The current CRUD model. |
|
117
|
|
|
* @param array $data The form data. |
|
118
|
|
|
* @param string $form Optional form type. Can be either 'create', 'update' or 'both'. Default is 'create'. |
|
119
|
|
|
*/ |
|
120
|
9 |
|
public function syncPivot($model, $data, $form = 'create') |
|
121
|
|
|
{ |
|
122
|
9 |
|
$fields_with_relationships = $this->getRelationFields($form); |
|
123
|
|
|
|
|
124
|
9 |
|
foreach ($fields_with_relationships as $key => $field) { |
|
125
|
5 |
|
if (isset($field['pivot']) && $field['pivot']) { |
|
126
|
3 |
|
$values = isset($data[$field['name']]) ? $data[$field['name']] : []; |
|
127
|
3 |
|
$model->{$field['name']}()->sync($values); |
|
128
|
|
|
|
|
129
|
2 |
|
if (isset($field['pivotFields'])) { |
|
130
|
|
|
foreach ($field['pivotFields'] as $pivotField) { |
|
131
|
|
|
foreach ($data[$pivotField] as $pivot_id => $pivot_field) { |
|
132
|
|
|
$model->{$field['name']}()->updateExistingPivot($pivot_id, [$pivotField => $pivot_field]); |
|
133
|
|
|
} |
|
134
|
|
|
} |
|
135
|
|
|
} |
|
136
|
|
|
} |
|
137
|
|
|
|
|
138
|
4 |
|
if (isset($field['morph']) && $field['morph'] && isset($data[$field['name']])) { |
|
139
|
|
|
$values = $data[$field['name']]; |
|
140
|
4 |
|
$model->{$field['name']}()->sync($values); |
|
141
|
|
|
} |
|
142
|
|
|
} |
|
143
|
8 |
|
} |
|
144
|
|
|
|
|
145
|
|
|
/** |
|
146
|
|
|
* Create any existing direct (not n:n) relations for the current model from the form data. |
|
147
|
|
|
* |
|
148
|
|
|
* @param \Illuminate\Database\Eloquent\Model $item The current CRUD model. |
|
149
|
|
|
* @param array $data The form data. |
|
150
|
|
|
* @param string $form Optional form type. Can be either 'create', 'update' or 'both'. Default is 'create'. |
|
151
|
|
|
*/ |
|
152
|
6 |
|
private function createDirectRelations($item, $data, $form = 'create') |
|
153
|
|
|
{ |
|
154
|
6 |
|
$relationData = $this->getRelationDataFromFormData($data, $form); |
|
155
|
6 |
|
$this->createRelationsForItem($item, $relationData); |
|
156
|
6 |
|
} |
|
157
|
|
|
|
|
158
|
|
|
/** |
|
159
|
|
|
* Create any existing one to one relations for the current model from the relation data. |
|
160
|
|
|
* |
|
161
|
|
|
* @param \Illuminate\Database\Eloquent\Model $item The current CRUD model. |
|
162
|
|
|
* @param array $formattedData The form data. |
|
163
|
|
|
*/ |
|
164
|
6 |
|
private function createRelationsForItem($item, $formattedData) |
|
165
|
|
|
{ |
|
166
|
6 |
|
if (! isset($formattedData['relations'])) { |
|
167
|
4 |
|
return false; |
|
168
|
|
|
} |
|
169
|
|
|
|
|
170
|
2 |
|
foreach ($formattedData['relations'] as $relationMethod => $relationData) { |
|
171
|
2 |
|
$model = $relationData['model']; |
|
172
|
2 |
|
$relation = $item->{$relationMethod}(); |
|
173
|
2 |
|
if ($relation instanceof BelongsTo) { |
|
174
|
1 |
|
$modelInstance = $model::find($relationData['values'])->first(); |
|
175
|
1 |
|
if ($modelInstance != null) { |
|
176
|
1 |
|
$relation->associate($modelInstance)->save(); |
|
177
|
|
|
} else { |
|
178
|
1 |
|
$relation->dissociate()->save(); |
|
179
|
|
|
} |
|
180
|
1 |
|
} elseif ($relation instanceof HasOne) { |
|
181
|
|
|
if ($item->{$relationMethod} != null) { |
|
182
|
|
|
$item->{$relationMethod}->update([$relation->getForeignKeyName() => $relationData['fallback_id'] ?? null]); |
|
|
|
|
|
|
183
|
|
|
} |
|
184
|
|
|
|
|
185
|
|
|
$modelInstance = $model::find($relationData['values'][$relationMethod]); |
|
186
|
|
|
$relation->save($modelInstance); |
|
187
|
|
|
$modelInstance = $item->{$relationMethod}; |
|
188
|
1 |
|
} elseif ($relation instanceof HasMany) { |
|
189
|
1 |
|
$related_ids = collect($relationData['values'][$relationMethod]); |
|
190
|
1 |
|
$old_ids = $item->{$relationMethod}->pluck($relation->getRelated()->getKeyName()); |
|
191
|
1 |
|
$removed = $old_ids->diff($related_ids); |
|
192
|
1 |
|
$added = $related_ids->diff($old_ids); |
|
193
|
|
|
|
|
194
|
1 |
|
$instance = new $model(); |
|
195
|
1 |
|
$model::whereIn($instance->getKeyName(), $removed)->update([$relation->getForeignKeyName() => $relationData['fallback_id'] ?? null]); |
|
|
|
|
|
|
196
|
1 |
|
$model::whereIn($instance->getKeyName(), $added)->update([$relation->getForeignKeyName() => $item->getKey()]); |
|
|
|
|
|
|
197
|
|
|
} else { |
|
198
|
|
|
$relationModel = new $model(); |
|
199
|
|
|
$modelInstance = $relationModel->create($relationData['values']); |
|
200
|
|
|
$relation->save($modelInstance); |
|
201
|
|
|
} |
|
202
|
|
|
|
|
203
|
2 |
|
if (isset($relationData['relations'])) { |
|
204
|
2 |
|
$this->createRelationsForItem($modelInstance, ['relations' => $relationData['relations']]); |
|
|
|
|
|
|
205
|
|
|
} |
|
206
|
|
|
} |
|
207
|
2 |
|
} |
|
208
|
|
|
|
|
209
|
|
|
/** |
|
210
|
|
|
* Get a relation data array from the form data. |
|
211
|
|
|
* For each relation defined in the fields through the entity attribute, set the model, the parent model and the |
|
212
|
|
|
* attribute values. For relations defined with the "dot" notations, this will be used to calculate the depth in the |
|
213
|
|
|
* final array (@see \Illuminate\Support\Arr::set() for more). |
|
214
|
|
|
* |
|
215
|
|
|
* @param array $data The form data. |
|
216
|
|
|
* @param string $form Optional form type. Can be either 'create', 'update' or 'both'. Default is 'create'. |
|
217
|
|
|
* |
|
218
|
|
|
* @return array The formatted relation data. |
|
219
|
|
|
*/ |
|
220
|
6 |
|
private function getRelationDataFromFormData($data, $form = 'create') |
|
221
|
|
|
{ |
|
222
|
6 |
|
$relationFields = $this->getRelationFields($form); |
|
223
|
|
|
|
|
224
|
6 |
|
$relationData = []; |
|
225
|
6 |
|
foreach ($relationFields as $relationField) { |
|
226
|
3 |
|
$attributeKey = $relationField['name']; |
|
227
|
3 |
|
if (array_key_exists($attributeKey, $data) && empty($relationField['pivot'])) { |
|
228
|
2 |
|
$key = implode('.relations.', explode('.', $relationField['entity'])); |
|
229
|
2 |
|
$fieldData = array_get($relationData, 'relations.'.$key, []); |
|
230
|
|
|
|
|
231
|
2 |
|
if (! array_key_exists('model', $fieldData)) { |
|
232
|
2 |
|
$fieldData['model'] = $relationField['model']; |
|
233
|
|
|
} |
|
234
|
|
|
|
|
235
|
2 |
|
if (! array_key_exists('parent', $fieldData)) { |
|
236
|
2 |
|
$fieldData['parent'] = $this->getRelationModel($relationField['entity'], -1); |
|
|
|
|
|
|
237
|
|
|
} |
|
238
|
|
|
|
|
239
|
2 |
|
if (array_key_exists('fallback_id', $relationField)) { |
|
240
|
|
|
$fieldData['fallback_id'] = $relationField['fallback_id']; |
|
241
|
|
|
} |
|
242
|
|
|
|
|
243
|
2 |
|
$fieldData['values'][$attributeKey] = $data[$attributeKey]; |
|
244
|
|
|
|
|
245
|
3 |
|
array_set($relationData, 'relations.'.$key, $fieldData); |
|
246
|
|
|
} |
|
247
|
|
|
} |
|
248
|
|
|
|
|
249
|
6 |
|
return $relationData; |
|
250
|
|
|
} |
|
251
|
|
|
} |
|
252
|
|
|
|
This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.