Laravel-Backpack /
CRUD
We could not synchronize checks via GitHub's checks API since Scrutinizer's GitHub App is not installed for this repository.
| Total Complexity | 54 |
| Total Lines | 319 |
| Duplicated Lines | 0 % |
| Changes | 3 | ||
| Bugs | 2 | Features | 0 |
Complex classes like Create often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Create, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 10 | trait Create |
||
| 11 | { |
||
| 12 | /* |
||
| 13 | |-------------------------------------------------------------------------- |
||
| 14 | | CREATE |
||
| 15 | |-------------------------------------------------------------------------- |
||
| 16 | */ |
||
| 17 | |||
| 18 | /** |
||
| 19 | * Insert a row in the database. |
||
| 20 | * |
||
| 21 | * @param array $data All input values to be inserted. |
||
| 22 | * |
||
| 23 | * @return \Illuminate\Database\Eloquent\Model |
||
| 24 | */ |
||
| 25 | public function create($data) |
||
| 26 | { |
||
| 27 | $data = $this->decodeJsonCastedAttributes($data); |
||
|
Bug
introduced
by
|
|||
| 28 | $data = $this->compactFakeFields($data); |
||
| 29 | |||
| 30 | // omit the n-n relationships when updating the eloquent item |
||
| 31 | $nn_relationships = Arr::pluck($this->getRelationFieldsWithPivot(), 'name'); |
||
| 32 | $item = $this->model->create(Arr::except($data, $nn_relationships)); |
||
| 33 | |||
| 34 | // if there are any relationships available, also sync those |
||
| 35 | $this->createRelations($item, $data); |
||
| 36 | |||
| 37 | 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 | public function getCreateFields() |
||
| 46 | { |
||
| 47 | return $this->fields(); |
||
| 48 | } |
||
| 49 | |||
| 50 | /** |
||
| 51 | * Get all fields with relation set (model key set on field). |
||
| 52 | * |
||
| 53 | * @return array The fields with model key set. |
||
| 54 | */ |
||
| 55 | public function getRelationFields() |
||
| 56 | { |
||
| 57 | $fields = $this->fields(); |
||
| 58 | $relationFields = []; |
||
| 59 | |||
| 60 | foreach ($fields as $field) { |
||
| 61 | if (isset($field['model']) && $field['model'] !== false) { |
||
| 62 | array_push($relationFields, $field); |
||
| 63 | } |
||
| 64 | |||
| 65 | if (isset($field['subfields']) && |
||
| 66 | is_array($field['subfields']) && |
||
| 67 | count($field['subfields'])) { |
||
| 68 | foreach ($field['subfields'] as $subfield) { |
||
| 69 | array_push($relationFields, $subfield); |
||
| 70 | } |
||
| 71 | } |
||
| 72 | } |
||
| 73 | |||
| 74 | return $relationFields; |
||
| 75 | } |
||
| 76 | |||
| 77 | /** |
||
| 78 | * Get all fields with n-n relation set (pivot table is true). |
||
| 79 | * |
||
| 80 | * @return array The fields with n-n relationships. |
||
| 81 | */ |
||
| 82 | public function getRelationFieldsWithPivot() |
||
| 83 | { |
||
| 84 | $all_relation_fields = $this->getRelationFields(); |
||
| 85 | |||
| 86 | return Arr::where($all_relation_fields, function ($value, $key) { |
||
| 87 | return isset($value['pivot']) && $value['pivot']; |
||
| 88 | }); |
||
| 89 | } |
||
| 90 | |||
| 91 | /** |
||
| 92 | * Create the relations for the current model. |
||
| 93 | * |
||
| 94 | * @param \Illuminate\Database\Eloquent\Model $item The current CRUD model. |
||
| 95 | * @param array $data The form data. |
||
| 96 | */ |
||
| 97 | public function createRelations($item, $data) |
||
| 98 | { |
||
| 99 | $this->syncPivot($item, $data); |
||
| 100 | $this->createOneToOneRelations($item, $data); |
||
| 101 | } |
||
| 102 | |||
| 103 | /** |
||
| 104 | * Sync the declared many-to-many associations through the pivot field. |
||
| 105 | * |
||
| 106 | * @param \Illuminate\Database\Eloquent\Model $model The current CRUD model. |
||
| 107 | * @param array $data The form data. |
||
| 108 | */ |
||
| 109 | public function syncPivot($model, $data) |
||
| 110 | { |
||
| 111 | $fields_with_relationships = $this->getRelationFields(); |
||
| 112 | foreach ($fields_with_relationships as $key => $field) { |
||
| 113 | if (isset($field['pivot']) && $field['pivot']) { |
||
| 114 | $values = isset($data[$field['name']]) ? $data[$field['name']] : []; |
||
| 115 | |||
| 116 | // if a JSON was passed instead of an array, turn it into an array |
||
| 117 | if (is_string($values)) { |
||
| 118 | $values = json_decode($values); |
||
| 119 | } |
||
| 120 | |||
| 121 | $relation_data = []; |
||
| 122 | foreach ($values as $pivot_id) { |
||
| 123 | $pivot_data = []; |
||
| 124 | |||
| 125 | if (isset($field['pivotFields'])) { |
||
| 126 | foreach ($field['pivotFields'] as $pivot_field_name) { |
||
| 127 | $pivot_data[$pivot_field_name] = $data[$pivot_field_name][$pivot_id]; |
||
| 128 | } |
||
| 129 | } |
||
| 130 | $relation_data[$pivot_id] = $pivot_data; |
||
| 131 | } |
||
| 132 | |||
| 133 | $model->{$field['name']}()->sync($relation_data); |
||
| 134 | } |
||
| 135 | |||
| 136 | if (isset($field['morph']) && $field['morph'] && isset($data[$field['name']])) { |
||
| 137 | $values = $data[$field['name']]; |
||
| 138 | $model->{$field['name']}()->sync($values); |
||
| 139 | } |
||
| 140 | } |
||
| 141 | } |
||
| 142 | |||
| 143 | /** |
||
| 144 | * Create any existing one to one relations for the current model from the form data. |
||
| 145 | * |
||
| 146 | * @param \Illuminate\Database\Eloquent\Model $item The current CRUD model. |
||
| 147 | * @param array $data The form data. |
||
| 148 | */ |
||
| 149 | private function createOneToOneRelations($item, $data) |
||
| 153 | } |
||
| 154 | |||
| 155 | /** |
||
| 156 | * Create any existing one to one relations for the current model from the relation data. |
||
| 157 | * |
||
| 158 | * @param \Illuminate\Database\Eloquent\Model $item The current CRUD model. |
||
| 159 | * @param array $formattedData The form data. |
||
| 160 | * |
||
| 161 | * @return bool|null |
||
| 162 | */ |
||
| 163 | private function createRelationsForItem($item, $formattedData) |
||
| 164 | { |
||
| 165 | if (! isset($formattedData['relations'])) { |
||
| 166 | return false; |
||
| 167 | } |
||
| 168 | foreach ($formattedData['relations'] as $relationMethod => $relationData) { |
||
| 169 | if (! isset($relationData['model'])) { |
||
| 170 | continue; |
||
| 171 | } |
||
| 172 | $model = $relationData['model']; |
||
| 173 | $relation = $item->{$relationMethod}(); |
||
| 174 | |||
| 175 | if ($relation instanceof BelongsTo) { |
||
| 176 | $modelInstance = $model::find($relationData['values'])->first(); |
||
| 177 | if ($modelInstance != null) { |
||
| 178 | $relation->associate($modelInstance)->save(); |
||
| 179 | } else { |
||
| 180 | $relation->dissociate()->save(); |
||
| 181 | } |
||
| 182 | } elseif ($relation instanceof HasOne) { |
||
| 183 | if ($item->{$relationMethod} != null) { |
||
| 184 | $item->{$relationMethod}->update($relationData['values']); |
||
| 185 | $modelInstance = $item->{$relationMethod}; |
||
| 186 | } else { |
||
| 187 | $modelInstance = new $model($relationData['values']); |
||
| 188 | $relation->save($modelInstance); |
||
| 189 | } |
||
| 190 | } elseif ($relation instanceof HasMany) { |
||
| 191 | $relation_values = $relationData['values'][$relationMethod]; |
||
| 192 | $this->attachManyRelation($item, $relation, $relationMethod, $relationData, $relation_values); |
||
| 193 | } |
||
| 194 | |||
| 195 | if (isset($relationData['relations'])) { |
||
| 196 | $this->createRelationsForItem($modelInstance, ['relations' => $relationData['relations']]); |
||
| 197 | } |
||
| 198 | } |
||
| 199 | } |
||
| 200 | |||
| 201 | /** |
||
| 202 | * When using the HasMany/MorphMany relations as selectable elements we use this function to sync those relations. |
||
| 203 | * Here we allow for different functionality than when creating. Developer could use this relation as a |
||
| 204 | * selectable list of items that can belong to one/none entity at any given time. |
||
| 205 | * |
||
| 206 | * @return void |
||
| 207 | */ |
||
| 208 | public function attachManyRelation($item, $relation, $relationMethod, $relationData, $relation_values) |
||
| 253 | } |
||
| 254 | } |
||
| 255 | } |
||
| 256 | } |
||
| 257 | |||
| 258 | /** |
||
| 259 | * Get a relation data array from the form data. |
||
| 260 | * For each relation defined in the fields through the entity attribute, set the model, the parent model and the |
||
| 261 | * attribute values. |
||
| 262 | * |
||
| 263 | * We traverse this relation array later to create the relations, for example: |
||
| 264 | * |
||
| 265 | * Current model HasOne Address, this Address (line_1, country_id) BelongsTo Country through country_id in Address Model. |
||
| 266 | * |
||
| 267 | * So when editing current model crud user have two fields address.line_1 and address.country (we infer country_id from relation) |
||
| 268 | * |
||
| 269 | * Those will be nested accordingly in this relation array, so address relation will have a nested relation with country. |
||
| 270 | * |
||
| 271 | * |
||
| 272 | * @param array $data The form data. |
||
| 273 | * |
||
| 274 | * @return array The formatted relation data. |
||
| 275 | */ |
||
| 276 | private function getRelationDataFromFormData($data) |
||
| 277 | { |
||
| 278 | $relation_fields = $this->getRelationFields(); |
||
| 279 | |||
| 280 | $relation_fields = $this->parseRelationFieldNamesFromHtml($relation_fields); |
||
| 281 | |||
| 282 | //remove fields that are not in the submitted form. |
||
| 283 | $relation_fields = array_filter($relation_fields, function ($item) use ($data) { |
||
| 284 | return Arr::has($data, $item['name']); |
||
| 285 | }); |
||
| 286 | |||
| 287 | $relationData = []; |
||
| 288 | foreach ($relation_fields as $relation_field) { |
||
| 289 | $attributeKey = $relation_field['name']; |
||
| 290 | |||
| 291 | if (isset($relation_field['pivot']) && $relation_field['pivot'] !== true) { |
||
| 292 | $key = implode('.relations.', explode('.', $this->getOnlyRelationEntity($relation_field))); |
||
| 293 | $fieldData = Arr::get($relationData, 'relations.'.$key, []); |
||
| 294 | if (! array_key_exists('model', $fieldData)) { |
||
| 295 | $fieldData['model'] = $relation_field['model']; |
||
| 296 | } |
||
| 297 | if (! array_key_exists('parent', $fieldData)) { |
||
| 298 | $fieldData['parent'] = $this->getRelationModel($attributeKey, -1); |
||
| 299 | } |
||
| 300 | $relatedAttribute = Arr::last(explode('.', $attributeKey)); |
||
| 301 | $fieldData['values'][$relatedAttribute] = Arr::get($data, $attributeKey); |
||
| 302 | |||
| 303 | Arr::set($relationData, 'relations.'.$key, $fieldData); |
||
| 304 | } |
||
| 305 | } |
||
| 306 | |||
| 307 | return $relationData; |
||
| 308 | } |
||
| 309 | |||
| 310 | public function getOnlyRelationEntity($relation_field) |
||
| 329 | } |
||
| 330 | } |
||
| 331 |
Loading history...
