Add a way to register additional migrators

Author: riasvdv

src/Database/Commands/MigrateCommand.php

@@ -5,6 +5,7 @@
 namespace CraftCms\Cms\Database\Commands;
 
 use CraftCms\Cms\Console\CraftCommand;
+use CraftCms\Cms\Database\Events\RegisterMigrators;
 use CraftCms\Cms\Database\Migrator;
 use CraftCms\Cms\Plugin\Plugins;
 use CraftCms\Cms\Support\Str;
@@ -14,6 +15,7 @@
 use Illuminate\Contracts\Console\Isolatable;
 use Illuminate\Foundation\Console\DownCommand;
 use Illuminate\Foundation\Console\UpCommand;
+use Illuminate\Support\Facades\Event;
 use Laravel\Prompts\Concerns\Colors;
 use Laravel\Prompts\Themes\Default\Concerns\DrawsBoxes;
 use Throwable;
@@ -121,10 +123,11 @@ function () use (&$migrationsByTrack, &$plugins) {
         foreach ($migrationsByTrack as $track => $migrations) {
             $n = count($migrations);
 
-            $which = match ($track) {
-                'craft' => 'Craft',
-                'content' => 'content',
-                default => $plugins[substr((string) $track, 7)]->name,
+            $which = match (true) {
+                $track === 'craft' => 'Craft',
+                $track === 'content' => 'content',
+                str_starts_with((string) $track, 'plugin') => $plugins[substr((string) $track, 7)]->name,
+                default => $track,
             };
 
             $this->box(
@@ -196,6 +199,28 @@ private function gatherMigrationsByTrack(array &$migrationsByTrack, array &$plug
                 $migrationsByTrack['content'] = $contentMigrations;
             }
         }
+
+        if (Event::hasListeners(RegisterMigrators::class)) {
+            Event::dispatch($event = new RegisterMigrators([]));
+
+            foreach ($event->migrators as $migrator) {
+                if (! $migrator instanceof Migrator) {
+                    $this->components->warn($migrator::class.' is not an instance of '.Migrator::class);
+
+                    continue;
+                }
+
+                if (! $track = $migrator->getTrack()) {
+                    $this->components->warn('A migrator was registered without a track.');
+
+                    continue;
+                }
+
+                if (! empty($migrations = $migrator->getPendingMigrations())) {
+                    $migrationsByTrack[$track] = $migrations;
+                }
+            }
+        }
     }
 
     /**

src/Database/Events/RegisterMigrators.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CraftCms\Cms\Database\Events;
+
+final class RegisterMigrators
+{
+    public function __construct(
+        /** @var \CraftCms\Cms\Database\Migrator[] */
+        public array $migrators,
+    ) {}
+}

src/Database/Migrator.php

@@ -5,6 +5,7 @@
 namespace CraftCms\Cms\Database;
 
 use CraftCms\Aliases\Aliases;
+use Override;
 
 /**
  * @internal
@@ -33,14 +34,19 @@ public function track(string $track): self
         return $this;
     }
 
+    public function getTrack(): ?string
+    {
+        return $this->repository->getTrack();
+    }
+
     public function setPaths(array $paths): self
     {
         $this->paths = $paths;
 
         return $this;
     }
 
-    #[\Override]
+    #[Override]
     public function run($paths = [], array $options = []): array
     {
         if (empty($paths)) {
@@ -56,13 +62,13 @@ public function run($paths = [], array $options = []): array
         return parent::run($paths, $options);
     }
 
-    #[\Override]
+    #[Override]
     public function runMigration($migration, $method): void
     {
         parent::runMigration($migration, $method);
     }
 
-    #[\Override]
+    #[Override]
     public function resetMigrations(array $migrations, array $paths, $pretend = false): array
     {
         return parent::resetMigrations($migrations, $paths, $pretend);