Merge pull request #4069 from Laravel-Backpack/do-not-use-subfields-a…

…ttribute-only-for-checklist-dependency-field Allow other fields to use `subfields` attribute (not just `checklist_dependency`)
Laravel-Backpack · Jan 14, 2022 · 7ce65db · 7ce65db
2 parents 34785a0 + e53ca79
commit 7ce65db
Show file tree

Hide file tree

Showing 7 changed files with 33 additions and 30 deletions.
diff --git a/src/app/Library/CrudPanel/Traits/Create.php b/src/app/Library/CrudPanel/Traits/Create.php
@@ -66,11 +66,18 @@ public function getRelationFields()
                 array_push($relationFields, $field);
             }
 
-            if (isset($field['subfields']) &&
+            // if a field has an array name AND subfields
+            // then take those fields into account (check if they have relationships);
+            // this is done in particular for the checklist_dependency field,
+            // but other fields could use it too, in the future;
+            if (is_array($field['name']) &&
+                isset($field['subfields']) &&
                 is_array($field['subfields']) &&
                 count($field['subfields'])) {
                 foreach ($field['subfields'] as $subfield) {
-                    array_push($relationFields, $subfield);
+                    if (isset($subfield['model']) && $subfield['model'] !== false) {
+                        array_push($relationFields, $subfield);
+                    }
                 }
             }
         }

diff --git a/src/app/Library/CrudPanel/Traits/Update.php b/src/app/Library/CrudPanel/Traits/Update.php
@@ -52,17 +52,7 @@ public function getUpdateFields($id = false)
         $entry = ($id != false) ? $this->getEntry($id) : $this->getCurrentEntry();
 
         foreach ($fields as &$field) {
-            // set the value
-            if (! isset($field['value'])) {
-                if (isset($field['subfields'])) {
-                    $field['value'] = [];
-                    foreach ($field['subfields'] as $subfield) {
-                        $field['value'][] = $entry->{$subfield['name']};
-                    }
-                } else {
-                    $field['value'] = $this->getModelAttributeValue($entry, $field);
-                }
-            }
+            $field['value'] = $field['value'] ?? $this->getModelAttributeValue($entry, $field);
         }
 
         // always have a hidden input for the entry id
