🧑‍💻 Add DI support to the handle() method of commands, context menus, and services

src/Commands/AbstractCommand.php

@@ -6,12 +6,13 @@
 use Discord\Parts\Interactions\Command\Command;
 use Discord\Parts\User\User;
 use Illuminate\Support\Str;
+use Laracord\Concerns\HasHandler;
 use Laracord\Discord\Concerns\HasModal;
 use Laracord\Laracord;
 
 abstract class AbstractCommand
 {
-    use HasModal;
+    use HasHandler, HasModal;
 
     /**
      * The bot instance.
@@ -185,7 +186,7 @@ public function getUser($user)
             throw new Exception('The user model could not be found.');
         }
 
-        return $this->user = $model::firstOrCreate(['discord_id' => $user->id], [
+        return $model::firstOrCreate(['discord_id' => $user->id], [
             'discord_id' => $user->id,
             'username' => $user->username,
         ]) ?? null;

src/Commands/ApplicationCommand.php

@@ -2,6 +2,7 @@
 
 namespace Laracord\Commands;
 
+use Discord\Parts\Interactions\Interaction;
 use Discord\Parts\Permissions\RolePermission;
 
 abstract class ApplicationCommand extends AbstractCommand
@@ -41,4 +42,16 @@ public function isNsfw(): bool
     {
         return $this->nsfw;
     }
+
+    /**
+     * Handle the denied command.
+     */
+    public function handleDenied(Interaction $interaction): void
+    {
+        $this
+            ->message('You do not have permission to run this command.')
+            ->title('Permission Denied')
+            ->error()
+            ->reply($interaction, ephemeral: true);
+    }
 }

src/Commands/Command.php

@@ -2,6 +2,7 @@
 
 namespace Laracord\Commands;
 
+use Discord\Parts\Channel\Message;
 use Illuminate\Support\Str;
 use Laracord\Commands\Contracts\Command as CommandContract;
 
@@ -37,12 +38,8 @@ abstract class Command extends AbstractCommand implements CommandContract
 
     /**
      * Maybe handle the command.
-     *
-     * @param  \Discord\Parts\Channel\Message  $message
-     * @param  array  $args
-     * @return mixed
      */
-    public function maybeHandle($message, $args)
+    public function maybeHandle(Message $message, array $args): void
     {
         if (! $this->canDirectMessage() && ! $message->guild_id) {
             return;
@@ -53,7 +50,10 @@ public function maybeHandle($message, $args)
         }
 
         if (! $this->isAdminCommand()) {
-            $this->handle($message, $args);
+            $this->resolveHandler([
+                'message' => $message,
+                'args' => $args,
+            ]);
 
             return;
         }
@@ -62,18 +62,12 @@ public function maybeHandle($message, $args)
             return;
         }
 
-        $this->handle($message, $args);
+        $this->resolveHandler([
+            'message' => $message,
+            'args' => $args,
+        ]);
     }
 
-    /**
-     * Handle the command.
-     *
-     * @param  \Discord\Parts\Channel\Message  $message
-     * @param  array  $args
-     * @return mixed
-     */
-    abstract public function handle($message, $args);
-
     /**
      * Retrieve the command cooldown.
      *

src/Commands/ContextMenu.php

@@ -2,10 +2,8 @@
 
 namespace Laracord\Commands;
 
-use Discord\Parts\Channel\Message;
 use Discord\Parts\Interactions\Command\Command as DiscordCommand;
 use Discord\Parts\Interactions\Interaction;
-use Discord\Parts\User\User;
 use Laracord\Commands\Contracts\ContextMenu as ContextMenuContract;
 
 abstract class ContextMenu extends ApplicationCommand implements ContextMenuContract
@@ -33,18 +31,10 @@ public function create(): DiscordCommand
         return new DiscordCommand($this->discord(), $menu->all());
     }
 
-    /**
-     * Handle the context menu interaction.
-     */
-    abstract public function handle(Interaction $interaction, Message|User|null $target): mixed;
-
     /**
      * Maybe handle the context menu interaction.
-     *
-     * @param  \Discord\Parts\Interactions\Interaction  $interaction
-     * @return mixed
      */
-    public function maybeHandle($interaction)
+    public function maybeHandle(Interaction $interaction): void
     {
         $target = match ($this->getType()) {
             DiscordCommand::USER => $interaction->data->resolved->users?->first(),
@@ -53,23 +43,24 @@ public function maybeHandle($interaction)
         };
 
         if (! $this->isAdminCommand()) {
-            $this->handle($interaction, $target);
+            $this->resolveHandler([
+                'interaction' => $interaction,
+                'target' => $target,
+            ]);
 
             return;
         }
 
         if ($this->isAdminCommand() && ! $this->isAdmin($interaction->member->user)) {
-            return $interaction->respondWithMessage(
-                $this
-                    ->message('You do not have permission to run this command.')
-                    ->title('Permission Denied')
-                    ->error()
-                    ->build(),
-                ephemeral: true
-            );
+            $this->handleDenied($interaction);
+
+            return;
         }
 
-        $this->handle($interaction, $target);
+        $this->resolveHandler([
+            'interaction' => $interaction,
+            'target' => $target,
+        ]);
     }
 
     /**

src/Commands/Contracts/Command.php

@@ -2,12 +2,7 @@
 
 namespace Laracord\Commands\Contracts;
 
-use Discord\Parts\Channel\Message;
-
 interface Command
 {
-    /**
-     * Handle the command.
-     */
-    public function handle(Message $message, array $args);
+    //
 }

