Merge pull request #191 from Laravel-Backpack/add-form-operation-command

added command to generate a custom form operation

Author: tabacitu

README.md

@@ -18,7 +18,7 @@ Quickly generate Backpack templated Models, Requests, Views and Config files for
 Via Composer
 
 ``` bash
-composer require --dev backpack/generators 
+composer require --dev backpack/generators
 ```
 
 ## Usage
@@ -74,7 +74,7 @@ php artisan backpack:request {Entity_name}
 
 ``` bash
 php artisan backpack:view {Entity_name}
-``` 
+```
 
 - Generate a config file
 
@@ -124,6 +124,18 @@ php artisan backpack:widget {widget_name}
 php artisan backpack:widget {widget_name} --from={original_widget_name}
 ```
 
+- Generate a custom operation
+
+``` bash
+php artisan backpack:crud-operation {OperationName}
+```
+
+- Generate a custom form operation
+
+``` bash
+php artisan backpack:crud-form-operation {OperationName}
+```
+
 ## Change log
 
 Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

src/Console/Commands/CrudFormOperationBackpackCommand.php

@@ -0,0 +1,119 @@
+<?php
+
+namespace Backpack\Generators\Console\Commands;
+
+use Illuminate\Console\GeneratorCommand;
+use Illuminate\Support\Str;
+
+class CrudFormOperationBackpackCommand extends GeneratorCommand
+{
+    /**
+     * The console command name.
+     *
+     * @var string
+     */
+    protected $name = 'backpack:crud-form-operation';
+
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'backpack:crud-form-operation {name}';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Generate an operation trait with a Backpack form';
+
+    /**
+     * The type of class being generated.
+     *
+     * @var string
+     */
+    protected $type = 'Trait';
+
+    /**
+     * Get the destination class path.
+     *
+     * @param  string  $name
+     * @return string
+     */
+    protected function getPath($name)
+    {
+        $name = str_replace($this->laravel->getNamespace(), '', $name);
+
+        return $this->laravel['path'].'/'.str_replace('\\', '/', $name).'Operation.php';
+    }
+
+    /**
+     * Get the stub file for the generator.
+     *
+     * @return string
+     */
+    protected function getStub()
+    {
+        return __DIR__.'/../stubs/crud-form-operation.stub';
+    }
+
+    /**
+     * Get the default namespace for the class.
+     *
+     * @param  string  $rootNamespace
+     * @return string
+     */
+    protected function getDefaultNamespace($rootNamespace)
+    {
+        return $rootNamespace.'\Http\Controllers\Admin\Operations';
+    }
+
+    /**
+     * Replace the table name for the given stub.
+     *
+     * @param  string  $stub
+     * @param  string  $name
+     * @return string
+     */
+    protected function replaceNameStrings(&$stub, $name)
+    {
+        $name = Str::of($name)->afterLast('\\');
+
+        $stub = str_replace('DummyClass', $name->studly(), $stub);
+        $stub = str_replace('dummyClass', $name->lcfirst(), $stub);
+        $stub = str_replace('Dummy Class', $name->snake()->replace('_', ' ')->title(), $stub);
+        $stub = str_replace('dummy-class', $name->snake('-'), $stub);
+        $stub = str_replace('dummy_class', $name->snake(), $stub);
+
+        return $this;
+    }
+
+    /**
+     * Build the class with the given name.
+     *
+     * @param  string  $name
+     * @return string
+     */
+    protected function buildClass($name)
+    {
+        $stub = $this->files->get($this->getStub());
+
+        return $this
+            ->replaceNamespace($stub, $name)
+            ->replaceNameStrings($stub, $name)
+            ->replaceClass($stub, $name);
+    }
+
+    /**
+     * Get the desired class name from the input.
+     *
+     * @return string
+     */
+    protected function getNameInput()
+    {
+        return Str::of($this->argument('name'))
+            ->trim()
+            ->studly();
+    }
+}

src/Console/Commands/CrudModelBackpackCommand.php

@@ -3,7 +3,6 @@
 namespace Backpack\Generators\Console\Commands;
 
 use Backpack\Generators\Services\BackpackCommand;
-use Illuminate\Support\Facades\File;
 use Illuminate\Support\Str;
 
 class CrudModelBackpackCommand extends BackpackCommand

src/Console/stubs/crud-form-operation.stub

@@ -0,0 +1,75 @@
+<?php
+
+namespace DummyNamespace;
+
+use Backpack\CRUD\app\Http\Controllers\Operations\Concerns\HasForm;
+
+trait DummyClassOperation
+{
+    use HasForm;
+
+    /**
+     * Define which routes are needed for this operation.
+     *
+     * @param string $segment    Name of the current entity (singular). Used as first URL segment.
+     * @param string $routeName  Prefix of the route name.
+     * @param string $controller Name of the current CrudController.
+     */
+    protected function setupDummyClassRoutes(string $segment, string $routeName, string $controller): void
+    {
+        $this->formRoutes(
+            operationName: 'dummyClass',
+            routesHaveIdSegment: true,
+            segment: $segment,
+            routeName: $routeName,
+            controller: $controller
+        );
+    }
+
+    /**
+     * Add the default settings, buttons, etc that this operation needs.
+     */
+    protected function setupDummyClassDefaults(): void
+    {
+        $this->formDefaults(
+            operationName: 'dummyClass',
+            // buttonStack: 'line', // alternatives: top, bottom
+            // buttonMeta: [
+            //     'icon' => 'la la-home',
+            //     'label' => 'Dummy Class',
+            //     'wrapper' => [
+            //          'target' => '_blank',
+            //     ],
+            // ],
+        );
+    }
+
+    /**
+     * Method to handle the GET request and display the View with a Backpack form
+     *
+     */
+    public function getDummyClassForm(?int $id = null) : \Illuminate\Contracts\View\View
+    {
+        $this->crud->hasAccessOrFail('dummyClass');
+
+        return $this->formView($id);
+    }
+
+    /**
+    * Method to handle the POST request and perform the operation
+    *
+    * @return array|\Illuminate\Http\RedirectResponse
+    */
+    public function postDummyClassForm(?int $id = null)
+    {
+        $this->crud->hasAccessOrFail('dummyClass');
+
+        return $this->formAction($id, function ($inputs, $entry) {
+            // You logic goes here...
+            // dd('got to ' . __METHOD__, $inputs, $entry);
+
+            // show a success message
+            \Alert::success('Something was done!')->flash();
+        });
+    }
+}

src/GeneratorsServiceProvider.php

@@ -8,6 +8,7 @@
 use Backpack\Generators\Console\Commands\ConfigBackpackCommand;
 use Backpack\Generators\Console\Commands\CrudBackpackCommand;
 use Backpack\Generators\Console\Commands\CrudControllerBackpackCommand;
+use Backpack\Generators\Console\Commands\CrudFormOperationBackpackCommand;
 use Backpack\Generators\Console\Commands\CrudModelBackpackCommand;
 use Backpack\Generators\Console\Commands\CrudOperationBackpackCommand;
 use Backpack\Generators\Console\Commands\CrudRequestBackpackCommand;
@@ -34,6 +35,7 @@ class GeneratorsServiceProvider extends ServiceProvider
         CrudControllerBackpackCommand::class,
         ChartControllerBackpackCommand::class,
         CrudOperationBackpackCommand::class,
+        CrudFormOperationBackpackCommand::class,
         CrudRequestBackpackCommand::class,
         CrudBackpackCommand::class,
         ChartBackpackCommand::class,