Merge pull request #3606 from Laravel-Backpack/relationship-columns-definition

Relationship columns definition

Author: tabacitu

src/app/Library/CrudPanel/CrudPanel.php

@@ -385,7 +385,7 @@ public function getRelatedEntriesAttributes($model, $relationString, $attribute)
                 //if attribute does not exist in main array we have more than one entry OR the attribute
                 //is an acessor that is not in $appends property of model.
                 if (! isset($entries[$attribute])) {
-                    //we first check if we don't have the attribute because it's and acessor that is not in appends.
+                    //we first check if we don't have the attribute because it's an acessor that is not in appends.
                     if ($model_instance->hasGetMutator($attribute) && isset($entries[$modelKey])) {
                         $entry_in_database = $model_instance->find($entries[$modelKey]);
                         $attributes[$entry_in_database->{$modelKey}] = $this->parseTranslatableAttributes($model_instance, $attribute, $entry_in_database->{$attribute});
@@ -458,7 +458,7 @@ public function parseTranslatableAttributes($model, $attribute, $value)
      */
     private function getRelatedEntries($model, $relationString)
     {
-        $relationArray = explode('.', $relationString);
+        $relationArray = explode('.', $this->getOnlyRelationEntity(['entity' => $relationString]));
         $firstRelationName = Arr::first($relationArray);
         $relation = $model->{$firstRelationName};
 

src/app/Library/CrudPanel/Traits/Columns.php

@@ -360,10 +360,10 @@ public function firstColumnWhere($attribute, $value)
     public function makeSureColumnHasNeededAttributes($column)
     {
         $column = $this->makeSureColumnHasName($column);
+        $column = $this->makeSureColumnHasKey($column);
         $column = $this->makeSureColumnHasLabel($column);
         $column = $this->makeSureColumnHasEntity($column);
         $column = $this->makeSureColumnHasType($column);
-        $column = $this->makeSureColumnHasKey($column);
         $column = $this->makeSureColumnHasPriority($column);
         $column = $this->makeSureColumnHasModel($column);
 

src/app/Library/CrudPanel/Traits/ColumnsProtectedMethods.php

@@ -150,6 +150,27 @@ protected function makeSureColumnHasEntity($column)
                 // if it has parameters it's not a relation method.
                 $column['entity'] = $this->modelMethodHasParameters($this->model, $possibleMethodName) ? false : $column['name'];
 
+                $parts = explode('.', $column['entity']);
+
+                $attribute_in_relation = false;
+
+                $model = $this->model;
+
+                // here we are going to iterate through all relation parts to check
+                // if the attribute is present in the relation string.
+                foreach ($parts as $i => $part) {
+                    try {
+                        $model = $model->$part()->getRelated();
+                    } catch (\Exception $e) {
+                        $attribute_in_relation = true;
+                    }
+                }
+                // if the user setup the attribute in relation string, we are not going to infer that attribute from model
+                // instead we get the defined attribute by the user.
+                if ($attribute_in_relation) {
+                    $column['attribute'] = $column['attribute'] ?? end($parts);
+                }
+
                 return $column;
             }
         }

src/resources/views/crud/columns/select_multiple.blade.php

@@ -6,10 +6,11 @@
     $column['limit'] = $column['limit'] ?? 40;
     $column['attribute'] = $column['attribute'] ?? (new $column['model'])->identifiableAttribute();
 
+
     $results = data_get($entry, $column['name']);
     $results_array = [];
 
-    if(!$results->isEmpty()) {
+    if($results !== null && !$results->isEmpty()) {
         $related_key = $results->first()->getKeyName();
         $results_array = $results->pluck($column['attribute'], $related_key)->toArray();
     }
@@ -43,4 +44,4 @@
     @else
         -
     @endif
-</span>
+</span>

tests/Unit/CrudPanel/CrudPanelColumnsTest.php

@@ -135,6 +135,7 @@ class CrudPanelColumnsTest extends BaseDBCrudPanelTest
             'type'        => 'relationship',
             'key'         => 'accountDetails__nickname',
             'priority'    => 1,
+            'attribute' => 'nickname',
             'tableColumn' => false,
             'orderable'   => false,
             'searchLogic' => false,