Support custom commands via logical theme system

ssddanbrown · ssddanbrown · commit cdaad2f40ec9 · 2021-11-22T18:30:58.000Z
Added initial work to support registering commands through the logical
theme system. Includes docs changes and example.

Not yet covered via testing.
diff --git a/app/Console/Kernel.php b/app/Console/Kernel.php
@@ -2,8 +2,11 @@
 
 namespace BookStack\Console;
 
+use BookStack\Facades\Theme;
+use BookStack\Theming\ThemeService;
 use Illuminate\Console\Scheduling\Schedule;
 use Illuminate\Foundation\Console\Kernel as ConsoleKernel;
+use Symfony\Component\Console\Command\Command;
 
 class Kernel extends ConsoleKernel
 {
@@ -35,6 +38,13 @@ protected function schedule(Schedule $schedule)
      */
     protected function commands()
     {
+        // Default framework command loading from 'Commands' directory
         $this->load(__DIR__ . '/Commands');
+
+        // Load any user commands that have been registered via the theme system.
+        $themeService = $this->app->make(ThemeService::class);
+        foreach ($themeService->getRegisteredCommands() as $command) {
+            $this->registerCommand($command);
+        }
     }
 }
diff --git a/app/Theming/ThemeService.php b/app/Theming/ThemeService.php
@@ -3,11 +3,17 @@
 namespace BookStack\Theming;
 
 use BookStack\Auth\Access\SocialAuthService;
+use Symfony\Component\Console\Command\Command;
 
 class ThemeService
 {
     protected $listeners = [];
 
+    /**
+     * @var Command[]
+     */
+    protected $commands = [];
+
     /**
      * Listen to a given custom theme event,
      * setting up the action to be ran when the event occurs.
@@ -43,6 +49,22 @@ public function dispatch(string $event, ...$args)
         return null;
     }
 
+    /**
+     * Register a new custom artisan command to be available.
+     */
+    public function registerCommand(Command $command)
+    {
+        $this->commands[] = $command;
+    }
+
+    /**
+     * Get the custom commands that have been registered.
+     */
+    public function getRegisteredCommands(): array
+    {
+        return $this->commands;
+    }
+
     /**
      * Read any actions from the set theme path if the 'functions.php' file exists.
      */
diff --git a/dev/docs/logical-theme-system.md b/dev/docs/logical-theme-system.md
@@ -77,6 +77,32 @@ Theme::listen(ThemeEvents::APP_BOOT, function($app) {
 });
 ```
 
+## Custom Commands
+
+The logical theme system supports adding custom [artisan commands](https://laravel.com/docs/8.x/artisan) to BookStack. These can be registered in your `functions.php` file by calling `Theme::registerCommand($command)`, where `$command` is an instance of `\Symfony\Component\Console\Command\Command`. 
+
+Below is an example of registering a command that could then be ran using `php artisan bookstack:meow` on the command line.
+
+```php
+<?php
+
+use BookStack\Facades\Theme;
+use Illuminate\Console\Command;
+
+class MeowCommand extends Command
+{
+    protected $signature = 'bookstack:meow';
+    protected $description = 'Say meow on the command line';
+
+    public function handle()
+    {
+        $this->line('Meow there!');
+    }
+}
+
+Theme::registerCommand(new MeowCommand);
+```
+
 ## Custom Socialite Service Example
 
 The below shows an example of adding a custom reddit socialite service to BookStack. 

Original file line number	Diff line number	Diff line change
`@@ -2,8 +2,11 @@`
`2`	`2`
`3`	`3`	`namespace BookStack\Console;`
`4`	`4`
	`5`	`+use BookStack\Facades\Theme;`
	`6`	`+use BookStack\Theming\ThemeService;`
`5`	`7`	`use Illuminate\Console\Scheduling\Schedule;`
`6`	`8`	`use Illuminate\Foundation\Console\Kernel as ConsoleKernel;`
	`9`	`+use Symfony\Component\Console\Command\Command;`
`7`	`10`
`8`	`11`	`class Kernel extends ConsoleKernel`
`9`	`12`	`{`
`@@ -35,6 +38,13 @@ protected function schedule(Schedule $schedule)`
`35`	`38`	`*/`
`36`	`39`	`protected function commands()`
`37`	`40`	`{`
	`41`	`+ // Default framework command loading from 'Commands' directory`
`38`	`42`	`$this->load(__DIR__ . '/Commands');`
	`43`	`+`
	`44`	`+ // Load any user commands that have been registered via the theme system.`
	`45`	`+ $themeService = $this->app->make(ThemeService::class);`
	`46`	`+ foreach ($themeService->getRegisteredCommands() as $command) {`
	`47`	`+ $this->registerCommand($command);`
	`48`	`+ }`
`39`	`49`	`}`
`40`	`50`	`}`