FieldsProtectedMethods::makeSureSubfieldsHaveNecessaryAttributes()

Complexity

Conditions	20
Paths	673

Size

Total Lines	96
Code Lines	53

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	2	Features	0

<?php
    protected function makeSureSubfieldsHaveNecessaryAttributes($field)
    {
        if (! isset($field['subfields']) || ! is_array($field['subfields'])) {
            return $field;
        }

        if (! is_multidimensional_array($field['subfields'], true)) {
            abort(500, 'Subfields of «'.$field['name'].'» are malformed. Make sure you provide an array of subfields.', ['developer-error-exception']);
        }

        foreach ($field['subfields'] as $key => $subfield) {
            if (empty($subfield) || ! isset($subfield['name'])) {
                abort(500, 'A subfield of «'.$field['name'].'» is malformed. Subfield attribute name can\'t be empty.', ['developer-error-exception']);
            }

            // make sure the field definition is an array
            if (is_string($subfield)) {
                $subfield = ['name' => $subfield];
            }

            $subfield['name'] = Str::replace(' ', '', $subfield['name']);

            $subfield['parentFieldName'] = $field['name'];

            if (! isset($field['model'])) {
                // we're inside a simple 'repeatable' with no model/relationship, so
                // we assume all subfields are supposed to be text fields
                $subfield['type'] = $subfield['type'] ?? 'text';
                $subfield['entity'] = $subfield['entity'] ?? false;
            } else {
                // we should use 'model' as the `baseModel` for all subfields, so that when
                // we look if `category()` relationship exists on the model, we look on
                // the model this repeatable represents, not the main CRUD model
                $currentEntity = $subfield['baseEntity'] ?? $field['entity'];
                $subfield['baseModel'] = $subfield['baseModel'] ?? $field['model'];
                $subfield['baseEntity'] = isset($field['baseEntity']) ? $field['baseEntity'].'.'.$currentEntity : $currentEntity;
                $subfield['baseFieldName'] = is_array($subfield['name']) ? implode(',', $subfield['name']) : $subfield['name'];
                $subfield['baseFieldName'] = Str::afterLast($subfield['baseFieldName'], '.');
            }

            $field['subfields'][$key] = $this->makeSureFieldHasNecessaryAttributes($subfield);

The method makeSureFieldHasNecessaryAttributes() does not exist on Backpack\CRUD\app\Library\CrudPanel\Traits\FieldsProtectedMethods. Did you maybe mean makeSureFieldHasAttribute()?

        }

        // when field has any of `many` relations we need to append either the pivot selector for the `ToMany` or the
        // local key for the `many` relations. Other relations don't need any special treatment when used as subfields.
        if (isset($field['relation_type'])) {
            switch ($field['relation_type']) {
                case 'MorphToMany':
                case 'BelongsToMany':
                    $pivotSelectorField = static::getPivotFieldStructure($field);

                    $pivot = Arr::where($field['subfields'], function ($item) use ($pivotSelectorField) {
                        return $item['name'] === $pivotSelectorField['name'];
                    });

                    if (! empty($pivot)) {
                        break;
                    }

                    if ($field['allow_duplicate_pivots'] ?? false) {
                        $pivotSelectorField['allow_duplicate_pivots'] = true;
                        $field['subfields'] = Arr::prepend($field['subfields'], [
                            'name' => $field['pivot_key_name'] ?? 'id',
                            'type' => 'hidden',
                            'wrapper' => [
                                'class' => 'd-none',
                            ],
                        ]);
                    }

                    $this->setupFieldValidation($pivotSelectorField, $field['name']);

It seems like setupFieldValidation() must be provided by classes using this trait. How about adding it as abstract method to this trait?

                    $field['subfields'] = Arr::prepend($field['subfields'], $pivotSelectorField);

                    break;
                case 'MorphMany':
                case 'HasMany':
                    $entity = isset($field['baseEntity']) ? $field['baseEntity'].'.'.$field['entity'] : $field['entity'];
                    $relationInstance = $this->getRelationInstance(['entity' => $entity]);

It seems like getRelationInstance() must be provided by classes using this trait. How about adding it as abstract method to this trait?

                    $localKeyField = Arr::where($field['subfields'], function ($item) use ($relationInstance) {
                        return $item['name'] === $relationInstance->getRelated()->getKeyName();
                    });

                    if (! empty($localKeyField)) {
                        break;
                    }

                    $field['subfields'] = Arr::prepend($field['subfields'], [
                        'name' => $relationInstance->getRelated()->getKeyName(),
                        'type' => 'hidden',
                    ]);
                    break;
            }
        }

        return $field;
    }