Merge pull request #5270 from Laravel-Backpack/crud-column-support-array

Add array support to CrudColumn object.

Author: pxpm

src/app/Library/CrudPanel/CrudColumn.php

@@ -38,15 +38,15 @@ class CrudColumn
 
     protected $attributes;
 
-    public function upload($upload = true)
+    public function __construct($nameOrDefinitionArray)
     {
-        $this->attributes['upload'] = $upload;
-
-        return $this->save();
-    }
+        if (is_array($nameOrDefinitionArray)) {
+            $column = $this->crud()->addAndReturnColumn($nameOrDefinitionArray);
+            $name = $column->getAttributes()['name'];
+        } else {
+            $name = $nameOrDefinitionArray;
+        }
 
-    public function __construct($name)
-    {
         $column = $this->crud()->firstColumnWhere('name', $name);
 
         // if column exists
@@ -159,6 +159,13 @@ public function before($destinationColumn)
         return $this;
     }
 
+    public function upload($upload = true)
+    {
+        $this->attributes['upload'] = $upload;
+
+        return $this->save();
+    }
+
     /**
      * Make the current column the first one in the columns list.
      *

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

@@ -66,14 +66,21 @@ public function setColumns($columns)
      */
     public function addColumn($column)
     {
-        $column = $this->makeSureColumnHasNeededAttributes($column);
-        $this->addColumnToOperationSettings($column);
-
-        (new CrudColumn($column['name']))->callRegisteredAttributeMacros();
+        $this->prepareAttributesAndAddColumn($column);
 
         return $this;
     }
 
+    /**
+     * Add a column at the end of the CRUD object's "columns" array and return it.
+     */
+    public function addAndReturnColumn(array|string $column): CrudColumn
+    {
+        $column = $this->prepareAttributesAndAddColumn($column);
+
+        return $column;
+    }
+
     /**
      * Add multiple columns at the end of the CRUD object's "columns" array.
      *
@@ -405,15 +412,16 @@ public function countColumnsWithoutActions()
      * in addition to the existing options:
      * - CRUD::addColumn(['name' => 'price', 'type' => 'number']);
      * - CRUD::column('price')->type('number');
+     * - CRUD::column(['name' => 'price', 'type' => 'number']);
      *
      * And if the developer uses the CrudColumn object as Column in their CrudController:
      * - Column::name('price')->type('number');
      *
-     * @param  string  $name  The name of the column in the db, or model attribute.
+     * @param  string|array  $name  The name of the column in the db, or model attribute.
      * @return CrudColumn
      */
-    public function column($name)
+    public function column($nameOrDefinition)
     {
-        return new CrudColumn($name);
+        return new CrudColumn($nameOrDefinition);
     }
 }

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

@@ -2,6 +2,7 @@
 
 namespace Backpack\CRUD\app\Library\CrudPanel\Traits;
 
+use Backpack\CRUD\app\Library\CrudPanel\CrudColumn;
 use Illuminate\Support\Arr;
 use Illuminate\Support\Str;
 
@@ -325,4 +326,17 @@ protected function hasDatabaseColumn($table, $name)
 
         return in_array($name, $columns);
     }
+
+    /**
+     * Prepare the column attributes and add it to operation settings.
+     */
+    private function prepareAttributesAndAddColumn(array|string $column): CrudColumn
+    {
+        $column = $this->makeSureColumnHasNeededAttributes($column);
+        $this->addColumnToOperationSettings($column);
+
+        $column = (new CrudColumn($column['name']))->callRegisteredAttributeMacros();
+
+        return $column;
+    }
 }

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

@@ -562,15 +562,16 @@ public function holdsMultipleInputs(string $fieldName): bool
      * in addition to the existing options:
      * - CRUD::addField(['name' => 'price', 'type' => 'number']);
      * - CRUD::field('price')->type('number');
+     * - CRUD::field(['name' => 'price', 'type' => 'number']);
      *
      * And if the developer uses the CrudField object as Field in their CrudController:
      * - Field::name('price')->type('number');
      *
-     * @param  string  $name  The name of the column in the db, or model attribute.
+     * @param  string|array  $nameOrDefinition  The name of the column in the db, or model attribute.
      * @return CrudField
      */
-    public function field($name)
+    public function field($nameOrDefinition)
     {
-        return new CrudField($name);
+        return new CrudField($nameOrDefinition);
     }
 }

src/app/Library/CrudPanel/Traits/Support/MacroableWithAttributes.php

@@ -29,10 +29,8 @@ public function getMacros()
 
     /**
      * Call the macros registered for the given macroable attributes.
-     *
-     * @return void
      */
-    public function callRegisteredAttributeMacros()
+    public function callRegisteredAttributeMacros(): self
     {
         $macros = $this->getMacros();
         $attributes = $this->getAttributes();
@@ -58,5 +56,7 @@ function ($item) use ($subfieldsWithMacros, $macro) {
                 );
             }
         }
+
+        return $this;
     }
 }

tests/Unit/CrudPanel/CrudPanelColumnsTest.php

@@ -621,4 +621,16 @@ public function testItCanAddAColumnToCrudFromClass()
         CrudColumn::name('test');
         $this->assertCount(1, $this->crudPanel->columns());
     }
+
+    public function testItCanAddAFluentColumnUsingArray()
+    {
+        $this->crudPanel->column($this->oneColumnArray);
+        $this->assertCount(1, $this->crudPanel->columns());
+    }
+
+    public function testItCanAddAFluentColumnUsingArrayWithoutName()
+    {
+        $this->crudPanel->column(['type' => 'text']);
+        $this->assertCount(1, $this->crudPanel->columns());
+    }
 }