@@ -96,8 +86,8 @@ private function getModelAttributeValue($model, $field)
 
         if (is_array($field['name'])) {
             $result = [];
-            foreach ($field['name'] as $key => $value) {
-                $result = $model->{$value};
+            foreach ($field['name'] as $name) {
+                $result[] = $model->{$name};
             }
 
             return $result;
@@ -119,11 +109,12 @@ private function getModelAttributeValueFromRelationship($model, $field)
             case 'HasMany':
             case 'BelongsToMany':
             case 'MorphToMany':
-                if (! isset($field['pivotFields'])) {
+                // use subfields aka. pivotFields
+                if (! isset($field['subfields'])) {
                     return $related_model->{$relation_method};
                 }
                 // we want to exclude the "self pivot field" since we already have it.
-                $pivot_fields = Arr::where($field['pivotFields'], function ($item) use ($field) {
+                $pivot_fields = Arr::where($field['subfields'], function ($item) use ($field) {
                     return $field['name'] != $item['name'];
                 });
                 $related_models = $related_model->{$relation_method};
@@ -174,9 +165,9 @@ private function getModelAttributeValueFromRelationship($model, $field)
                     return $related_entry->{Str::afterLast($field['entity'], '.')};
                 }
 
-                if ($field['fields']) {
+                if ($field['subfields']) {
                     $result = [];
-                    foreach ($field['fields'] as $subfield) {
+                    foreach ($field['subfields'] as $subfield) {
                         $name = is_string($subfield) ? $subfield : $subfield['name'];
                         $result[$name] = $related_entry->{$name};
                     }

diff --git a/src/resources/views/crud/fields/date_range.blade.php b/src/resources/views/crud/fields/date_range.blade.php
@@ -19,13 +19,14 @@ function formatDate($entry, $dateFieldName)
             return $formattedDate;
         }
     }
+
     if (isset($field['value'])) {
         if (isset($entry) && ! is_array($field['value'])) {
             $start_value = formatDate($entry, $field['name'][0]);
             $end_value = formatDate($entry, $field['name'][1]);
-        } elseif (is_array($field['value'])) {
-            $start_value = $field['value'][$field['name'][0]];
-            $end_value = $field['value'][$field['name'][1]];
+        } elseif (is_array($field['value'])) { // gets here when inside repeatable
+            $start_value = current($field['value']); // first array item
+            $end_value = next($field['value']); // second array item
         }
     }
 

diff --git a/src/resources/views/crud/fields/inc/repeatable_row.blade.php b/src/resources/views/crud/fields/inc/repeatable_row.blade.php
@@ -4,7 +4,7 @@
 @endif
 
 <div class="col-md-12 well repeatable-element row m-1 p-2" data-repeatable-identifier="{{ $field['name'] }}">
-    @if (isset($field['fields']) && is_array($field['fields']) && count($field['fields']))
+    @if (isset($field['subfields']) && is_array($field['subfields']) && count($field['subfields']))
     <div class="controls">
         <button type="button" class="close delete-element"><span aria-hidden="true">×</span></button>
         @if ($field['reorder'])
@@ -16,7 +16,7 @@
         </button>
         @endif
     </div>
-    @foreach($field['fields'] as $subfield)
+    @foreach($field['subfields'] as $subfield)
         @php
             // make sure the field definition is an array
             if (is_string($subfield)) {

diff --git a/src/resources/views/crud/fields/relationship.blade.php b/src/resources/views/crud/fields/relationship.blade.php
@@ -20,6 +20,7 @@
     // if field is not ajax but user wants to use InlineCreate
     // we make minimum_input_length = 0 so when user open we show the entries like a regular select
     $field['minimum_input_length'] = ($field['ajax'] !== true) ? 0 : ($field['minimum_input_length'] ?? 2);
+    $field['subfields'] = $field['subfields'] ?? false;
 
     switch($field['relation_type']) {
         case 'HasOne':
@@ -44,7 +45,7 @@
             // The dev is trying to create a field for the ENTIRE hasOne/morphOne relationship
             // -----
             // if "subfields" is not defined, tell the dev to define it (+ link to docs)
-            if (!isset($field['fields'])) {
+            if (!is_array($field['subfields'])) {
                 abort(500, "<strong>Please define <code>subfields</code> on your <code>{$field['model']}</code> field.</strong><br>That way, you can allow the admin to edit the attributes on that related entry (through the hasOne relationship).<br>See <a target='_blank' href='https://backpackforlaravel.com/docs/crud-fields#crud-how-to#hasone-1-1-relationship'>the docs</a> for more information.");
             }
             // if "subfields" is defined, load a repeatable field with one entry (and 1 entry max)
@@ -54,7 +55,7 @@
         case 'BelongsToMany':
         case 'MorphToMany':
             // if there are pivot fields we show the repeatable field
-            if(isset($field['pivotFields'])) {
+            if(is_array($field['subfields'])) {
                 $field['type'] = 'relationship.entries';
                 break;
             }
@@ -80,7 +81,7 @@
             $field['force_delete'] = $field['force_delete'] ?? false;
 
             // if there are pivot fields we show the repeatable field
-            if(isset($field['pivotFields'])) {
+            if(is_array($field['subfields'])) {
                 $field['type'] = 'relationship.entries';
             } else {
                 // we show a regular/ajax select

diff --git a/src/resources/views/crud/fields/relationship/entries.blade.php b/src/resources/views/crud/fields/relationship/entries.blade.php
@@ -8,7 +8,9 @@
 
 @php
     $field['type'] = 'repeatable';
-    $field['fields'] = $field['pivotFields'];
+    //each row represent a related entry in a database table. We should not "auto-add" one relationship if it's not the user intention.
+    $field['init_rows'] = 0;
+    $field['subfields'] = $field['subfields'] ?? [];
     $field['reorder'] = $field['reorder'] ?? false;
     
     $pivotSelectorField = $field['pivotSelect'] ?? [];
@@ -27,12 +29,12 @@
     switch ($field['relation_type']) {
         case 'MorphToMany':
         case 'BelongsToMany':
-            $field['fields'] = Arr::prepend($field['fields'], $pivotSelectorField);
+            $field['subfields'] = Arr::prepend($field['subfields'], $pivotSelectorField);
             break;
         case 'MorphMany':
         case 'HasMany':
             if(isset($entry)) {
-                $field['fields'] = Arr::prepend($field['fields'], [
+                $field['subfields'] = Arr::prepend($field['subfields'], [
                     'name' => $entry->{$field['name']}()->getLocalKeyName(),
                     'type' => 'hidden',
                 ]);

diff --git a/src/resources/views/crud/fields/repeatable.blade.php b/src/resources/views/crud/fields/repeatable.blade.php
@@ -9,6 +9,7 @@
   $field['max_rows'] = $field['max_rows'] ?? 0;
   $field['min_rows'] =  $field['min_rows'] ?? 0;
   $field['reorder'] = $field['reorder'] ?? true;
+  $field['subfields'] = $field['subfields'] ?? $field['fields'] ?? [];
 @endphp
 
 @include('crud::fields.inc.wrapper_start')