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 | 93 |
| Total Lines | 425 |
| Duplicated Lines | 0 % |
| Changes | 2 | ||
| Bugs | 2 | Features | 0 |
Complex classes like HandleRepeatableUploads 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 HandleRepeatableUploads, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 17 | trait HandleRepeatableUploads |
||
| 18 | { |
||
| 19 | public bool $handleRepeatableFiles = false; |
||
| 20 | |||
| 21 | public null|string $repeatableContainerName = null; |
||
| 22 | |||
| 23 | /******************************* |
||
| 24 | * Setters - fluently configure the uploader |
||
| 25 | *******************************/ |
||
| 26 | public function repeats(string $repeatableContainerName): self |
||
| 27 | { |
||
| 28 | $this->handleRepeatableFiles = true; |
||
| 29 | |||
| 30 | $this->repeatableContainerName = $repeatableContainerName; |
||
| 31 | |||
| 32 | return $this; |
||
| 33 | } |
||
| 34 | |||
| 35 | /******************************* |
||
| 36 | * Getters |
||
| 37 | *******************************/ |
||
| 38 | public function getRepeatableContainerName(): null|string |
||
| 39 | { |
||
| 40 | return $this->repeatableContainerName; |
||
| 41 | } |
||
| 42 | |||
| 43 | /******************************* |
||
| 44 | * Default implementation methods |
||
| 45 | *******************************/ |
||
| 46 | protected function uploadRepeatableFiles($values, $previousValues, $entry = null) |
||
| 47 | { |
||
| 48 | } |
||
| 49 | |||
| 50 | protected function handleRepeatableFiles(Model $entry): Model |
||
| 51 | { |
||
| 52 | $values = collect(CRUD::getRequest()->get($this->getRepeatableContainerName())); |
||
|
Bug
introduced
by
|
|||
| 53 | $files = collect(CRUD::getRequest()->file($this->getRepeatableContainerName())); |
||
| 54 | |||
| 55 | $value = $this->mergeValuesRecursive($values, $files); |
||
| 56 | |||
| 57 | if ($this->isRelationship()) { |
||
| 58 | if ($value->isEmpty()) { |
||
| 59 | return $entry; |
||
| 60 | } |
||
| 61 | |||
| 62 | return $this->processRelationshipRepeatableUploaders($entry); |
||
| 63 | } |
||
| 64 | |||
| 65 | $processedEntryValues = $this->processRepeatableUploads($entry, $value); |
||
| 66 | |||
| 67 | if ($this->isFake()) { |
||
| 68 | $fakeValues = $entry->{$this->getFakeAttribute()} ?? []; |
||
| 69 | |||
| 70 | if (is_string($fakeValues)) { |
||
| 71 | $fakeValues = json_decode($fakeValues, true); |
||
| 72 | } |
||
| 73 | |||
| 74 | $fakeValues[$this->getRepeatableContainerName()] = empty($processedEntryValues) |
||
| 75 | ? null |
||
| 76 | : (isset($entry->getCasts()[$this->getFakeAttribute()]) |
||
| 77 | ? $processedEntryValues |
||
| 78 | : json_encode($processedEntryValues)); |
||
| 79 | |||
| 80 | $entry->{$this->getFakeAttribute()} = isset($entry->getCasts()[$this->getFakeAttribute()]) |
||
| 81 | ? $fakeValues |
||
| 82 | : json_encode($fakeValues); |
||
| 83 | |||
| 84 | return $entry; |
||
| 85 | } |
||
| 86 | |||
| 87 | $entry->{$this->getRepeatableContainerName()} = empty($processedEntryValues) |
||
| 88 | ? null |
||
| 89 | : (isset($entry->getCasts()[$this->getRepeatableContainerName()]) |
||
| 90 | ? $processedEntryValues |
||
| 91 | : json_encode($processedEntryValues)); |
||
| 92 | |||
| 93 | return $entry; |
||
| 94 | } |
||
| 95 | |||
| 96 | private function processRelationshipRepeatableUploaders(Model $entry) |
||
| 97 | { |
||
| 98 | foreach (app('UploadersRepository')->getRepeatableUploadersFor($this->getRepeatableContainerName()) as $uploader) { |
||
| 99 | $entry = $uploader->uploadRelationshipFiles($entry); |
||
| 100 | } |
||
| 101 | |||
| 102 | return $entry; |
||
| 103 | } |
||
| 104 | |||
| 105 | protected function uploadRelationshipFiles(Model $entry): Model |
||
| 106 | { |
||
| 107 | $entryValue = $this->getFilesFromEntry($entry); |
||
| 108 | |||
| 109 | if ($this->handleMultipleFiles && is_string($entryValue)) { |
||
| 110 | try { |
||
| 111 | $entryValue = json_decode($entryValue, true); |
||
| 112 | } catch (\Exception) { |
||
| 113 | return $entry; |
||
| 114 | } |
||
| 115 | } |
||
| 116 | |||
| 117 | if ($this->hasDeletedFiles($entryValue)) { |
||
| 118 | $entry->{$this->getAttributeName()} = $this->uploadFiles($entry, false); |
||
| 119 | $this->updatedPreviousFiles = $this->getEntryAttributeValue($entry); |
||
| 120 | } |
||
| 121 | |||
| 122 | if ($this->shouldKeepPreviousValueUnchanged($entry, $entryValue)) { |
||
| 123 | $entry->{$this->getAttributeName()} = $this->updatedPreviousFiles ?? $this->getEntryOriginalValue($entry); |
||
| 124 | |||
| 125 | return $entry; |
||
| 126 | } |
||
| 127 | |||
| 128 | if ($this->shouldUploadFiles($entryValue)) { |
||
| 129 | $entry->{$this->getAttributeName()} = $this->uploadFiles($entry, $entryValue); |
||
| 130 | } |
||
| 131 | |||
| 132 | return $entry; |
||
| 133 | } |
||
| 134 | |||
| 135 | protected function getFilesFromEntry(Model $entry) |
||
| 136 | { |
||
| 137 | return $entry->getAttribute($this->getAttributeName()); |
||
| 138 | } |
||
| 139 | |||
| 140 | protected function getEntryAttributeValue(Model $entry) |
||
| 141 | { |
||
| 142 | return $entry->{$this->getAttributeName()}; |
||
| 143 | } |
||
| 144 | |||
| 145 | protected function getEntryOriginalValue(Model $entry) |
||
| 146 | { |
||
| 147 | return $entry->getOriginal($this->getAttributeName()); |
||
| 148 | } |
||
| 149 | |||
| 150 | protected function shouldUploadFiles($entryValue): bool |
||
| 151 | { |
||
| 152 | return true; |
||
| 153 | } |
||
| 154 | |||
| 155 | protected function hasDeletedFiles($entryValue): bool |
||
| 158 | } |
||
| 159 | |||
| 160 | protected function processRepeatableUploads(Model $entry, Collection $values): array |
||
| 161 | { |
||
| 162 | foreach (app('UploadersRepository')->getRepeatableUploadersFor($this->getRepeatableContainerName()) as $uploader) { |
||
| 163 | $uploadedValues = $uploader->uploadRepeatableFiles($values->pluck($uploader->getAttributeName())->toArray(), $this->getPreviousRepeatableValues($entry, $uploader)); |
||
| 164 | |||
| 165 | $values = $values->map(function ($item, $key) use ($uploadedValues, $uploader) { |
||
| 166 | $item[$uploader->getAttributeName()] = $uploadedValues[$key] ?? null; |
||
| 167 | |||
| 168 | return $item; |
||
| 169 | }); |
||
| 170 | } |
||
| 171 | |||
| 172 | return $values->toArray(); |
||
| 173 | } |
||
| 174 | |||
| 175 | private function retrieveRepeatableFiles(Model $entry): Model |
||
| 176 | { |
||
| 177 | if ($this->isRelationship) { |
||
| 178 | return $this->retrieveRepeatableRelationFiles($entry); |
||
| 179 | } |
||
| 180 | |||
| 181 | $repeatableUploaders = app('UploadersRepository')->getRepeatableUploadersFor($this->getRepeatableContainerName()); |
||
| 182 | |||
| 183 | if ($this->attachedToFakeField) { |
||
| 184 | $values = $entry->{$this->attachedToFakeField}; |
||
| 185 | |||
| 186 | $values = is_string($values) ? json_decode($values, true) : $values; |
||
| 187 | |||
| 188 | $values[$this->getAttributeName()] = isset($values[$this->getAttributeName()]) ? $this->getValueWithoutPath($values[$this->getAttributeName()]) : null; |
||
| 189 | $entry->{$this->attachedToFakeField} = isset($entry->getCasts()[$this->attachedToFakeField]) ? $values : json_encode($values); |
||
| 190 | |||
| 191 | return $entry; |
||
| 192 | } |
||
| 193 | |||
| 194 | $values = $entry->{$this->getRepeatableContainerName()}; |
||
| 195 | $values = is_string($values) ? json_decode($values, true) : $values; |
||
| 196 | $values = array_map(function ($item) use ($repeatableUploaders) { |
||
| 197 | foreach ($repeatableUploaders as $upload) { |
||
| 198 | $item[$upload->getAttributeName()] = $this->getValuesWithPathStripped($item, $upload); |
||
| 199 | } |
||
| 200 | |||
| 201 | return $item; |
||
| 202 | }, $values ?? []); |
||
| 203 | |||
| 204 | $entry->{$this->getRepeatableContainerName()} = $values; |
||
| 205 | |||
| 206 | return $entry; |
||
| 207 | } |
||
| 208 | |||
| 209 | private function retrieveRepeatableRelationFiles(Model $entry) |
||
| 210 | { |
||
| 211 | switch($this->getRepeatableRelationType()) { |
||
| 212 | case 'BelongsToMany': |
||
| 213 | case 'MorphToMany': |
||
| 214 | $pivotClass = app('crud')->getModel()->{$this->getUploaderSubfield()['baseEntity']}()->getPivotClass(); |
||
| 215 | $pivotFieldName = 'pivot_'.$this->getAttributeName(); |
||
| 216 | $connectedEntry = new $pivotClass([$this->getAttributeName() => $entry->$pivotFieldName]); |
||
| 217 | $entry->{$pivotFieldName} = $this->retrieveFiles($connectedEntry)->{$this->getAttributeName()}; |
||
| 218 | |||
| 219 | break; |
||
| 220 | default: |
||
| 221 | $entry = $this->retrieveFiles($entry); |
||
| 222 | } |
||
| 223 | |||
| 224 | return $entry; |
||
| 225 | } |
||
| 226 | |||
| 227 | private function getRepeatableRelationType() |
||
| 228 | { |
||
| 229 | return $this->getUploaderField()->getAttributes()['relation_type']; |
||
| 230 | } |
||
| 231 | |||
| 232 | private function getUploaderField() |
||
| 233 | { |
||
| 234 | return app('crud')->field($this->getRepeatableContainerName()); |
||
| 235 | } |
||
| 236 | |||
| 237 | private function getUploaderSubfield() |
||
| 240 | } |
||
| 241 | |||
| 242 | private function getUploaderFieldSubfields() |
||
| 245 | } |
||
| 246 | |||
| 247 | private function deleteRepeatableFiles(Model $entry): void |
||
| 248 | { |
||
| 249 | if ($this->isRelationship) { |
||
| 250 | $this->deleteRelationshipFiles($entry); |
||
| 251 | |||
| 252 | return; |
||
| 253 | } |
||
| 254 | |||
| 255 | if ($this->attachedToFakeField) { |
||
| 256 | $repeatableValues = $entry->{$this->attachedToFakeField}[$this->getRepeatableContainerName()] ?? null; |
||
| 257 | $repeatableValues = is_string($repeatableValues) ? json_decode($repeatableValues, true) : $repeatableValues; |
||
| 258 | $repeatableValues = collect($repeatableValues); |
||
| 259 | } |
||
| 260 | |||
| 261 | $repeatableValues ??= collect($entry->{$this->getRepeatableContainerName()}); |
||
| 262 | |||
| 263 | foreach (app('UploadersRepository')->getRepeatableUploadersFor($this->getRepeatableContainerName()) as $upload) { |
||
| 264 | if (! $upload->shouldDeleteFiles()) { |
||
| 265 | continue; |
||
| 266 | } |
||
| 267 | $values = $repeatableValues->pluck($upload->getName())->toArray(); |
||
| 268 | foreach ($values as $value) { |
||
| 269 | if (! $value) { |
||
| 270 | continue; |
||
| 271 | } |
||
| 272 | |||
| 273 | if (is_array($value)) { |
||
| 274 | foreach ($value as $subvalue) { |
||
| 275 | Storage::disk($upload->getDisk())->delete($upload->getPath().$subvalue); |
||
| 276 | } |
||
| 277 | |||
| 278 | continue; |
||
| 279 | } |
||
| 280 | |||
| 281 | Storage::disk($upload->getDisk())->delete($upload->getPath().$value); |
||
| 282 | } |
||
| 283 | } |
||
| 284 | } |
||
| 285 | /******************************* |
||
| 286 | * Helper methods |
||
| 287 | *******************************/ |
||
| 288 | |||
| 289 | /** |
||
| 290 | * Given two multidimensional arrays/collections, merge them recursively. |
||
| 291 | */ |
||
| 292 | protected function mergeValuesRecursive(array|Collection $array1, array|Collection $array2): array|Collection |
||
| 293 | { |
||
| 294 | $merged = $array1; |
||
| 295 | foreach ($array2 as $key => &$value) { |
||
| 296 | if (is_array($value) && isset($merged[$key]) && is_array($merged[$key])) { |
||
| 297 | $merged[$key] = $this->mergeValuesRecursive($merged[$key], $value); |
||
| 298 | } else { |
||
| 299 | $merged[$key] = $value; |
||
| 300 | } |
||
| 301 | } |
||
| 302 | |||
| 303 | return $merged; |
||
| 304 | } |
||
| 305 | |||
| 306 | /** |
||
| 307 | * Repeatable items send `_order_` parameter in the request. |
||
| 308 | * This holds the order of the items in the repeatable container. |
||
| 309 | */ |
||
| 310 | protected function getFileOrderFromRequest(): array |
||
| 311 | { |
||
| 312 | $items = CRUD::getRequest()->input('_order_'.$this->getRepeatableContainerName()) ?? []; |
||
| 313 | |||
| 314 | array_walk($items, function (&$key, $value) { |
||
| 315 | $requestValue = $key[$this->getName()] ?? null; |
||
| 316 | $key = $this->handleMultipleFiles ? (is_string($requestValue) ? explode(',', $requestValue) : $requestValue) : $requestValue; |
||
| 317 | }); |
||
| 318 | |||
| 319 | return $items; |
||
| 320 | } |
||
| 321 | |||
| 322 | private function getPreviousRepeatableValues(Model $entry, UploaderInterface $uploader): array |
||
| 323 | { |
||
| 324 | $previousValues = $entry->getOriginal($uploader->getRepeatableContainerName()); |
||
| 325 | |||
| 326 | if (! is_array($previousValues)) { |
||
| 327 | $previousValues = json_decode($previousValues, true); |
||
| 328 | } |
||
| 329 | |||
| 330 | if (! empty($previousValues)) { |
||
| 331 | $previousValues = array_column($previousValues, $uploader->getName()); |
||
| 332 | } |
||
| 333 | |||
| 334 | return $previousValues ?? []; |
||
| 335 | } |
||
| 336 | |||
| 337 | private function getValuesWithPathStripped(array|string|null $item, UploaderInterface $uploader) |
||
| 338 | { |
||
| 339 | $uploadedValues = $item[$uploader->getName()] ?? null; |
||
| 340 | if (is_array($uploadedValues)) { |
||
| 341 | return array_map(function ($value) use ($uploader) { |
||
| 342 | return $uploader->getValueWithoutPath($value); |
||
| 343 | }, $uploadedValues); |
||
| 344 | } |
||
| 345 | |||
| 346 | return isset($uploadedValues) ? $uploader->getValueWithoutPath($uploadedValues) : null; |
||
| 347 | } |
||
| 348 | |||
| 349 | private function deleteRelationshipFiles(Model $entry): void |
||
| 350 | { |
||
| 351 | if (! is_a($entry, Pivot::class, true) && |
||
| 352 | ! $entry->relationLoaded($this->getRepeatableContainerName()) && |
||
| 353 | method_exists($entry, $this->getRepeatableContainerName()) |
||
| 354 | ) { |
||
| 355 | $entry->loadMissing($this->getRepeatableContainerName()); |
||
| 356 | } |
||
| 357 | |||
| 358 | foreach (app('UploadersRepository')->getRepeatableUploadersFor($this->getRepeatableContainerName()) as $uploader) { |
||
| 359 | if ($uploader->shouldDeleteFiles()) { |
||
| 360 | $uploader->deleteRepeatableRelationFiles($entry); |
||
| 361 | } |
||
| 362 | } |
||
| 363 | } |
||
| 364 | |||
| 365 | protected function deleteRepeatableRelationFiles(Model $entry) |
||
| 366 | { |
||
| 367 | match ($this->getRepeatableRelationType()) { |
||
| 368 | 'BelongsToMany', 'MorphToMany' => $this->deletePivotFiles($entry), |
||
| 369 | default => $this->deleteRelatedFiles($entry), |
||
| 370 | }; |
||
| 371 | } |
||
| 372 | |||
| 373 | private function deleteRelatedFiles(Model $entry) |
||
| 385 | } |
||
| 386 | } |
||
| 387 | |||
| 388 | protected function deletePivotFiles(Pivot|Model $entry) |
||
| 389 | { |
||
| 390 | if (! is_a($entry, Pivot::class, true)) { |
||
| 391 | $pivots = $entry->{$this->getRepeatableContainerName()}; |
||
| 392 | foreach ($pivots as $pivot) { |
||
| 393 | $this->deletePivotModelFiles($pivot); |
||
| 394 | } |
||
| 395 | |||
| 411 | } |
||
| 412 | |||
| 413 | private function deletePivotModelFiles(Pivot|Model $entry) |
||
| 442 | } |
||
| 443 | } |
||
| 444 |
Loading history...
