Merge pull request #84 from Laravel-Backpack/generating-crud-controllers-with-explicit-fields-and-columns

Generate crud controllers with explicit fields and columns, not setFromDb

Author: tabacitu

src/Console/Commands/CrudControllerBackpackCommand.php

@@ -3,6 +3,7 @@
 namespace Backpack\Generators\Console\Commands;
 
 use Illuminate\Console\GeneratorCommand;
+use Illuminate\Support\Arr;
 use Illuminate\Support\Str;
 
 class CrudControllerBackpackCommand extends GeneratorCommand
@@ -89,6 +90,84 @@ protected function replaceNameStrings(&$stub, $name)
         return $this;
     }
 
+    protected function getAttributes($model)
+    {
+        $attributes = [];
+        $model = new $model;
+
+        // if fillable was defined, use that as the attributes
+        if (! count($model->getFillable())) {
+            $attributes = $model->getFillable();
+        } else {
+            // otherwise, if guarded is used, just pick up the columns straight from the bd table
+            $attributes = \Schema::getColumnListing($model->getTable());
+        }
+
+        return $attributes;
+    }
+
+    /**
+     * Replace the table name for the given stub.
+     *
+     * @param string $stub
+     * @param string $name
+     *
+     * @return string
+     */
+    protected function replaceSetFromDb(&$stub, $name)
+    {
+        $class = str_replace($this->getNamespace($name).'\\', '', $name);
+        $model = 'App\Models\\'.$class;
+
+        if (! class_exists($model)) {
+            return $this;
+        }
+
+        $attributes = $this->getAttributes($model);
+
+        // create an array with the needed code for defining fields
+        $fields = Arr::where($attributes, function ($value, $key) {
+            return ! in_array($value, ['id', 'created_at', 'updated_at', 'deleted_at']);
+        });
+        if (count($fields)) {
+            foreach ($fields as $key => $field) {
+                $fields[$key] = "CRUD::field('".$field."');";
+            }
+        }
+
+        // create an array with the needed code for defining columns
+        $columns = Arr::where($attributes, function ($value, $key) {
+            return ! in_array($value, ['id']);
+        });
+        if (count($columns)) {
+            foreach ($columns as $key => $column) {
+                $columns[$key] = "CRUD::column('".$column."');";
+            }
+        }
+
+        // replace setFromDb with actual fields and columns
+        $stub = str_replace('CRUD::setFromDb(); // fields', implode(PHP_EOL.'        ', $fields), $stub);
+        $stub = str_replace('CRUD::setFromDb(); // columns', implode(PHP_EOL.'        ', $columns), $stub);
+
+        return $this;
+    }
+
+    /**
+     * Replace the class name for the given stub.
+     *
+     * @param  string  $stub
+     * @param  string  $name
+     *
+     * @return string
+     */
+    protected function replaceModel(&$stub, $name)
+    {
+        $class = str_replace($this->getNamespace($name).'\\', '', $name);
+        $stub = str_replace(['DummyClass', '{{ class }}', '{{class}}'], $class, $stub);
+
+        return $this;
+    }
+
     /**
      * Build the class with the given name.
      *
@@ -100,7 +179,12 @@ protected function buildClass($name)
     {
         $stub = $this->files->get($this->getStub());
 
-        return $this->replaceNamespace($stub, $name)->replaceNameStrings($stub, $name)->replaceClass($stub, $name);
+        $this->replaceNamespace($stub, $name)
+                ->replaceNameStrings($stub, $name)
+                ->replaceModel($stub, $name)
+                ->replaceSetFromDb($stub, $name);
+
+        return $stub;
     }
 
     /**

src/Console/stubs/crud-controller.stub

@@ -19,27 +19,60 @@ class DummyClassCrudController extends CrudController
     use \Backpack\CRUD\app\Http\Controllers\Operations\DeleteOperation;
     use \Backpack\CRUD\app\Http\Controllers\Operations\ShowOperation;
 
+    /**
+     * Configure the CrudPanel object. Apply settings to all operations.
+     * 
+     * @return void
+     */
     public function setup()
     {
-        $this->crud->setModel('App\Models\DummyClass');
-        $this->crud->setRoute(config('backpack.base.route_prefix') . '/dummy_class');
-        $this->crud->setEntityNameStrings('dummy_class', 'DummyTable');
+        CRUD::setModel(\App\Models\DummyClass::class);
+        CRUD::setRoute(config('backpack.base.route_prefix') . '/dummy_class');
+        CRUD::setEntityNameStrings('dummy_class', 'DummyTable');
     }
 
+    /**
+     * Define what happens when the List operation is loaded.
+     * 
+     * @see  https://backpackforlaravel.com/docs/crud-operation-list-entries
+     * @return void
+     */
     protected function setupListOperation()
     {
-        // TODO: remove setFromDb() and manually define Columns, maybe Filters
-        $this->crud->setFromDb();
+        CRUD::setFromDb(); // columns
+
+        /**
+         * Columns can be defined using the fluent syntax or array syntax:
+         * - CRUD::column('price')->type('number');
+         * - CRUD::addColumn(['name' => 'price', 'type' => 'number']); 
+         */
     }
 
+    /**
+     * Define what happens when the Create operation is loaded.
+     * 
+     * @see https://backpackforlaravel.com/docs/crud-operation-create
+     * @return void
+     */
     protected function setupCreateOperation()
     {
-        $this->crud->setValidation(DummyClassRequest::class);
+        CRUD::setValidation(DummyClassRequest::class);
+
+        CRUD::setFromDb(); // fields
 
-        // TODO: remove setFromDb() and manually define Fields
-        $this->crud->setFromDb();
+        /**
+         * Fields can be defined using the fluent syntax or array syntax:
+         * - CRUD::field('price')->type('number');
+         * - CRUD::addField(['name' => 'price', 'type' => 'number'])); 
+         */
     }
 
+    /**
+     * Define what happens when the Update operation is loaded.
+     * 
+     * @see https://backpackforlaravel.com/docs/crud-operation-update
+     * @return void
+     */
     protected function setupUpdateOperation()
     {
         $this->setupCreateOperation();