Allow class based commands to be registered with the facade (#640)

Author: srtfisher

phpstan.neon

@@ -18,8 +18,6 @@ parameters:
 			identifier: require.fileNotFound
 		-
 			identifier: requireOnce.fileNotFound
-		-
-			identifier: unset.possiblyHookedProperty
 		-
 			identifier: function.alreadyNarrowedType
 			paths:

src/mantle/console/class-application.php

@@ -151,7 +151,7 @@ public function resolve( Symfony_Command|Command|string $command ): static {
 	/**
 	 * Resolve an array of commands through the console application.
 	 *
-	 * @param array|string|Symfony_Command|Command $commands
+	 * @param array|class-string<Command|Symfony_Command>|Symfony_Command|Command $commands
 	 */
 	public function resolve_commands( $commands ): static {
 		$commands = Arr::wrap( $commands );

src/mantle/contracts/console/interface-kernel.php

@@ -7,6 +7,8 @@
 
 namespace Mantle\Contracts\Console;
 
+use Closure;
+use Mantle\Console\Command;
 use Symfony\Component\Console\Tester\CommandTester;
 
 /**
@@ -45,6 +47,21 @@ public function test( string $command, array $parameters = [] ): CommandTester;
 	 */
 	public function register_commands();
 
+	/**
+	 * Register a new command with the console application.
+	 *
+	 * @param Command|class-string<Command> $command Command instance or class name.
+	 */
+	public function register( Command|string $command );
+
+	/**
+	 * Register a new Closure based command with a signature.
+	 *
+	 * @param string  $signature Command signature.
+	 * @param Closure $callback Command callback.
+	 */
+	public function command( string $signature, Closure $callback );
+
 	/**
 	 * Log to the console.
 	 *

src/mantle/facade/class-console.php

@@ -18,6 +18,7 @@
  * @method static int call(string $command, array $parameters = [], mixed $output_buffer = null)
  * @method static \Symfony\Component\Console\Tester\CommandTester test(string $command, array $parameters = [])
  * @method static \Mantle\Console\Closure_Command command(string $signature, Closure $callback)
+ * @method static void register(string|\Mantle\Console\Command $command)
  * @method static void bootstrap()
  * @method static \Mantle\Contracts\Console\Application get_console_application()
  * @method static void set_console_application(\Mantle\Contracts\Console\Application $app)

src/mantle/framework/console/class-kernel.php

@@ -30,17 +30,10 @@
 class Kernel implements \Mantle\Contracts\Console\Kernel {
 	use Loads_Classes;
 
-	/**
-	 * The application implementation.
-	 *
-	 * @var Application|null
-	 */
-	protected $app;
-
 	/**
 	 * The bootstrap classes for the application.
 	 *
-	 * @var array
+	 * @var array<class-string>
 	 */
 	protected $bootstrappers = [
 		\Mantle\Framework\Bootstrap\Load_Configuration::class,
@@ -53,7 +46,7 @@ class Kernel implements \Mantle\Contracts\Console\Kernel {
 	/**
 	 * The commands provided by the application.
 	 *
-	 * @var array
+	 * @var array<class-string<\Mantle\Console\Command>|Command>
 	 */
 	protected $commands = [];
 
@@ -77,9 +70,7 @@ class Kernel implements \Mantle\Contracts\Console\Kernel {
 	 *
 	 * @param Application $app Application instance.
 	 */
-	public function __construct( Application $app ) {
-		$this->app = $app;
-
+	public function __construct( protected Application $app ) {
 		$this->ensure_environment_is_set();
 	}
 
@@ -127,6 +118,23 @@ public function test( string $command, array $parameters = [] ): CommandTester {
 		return $this->get_console_application()->test( $command, $parameters );
 	}
 
+	/**
+	 * Register a new command with the console application.
+	 *
+	 * @throws \InvalidArgumentException Thrown if the command is not a valid command.
+	 *
+	 * @param Command|class-string<Command> $command Command instance or class name.
+	 */
+	public function register( Command|string $command ): void {
+		if ( ! class_exists( $command ) || ! is_subclass_of( $command, Command::class ) ) { // @phpstan-ignore-line function.alreadyNarrowedType
+			throw new \InvalidArgumentException( "Command [{$command}] is not a valid command." );
+		}
+
+		Console_Application::starting(
+			fn ( Console_Application $app ) => $app->resolve( $command )
+		);
+	}
+
 	/**
 	 * Register a new Closure based command with a signature.
 	 *

src/mantle/framework/resources/application-structure/console/class-kernel.php

@@ -7,6 +7,7 @@
 
 namespace App\Console;
 
+use Mantle\Console\Command;
 use Mantle\Facade\Console;
 use Mantle\Framework\Console\Kernel as Console_Kernel;
 
@@ -20,7 +21,7 @@ class Kernel extends Console_Kernel {
 	/**
 	 * The commands provided by the application.
 	 *
-	 * @var array
+	 * @var array<class-string<Command>|Command>
 	 */
 	protected $commands = [
 		// ...

tests/Testing/Concerns/InteractsWithConsoleTest.php

@@ -1,6 +1,7 @@
 <?php
 namespace Mantle\Tests\Concerns;
 
+use Mantle\Console\Command;
 use Mantle\Facade\Console;
 use Mantle\Testing\Framework_Test_Case;
 use PHPUnit\Framework\Attributes\Group;
@@ -49,6 +50,22 @@ public function test_closure_command_input() {
 			->assertOk();
 	}
 
+	public function test_class_command(): void {
+		$command = new class() extends Command {
+			protected $signature = 'test:class-command';
+
+			public function __invoke() {
+				$this->info( 'Hello World' );
+			}
+		};
+
+		Console::register( $command::class );
+
+		$this->command( 'wp mantle test:class-command' )
+			->assertOutputContains( 'Hello World' )
+			->assertOk();
+	}
+
 	public function test_wp_cli_command() {
 		$this->markTestSkipped( 'WP-CLI commands are not supported yet.' );
 	}