Scrutinizer GitHub App not installed

We could not synchronize checks via GitHub's checks API since Scrutinizer's GitHub App is not installed for this repository.

Install GitHub App

Test Failed
Pull Request — master (#3410)
by
unknown
14:20
created

Create::getOnlyRelationEntity()   A

Complexity

Conditions 3
Paths 3

Size

Total Lines 19
Code Lines 10

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 3
eloc 10
nc 3
nop 1
dl 0
loc 19
rs 9.9332
c 0
b 0
f 0
1
<?php
2
3
namespace Backpack\CRUD\app\Library\CrudPanel\Traits;
4
5
use Illuminate\Database\Eloquent\Model;
6
use Illuminate\Database\Eloquent\Relations\HasMany;
7
use Illuminate\Database\Eloquent\Relations\HasOne;
8
use Illuminate\Database\Eloquent\Relations\MorphMany;
9
use Illuminate\Database\Eloquent\Relations\MorphOne;
10
use Illuminate\Support\Arr;
11
12
trait Create
13
{
14
    /*
15
    |--------------------------------------------------------------------------
16
    |                                   CREATE
17
    |--------------------------------------------------------------------------
18
    */
19
20
    /**
21
     * Insert a row in the database.
22
     *
23
     * @param array $data All input values to be inserted.
24
     *
25
     * @return \Illuminate\Database\Eloquent\Model
26
     */
27
    public function create($data)
28
    {
29
        $data = $this->decodeJsonCastedAttributes($data);
0 ignored issues
show
Bug introduced by
It seems like decodeJsonCastedAttributes() must be provided by classes using this trait. How about adding it as abstract method to this trait? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

29
        /** @scrutinizer ignore-call */ 
30
        $data = $this->decodeJsonCastedAttributes($data);
Loading history...
30
        $data = $this->compactFakeFields($data);
0 ignored issues
show
Bug introduced by
It seems like compactFakeFields() must be provided by classes using this trait. How about adding it as abstract method to this trait? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

30
        /** @scrutinizer ignore-call */ 
31
        $data = $this->compactFakeFields($data);
Loading history...
31
32
        // omit the n-n relationships when updating the eloquent item
33
        $relationships = Arr::pluck($this->getRelationFields(), 'name');
34
35
        // init and fill model
36
        $item = $this->model->make(Arr::except($data, $relationships));
37
38
        // handle BelongsTo 1:1 relations
39
        $item = $this->associateOrDissociateBelongsToRelations($item, $data);
0 ignored issues
show
Bug introduced by
It seems like associateOrDissociateBelongsToRelations() must be provided by classes using this trait. How about adding it as abstract method to this trait? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

39
        /** @scrutinizer ignore-call */ 
40
        $item = $this->associateOrDissociateBelongsToRelations($item, $data);
Loading history...
40
        $item->save();
41
42
        // if there are any other relations create them.
43
        $this->createRelations($item, $data);
44
45
        return $item;
46
    }
47
48
    /**
49
     * Get all fields needed for the ADD NEW ENTRY form.
50
     *
51
     * @return array The fields with attributes and fake attributes.
52
     */
53
    public function getCreateFields()
54
    {
55
        return $this->fields();
0 ignored issues
show
Bug introduced by
It seems like fields() must be provided by classes using this trait. How about adding it as abstract method to this trait? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

55
        return $this->/** @scrutinizer ignore-call */ fields();
Loading history...
56
    }
57
58
    /**
59
     * Get all fields with relation set (model key set on field).
60
     *
61
     * @return array The fields with model key set.
62
     */
63
    public function getRelationFields()
64
    {
65
        $fields = $this->fields();
66
        $relationFields = [];
67
68
        foreach ($fields as $field) {
69
            if (isset($field['model']) && $field['model'] !== false) {
70
                array_push($relationFields, $field);
71
            }
72
73
            if (isset($field['subfields']) &&
74
                is_array($field['subfields']) &&
75
                count($field['subfields'])) {
76
                foreach ($field['subfields'] as $subfield) {
77
                    array_push($relationFields, $subfield);
78
                }
79
            }
80
        }
81
82
        return $relationFields;
83
    }
84
85
    /**
86
     * Get all fields with n-n relation set (pivot table is true).
87
     *
88
     * @return array The fields with n-n relationships.
89
     */
90
    public function getRelationFieldsWithPivot()
91
    {
92
        $all_relation_fields = $this->getRelationFields();
93
94
        return Arr::where($all_relation_fields, function ($value, $key) {
95
            return isset($value['pivot']) && $value['pivot'];
96
        });
97
    }
98
99
    /**
100
     * Create the relations for the current model.
101
     *
102
     * @param \Illuminate\Database\Eloquent\Model $item The current CRUD model.
103
     * @param array                               $data The form data.
104
     */
105
    public function createRelations($item, $data)
106
    {
107
        $this->syncPivot($item, $data);
108
        $this->createOneToOneRelations($item, $data);
109
    }
110
111
    /**
112
     * Sync the declared many-to-many associations through the pivot field.
113
     *
114
     * @param \Illuminate\Database\Eloquent\Model $model The current CRUD model.
115
     * @param array                               $data  The form data.
116
     */
117
    public function syncPivot($model, $data)
118
    {
119
        $fields_with_relationships = $this->getRelationFieldsWithPivot();
120
        foreach ($fields_with_relationships as $key => $field) {
121
            $values = isset($data[$field['name']]) ? $data[$field['name']] : [];
122
123
            // if a JSON was passed instead of an array, turn it into an array
124
            if (is_string($values)) {
125
                $decoded_values = json_decode($values, true);
126
                $values = [];
127
                //array is not multidimensional
128
                if (count($decoded_values) != count($decoded_values, COUNT_RECURSIVE)) {
129
                    foreach ($decoded_values as $value) {
130
                        $values[] = $value[$field['name']];
131
                    }
132
                } else {
133
                    $values = $decoded_values;
134
                }
135
            }
136
137
            $relation_data = [];
138
139
            foreach ($values as $pivot_id) {
140
                if ($pivot_id != '') {
141
                    $pivot_data = [];
142
143
                    if (isset($field['pivotFields'])) {
144
                        //array is not multidimensional
145
                        if (count($field['pivotFields']) == count($field['pivotFields'], COUNT_RECURSIVE)) {
146
                            foreach ($field['pivotFields'] as $pivot_field_name) {
147
                                $pivot_data[$pivot_field_name] = $data[$pivot_field_name][$pivot_id];
148
                            }
149
                        } else {
150
                            $field_data = json_decode($data[$field['name']], true);
151
152
                            //we grab from the parsed data the specific values for this pivot
153
                            $pivot_data = Arr::first(Arr::where($field_data, function ($item) use ($pivot_id, $field) {
154
                                return $item[$field['name']] === $pivot_id;
155
                            }));
156
157
                            //we remove the relation field from extra pivot data as we already have the relation.
158
                            unset($pivot_data[$field['name']]);
159
                        }
160
                    }
161
162
                    $relation_data[$pivot_id] = $pivot_data;
163
                }
164
165
                $model->{$field['name']}()->sync($relation_data);
166
167
                if (isset($field['morph']) && $field['morph'] && isset($data[$field['name']])) {
168
                    $values = $data[$field['name']];
169
                    $model->{$field['name']}()->sync($values);
170
                }
171
            }
172
        }
173
    }
174
175
    /**
176
     * Create any existing one to one relations and subsquent relations for the item.
177
     *
178
     * @param \Illuminate\Database\Eloquent\Model $item The current CRUD model.
179
     * @param array                               $data The form data.
180
     */
181
    private function createOneToOneRelations($item, $data)
182
    {
183
        $relationData = $this->getRelationDataFromFormData($data);
184
        $this->createRelationsForItem($item, $relationData);
185
    }
186
187
    /**
188
     * Create any existing one to one relations and subsquent relations from form data.
189
     *
190
     * @param \Illuminate\Database\Eloquent\Model $item          The current CRUD model.
191
     * @param array                               $formattedData The form data.
192
     *
193
     * @return bool|null
194
     */
195
    private function createRelationsForItem($item, $formattedData)
196
    {
197
        if (! isset($formattedData['relations'])) {
198
            return false;
199
        }
200
201
        foreach ($formattedData['relations'] as $relationMethod => $relationData) {
202
            if (! isset($relationData['model'])) {
203
                continue;
204
            }
205
206
            $relation = $item->{$relationMethod}();
207
208
            if ($relation instanceof HasOne || $relation instanceof MorphOne) {
209
                if (isset($relationData['relations'])) {
210
                    $belongsToRelations = Arr::where($relationData['relations'], function ($relation_data) {
211
                        return $relation_data['relation_type'] == 'BelongsTo';
212
                    });
213
                    // adds the values of the BelongsTo relations of this entity to the array of values that will
214
                    // be saved at the same time like we do in parent entity belongs to relations
215
                    $valuesWithRelations = $this->associateHasOneBelongsTo($belongsToRelations, $relationData['values'], $relation->getModel());
216
217
                    $relationData['relations'] = Arr::where($relationData['relations'], function ($item) {
218
                        return $item['relation_type'] != 'BelongsTo';
219
                    });
220
221
                    $modelInstance = $relation->updateOrCreate([], $valuesWithRelations);
222
                } else {
223
                    $modelInstance = $relation->updateOrCreate([], $relationData['values']);
224
                }
225
            } elseif ($relation instanceof HasMany || $relation instanceof MorphMany) {
226
                $relation_values = $relationData['values'][$relationMethod];
227
228
                if (is_string($relation_values)) {
229
                    $relation_values = json_decode($relationData['values'][$relationMethod], true);
230
                }
231
232
                if (is_null($relation_values) || count($relation_values) == count($relation_values, COUNT_RECURSIVE)) {
233
                    $this->attachManyRelation($item, $relation, $relationMethod, $relationData, $relation_values);
234
                } else {
235
                    $this->createManyEntries($item, $relation, $relationMethod, $relationData);
236
                }
237
            }
238
239
            if (isset($relationData['relations'])) {
240
                $this->createRelationsForItem($modelInstance, ['relations' => $relationData['relations']]);
0 ignored issues
show
Comprehensibility Best Practice introduced by
The variable $modelInstance does not seem to be defined for all execution paths leading up to this point.
Loading history...
241
            }
242
        }
243
    }
244
245
    private function associateHasOneBelongsTo($belongsToRelations, $modelValues, $modelInstance)
246
    {
247
        foreach ($belongsToRelations as $methodName => $values) {
248
            $relation = $modelInstance->{$methodName}();
249
            $modelValues[$relation->getForeignKeyName()] = $values['values'][$methodName];
250
        }
251
252
        return $modelValues;
253
    }
254
255
    /**
256
     * Get a relation data array from the form data.
257
     * For each relation defined in the fields through the entity attribute, set the model, the parent model and the
258
     * attribute values.
259
     *
260
     * We traverse this relation array later to create the relations, for example:
261
     *
262
     * Current model HasOne Address, this Address (line_1, country_id) BelongsTo Country through country_id in Address Model.
263
     *
264
     * So when editing current model crud user have two fields address.line_1 and address.country (we infer country_id from relation)
265
     *
266
     * Those will be nested accordingly in this relation array, so address relation will have a nested relation with country.
267
     *
268
     *
269
     * @param array $data The form data.
270
     *
271
     * @return array The formatted relation data.
272
     */
273
    private function getRelationDataFromFormData($data)
274
    {
275
        // exclude the already attached belongs to relations but include nested belongs to.
276
        $relation_fields = Arr::where($this->getRelationFields(), function ($field, $key) {
277
            return $field['relation_type'] !== 'BelongsTo' || $this->isNestedRelation($field);
0 ignored issues
show
Bug introduced by
It seems like isNestedRelation() must be provided by classes using this trait. How about adding it as abstract method to this trait? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

277
            return $field['relation_type'] !== 'BelongsTo' || $this->/** @scrutinizer ignore-call */ isNestedRelation($field);
Loading history...
278
        });
279
280
        $relationData = [];
281
282
        foreach ($relation_fields as $relation_field) {
283
            $attributeKey = $this->parseRelationFieldNamesFromHtml([$relation_field])[0]['name'];
0 ignored issues
show
Bug introduced by
It seems like parseRelationFieldNamesFromHtml() must be provided by classes using this trait. How about adding it as abstract method to this trait? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

283
            $attributeKey = $this->/** @scrutinizer ignore-call */ parseRelationFieldNamesFromHtml([$relation_field])[0]['name'];
Loading history...
284
            if (isset($relation_field['pivot']) && $relation_field['pivot'] !== true) {
285
                $key = implode('.relations.', explode('.', $this->getOnlyRelationEntity($relation_field)));
286
                $fieldData = Arr::get($relationData, 'relations.'.$key, []);
287
                if (! array_key_exists('model', $fieldData)) {
288
                    $fieldData['model'] = $relation_field['model'];
289
                }
290
                if (! array_key_exists('parent', $fieldData)) {
291
                    $fieldData['parent'] = $this->getRelationModel($attributeKey, -1);
0 ignored issues
show
Bug introduced by
The method getRelationModel() does not exist on Backpack\CRUD\app\Library\CrudPanel\Traits\Create. Did you maybe mean getRelationFields()? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

291
                    /** @scrutinizer ignore-call */ 
292
                    $fieldData['parent'] = $this->getRelationModel($attributeKey, -1);

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
292
                }
293
294
                if (array_key_exists('fallback_id', $relation_field)) {
295
                    $fieldData['fallback_id'] = $relation_field['fallback_id'];
296
                }
297
298
                $fieldData['force_delete'] = $relation_field['force_delete'] ?? false;
299
300
                if (! array_key_exists('relation_type', $fieldData)) {
301
                    $fieldData['relation_type'] = $relation_field['relation_type'];
302
                }
303
                $relatedAttribute = Arr::last(explode('.', $attributeKey));
304
                $fieldData['values'][$relatedAttribute] = Arr::get($data, $attributeKey);
305
306
                Arr::set($relationData, 'relations.'.$key, $fieldData);
307
            }
308
        }
309
310
        return $relationData;
311
    }
312
313
    public function getOnlyRelationEntity($relation_field)
314
    {
315
        $entity_array = explode('.', $relation_field['entity']);
316
317
        $relation_model = $this->getRelationModel($relation_field['entity'], -1);
318
319
        $related_method = Arr::last($entity_array);
320
321
        if (! method_exists($relation_model, $related_method)) {
322
            if (count($entity_array) <= 1) {
323
                return $relation_field['entity'];
324
            } else {
325
                array_pop($entity_array);
326
            }
327
328
            return implode('.', $entity_array);
329
        }
330
331
        return $relation_field['entity'];
332
    }
333
334
    /**
335
     * When using the HasMany/MorphMany relations as selectable elements we use this function to sync those relations.
336
     * Here we allow for different functionality than when creating. Developer could use this relation as a
337
     * selectable list of items that can belong to one/none entity at any given time.
338
     *
339
     * @return void
340
     */
341
    public function attachManyRelation($item, $relation, $relationMethod, $relationData, $relation_values)
342
    {
343
        $model_instance = $relation->getRelated();
344
        $force_delete = $relationData['force_delete'];
345
346
        $relation_column_is_nullable = $model_instance->isColumnNullable($relation->getForeignKeyName());
347
348
        if (! is_null($relation_values) && $relationData['values'][$relationMethod][0] !== null) {
349
            //we add the new values into the relation
350
            $model_instance->whereIn($model_instance->getKeyName(), $relation_values)
351
           ->update([$relation->getForeignKeyName() => $item->{$relation->getLocalKeyName()}]);
352
353
            //we clear up any values that were removed from model relation.
354
            //if developer provided a fallback id, we use it
355
            //if column is nullable we set it to null
356
            //if none of the above we delete the model from database
357
            if (isset($relationData['fallback_id'])) {
358
                $model_instance->whereNotIn($model_instance->getKeyName(), $relation_values)
359
                            ->where($relation->getForeignKeyName(), $item->{$relation->getLocalKeyName()})
360
                            ->update([$relation->getForeignKeyName() => $relationData['fallback_id']]);
361
            } else {
362
                if (! $relation_column_is_nullable || $force_delete) {
363
                    $model_instance->whereNotIn($model_instance->getKeyName(), $relation_values)
364
                            ->where($relation->getForeignKeyName(), $item->{$relation->getLocalKeyName()})
365
                            ->delete();
366
                } else {
367
                    $model_instance->whereNotIn($model_instance->getKeyName(), $relation_values)
368
                            ->where($relation->getForeignKeyName(), $item->{$relation->getLocalKeyName()})
369
                            ->update([$relation->getForeignKeyName() => null]);
370
                }
371
            }
372
        } else {
373
            //the developer cleared the selection
374
            //we gonna clear all related values by setting up the value to the fallback id, to null or delete.
375
            if (isset($relationData['fallback_id'])) {
376
                $model_instance->where($relation->getForeignKeyName(), $item->{$relation->getLocalKeyName()})
377
                            ->update([$relation->getForeignKeyName() => $relationData['fallback_id']]);
378
            } else {
379
                if (! $relation_column_is_nullable || $force_delete) {
380
                    $model_instance->where($relation->getForeignKeyName(), $item->{$relation->getLocalKeyName()})->delete();
381
                } else {
382
                    $model_instance->where($relation->getForeignKeyName(), $item->{$relation->getLocalKeyName()})
383
                            ->update([$relation->getForeignKeyName() => null]);
384
                }
385
            }
386
        }
387
    }
388
389
    /**
390
     * Handler HasMany/MorphMany relations when used as creatable entries in the crud.
391
     * By using repeatable field, developer can allow the creation of such entries
392
     * in the crud forms.
393
     *
394
     * @return void
395
     */
396
    public function createManyEntries($entry, $relation, $relationMethod, $relationData)
397
    {
398
        $items = collect(json_decode($relationData['values'][$relationMethod], true));
399
        $relatedModel = $relation->getRelated();
400
        $itemsInDatabase = $entry->{$relationMethod};
0 ignored issues
show
Unused Code introduced by
The assignment to $itemsInDatabase is dead and can be removed.
Loading history...
401
        //if the collection is empty we clear all previous values in database if any.
402
        if ($items->isEmpty()) {
403
            $entry->{$relationMethod}()->sync([]);
404
        } else {
405
            $items->each(function (&$item, $key) use ($relatedModel, $entry, $relationMethod) {
406
                if (isset($item[$relatedModel->getKeyName()])) {
407
                    $entry->{$relationMethod}()->updateOrCreate([$relatedModel->getKeyName() => $item[$relatedModel->getKeyName()]], $item);
408
                } else {
409
                    $entry->{$relationMethod}()->updateOrCreate([], $item);
410
                }
411
            });
412
413
            $relatedItemsSent = $items->pluck($relatedModel->getKeyName());
414
415
            if (! $relatedItemsSent->isEmpty()) {
416
                $itemsInDatabase = $entry->{$relationMethod};
417
                //we perform the cleanup of removed database items
418
                $itemsInDatabase->each(function ($item, $key) use ($relatedItemsSent) {
419
                    if (! $relatedItemsSent->contains($item->getKey())) {
420
                        $item->delete();
421
                    }
422
                });
423
            }
424
        }
425
    }
426
}
427