Merge pull request #154 from Laravel-Backpack/cmd-new-widget

Artisan command to generate new widgets

Author: tabacitu

src/Console/Commands/WidgetBackpackCommand.php

@@ -0,0 +1,159 @@
+<?php
+
+namespace Backpack\Generators\Console\Commands;
+
+use Backpack\CRUD\ViewNamespaces;
+use Illuminate\Console\GeneratorCommand;
+use Illuminate\Support\Str;
+
+class WidgetBackpackCommand extends GeneratorCommand
+{
+    use \Backpack\CRUD\app\Console\Commands\Traits\PrettyCommandOutput;
+    /**
+     * The console command name.
+     *
+     * @var string
+     */
+    protected $name = 'backpack:widget';
+
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'backpack:widget {name} {--from=}';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Generate a Backpack widget';
+
+    /**
+     * The type of class being generated.
+     *
+     * @var string
+     */
+    protected $type = 'Widget';
+
+    /**
+     * Get the stub file for the generator.
+     *
+     * @return string
+     */
+    protected function getStub()
+    {
+        return __DIR__.'/../stubs/widget.stub';
+    }
+
+    /**
+     * Alias for the fire method.
+     *
+     * In Laravel 5.5 the fire() method has been renamed to handle().
+     * This alias provides support for both Laravel 5.4 and 5.5.
+     */
+    public function handle()
+    {
+        $this->fire();
+    }
+
+    /**
+     * Execute the console command.
+     *
+     * @return bool|null
+     */
+    public function fire()
+    {
+        $name = Str::of($this->getNameInput());
+        $path = $this->getPath($name);
+
+        if ($this->alreadyExists($this->getNameInput())) {
+            $this->error("Error : $this->type $name already existed!");
+
+            return false;
+        }
+
+        $src = null;
+        if ($this->option('from')) {
+            $widget = Str::of($this->option('from'));
+            $arr = ViewNamespaces::getFor('widgets');
+            foreach ($arr as $key => $value) {
+                $viewPath = $value.'.'.$widget;
+                if (view()->exists($viewPath)) {
+                    $src = view($viewPath)->getPath();
+                    break;
+                }
+            }
+            if ($src == null) {
+                $this->error("Error : $this->type $widget does not exist!");
+
+                return false;
+            }
+        }
+
+        $this->infoBlock("Creating {$name->replace('_', ' ')->title()} {$this->type}");
+        $this->progressBlock("Creating view <fg=blue>resources/views/vendor/backpack/base/widgets/{$name->snake('_')}.blade.php</>");
+
+        $this->makeDirectory($path);
+        if ($src != null) {
+            $this->files->copy($src, $path);
+        } else {
+            $this->files->put($path, $this->buildClass($name));
+        }
+
+        $this->closeProgressBlock();
+        $this->newLine();
+        $this->info($this->type.' created successfully.');
+    }
+
+    /**
+     * Determine if the class already exists.
+     *
+     * @param  string  $name
+     * @return bool
+     */
+    protected function alreadyExists($name)
+    {
+        return $this->files->exists($this->getPath($name));
+    }
+
+    /**
+     * Get the destination class path.
+     *
+     * @param  string  $name
+     * @return string
+     */
+    protected function getPath($name)
+    {
+        $file = Str::of($name)->snake('_');
+
+        return resource_path("views/vendor/backpack/base/widgets/$file.blade.php");
+    }
+
+    /**
+     * Build the class with the given name.
+     *
+     * @param  string  $name
+     * @return string
+     */
+    protected function buildClass($name)
+    {
+        $stub = $this->files->get($this->getStub());
+        $stub = str_replace('dummy_widget', $name->snake('_'), $stub);
+        $stub = str_replace('dummyWidget', $name->camel(), $stub);
+        $stub = str_replace('DummyWidget', $name->studly(), $stub);
+
+        return $stub;
+    }
+
+    /**
+     * Get the console command options.
+     *
+     * @return array
+     */
+    protected function getOptions()
+    {
+        return [];
+    }
+}

src/Console/stubs/widget.stub

@@ -0,0 +1,13 @@
+{{-- Include widget wrapper --}}
+@includeWhen(!empty($widget['wrapper']), 'backpack::widgets.inc.wrapper_start')
+
+{{-- Define your widget --}}
+<div class="alert alert-info">
+
+	@if (isset($widget['content']))
+		<p>{!! $widget['content'] !!}</p>
+	@endif
+
+</div>
+
+@includeWhen(!empty($widget['wrapper']), 'backpack::widgets.inc.wrapper_end')

src/GeneratorsServiceProvider.php

@@ -20,6 +20,7 @@
 use Backpack\Generators\Console\Commands\PageControllerBackpackCommand;
 use Backpack\Generators\Console\Commands\RequestBackpackCommand;
 use Backpack\Generators\Console\Commands\ViewBackpackCommand;
+use Backpack\Generators\Console\Commands\WidgetBackpackCommand;
 use Illuminate\Support\ServiceProvider;
 
 class GeneratorsServiceProvider extends ServiceProvider
@@ -43,6 +44,7 @@ class GeneratorsServiceProvider extends ServiceProvider
         PageControllerBackpackCommand::class,
         RequestBackpackCommand::class,
         ViewBackpackCommand::class,
+        WidgetBackpackCommand::class,
     ];
 
     /**