src/Commands/Contracts/ContextMenu.php

@@ -2,14 +2,7 @@
 
 namespace Laracord\Commands\Contracts;
 
-use Discord\Parts\Channel\Message;
-use Discord\Parts\Interactions\Interaction;
-use Discord\Parts\User\User;
-
 interface ContextMenu
 {
-    /**
-     * Handle the context menu interaction.
-     */
-    public function handle(Interaction $interaction, Message|User|null $target): mixed;
+    //
 }

src/Commands/Contracts/SlashCommand.php

@@ -2,12 +2,7 @@
 
 namespace Laracord\Commands\Contracts;
 
-use Discord\Parts\Interactions\Interaction;
-
 interface SlashCommand
 {
-    /**
-     * Handle the slash command.
-     */
-    public function handle(Interaction $interaction);
+    //
 }

src/Commands/SlashCommand.php

@@ -65,46 +65,34 @@ public function create(): DiscordCommand
         return new DiscordCommand($this->discord(), $command);
     }
 
-    /**
-     * Handle the slash command.
-     *
-     * @param  \Discord\Parts\Interactions\Interaction  $interaction
-     * @return mixed
-     */
-    abstract public function handle($interaction);
-
     /**
      * Maybe handle the slash command.
-     *
-     * @param  \Discord\Parts\Interactions\Interaction  $interaction
-     * @return mixed
      */
-    public function maybeHandle($interaction)
+    public function maybeHandle(Interaction $interaction): void
     {
         if (! $this->isAdminCommand()) {
             $this->parseOptions($interaction);
 
-            $this->handle($interaction);
+            $this->resolveHandler([
+                'interaction' => $interaction,
+            ]);
 
             $this->clearOptions();
 
             return;
         }
 
         if ($this->isAdminCommand() && ! $this->isAdmin($interaction->member->user)) {
-            return $interaction->respondWithMessage(
-                $this
-                    ->message('You do not have permission to run this command.')
-                    ->title('Permission Denied')
-                    ->error()
-                    ->build(),
-                ephemeral: true
-            );
+            $this->handleDenied($interaction);
+
+            return;
         }
 
         $this->parseOptions($interaction);
 
-        $this->handle($interaction);
+        $this->resolveHandler([
+            'interaction' => $interaction,
+        ]);
 
         $this->clearOptions();
     }

src/Concerns/HasHandler.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Laracord\Concerns;
+
+use Exception;
+
+trait HasHandler
+{
+    /**
+     * Resolve the handler using the container.
+     */
+    protected function resolveHandler(array $parameters = []): mixed
+    {
+        if (! method_exists($this, 'handle')) {
+            $class = get_class($this);
+
+            throw new Exception("{$class} must implement a handle method.");
+        }
+
+        return $this->bot->app->call([$this, 'handle'], $parameters);
+    }
+}

src/Console/Commands/stubs/command.stub

@@ -2,6 +2,7 @@
 
 namespace {{ namespace }};
 
+use Discord\Parts\Channel\Message;
 use Discord\Parts\Interactions\Interaction;
 use Laracord\Commands\Command;
 
@@ -37,19 +38,15 @@ class {{ class }} extends Command
 
     /**
      * Handle the command.
-     *
-     * @param  \Discord\Parts\Channel\Message  $message
-     * @param  array  $args
-     * @return void
      */
-    public function handle($message, $args)
+    public function handle(Message $message, array $args): void
     {
         return $this
             ->message()
             ->title('{{ title }}')
             ->content('Hello world!')
             ->button('👋', route: 'wave')
-            ->send($message);
+            ->reply($message);
     }
 
     /**

src/Console/Commands/stubs/context-menu.stub

@@ -38,16 +38,14 @@ class {{ class }} extends ContextMenu
     /**
      * Handle the context menu interaction.
      */
-    public function handle(Interaction $interaction, Message|User|null $target): mixed
+    public function handle(Interaction $interaction, Message|User|null $target): void
     {
-        $interaction->respondWithMessage(
-            $this
-              ->message()
-              ->title('{{ title }}')
-              ->content('Hello world!')
-              ->button('👋', route: 'wave')
-              ->build()
-        );
+        $this
+            ->message()
+            ->title('{{ title }}')
+            ->content('Hello world!')
+            ->button('👋', route: 'wave')
+            ->reply($interaction);
     }
 
     /**

src/Console/Commands/stubs/event.stub

@@ -17,7 +17,7 @@ class {{ class }} extends Event
     /**
      * Handle the event.
      */
-    public function handle({{ attributes }})
+    public function handle({{ attributes }}): void
     {
         $this->console()->log('The {{ eventName }} event has fired!');
     }

src/Console/Commands/stubs/service.stub

@@ -11,10 +11,15 @@ class {{ class }} extends Service
      */
     protected int $interval = 5;
 
+    /**
+     * Determine if the service handler should execute during boot.
+     */
+    protected bool $eager = false;
+
     /**
      * Handle the service.
      */
-    public function handle(): mixed
+    public function handle(): void
     {
         $this->console()->log('Hello world.');
     }