Automatic database migration when enum definition changes #9951

Previously, we had to manually craft a DB migration when we modified the
enum definition in PHP. This is now entirely automated.

This will migrate all pre-existing enums.

src/ConfigProvider.php

@@ -32,6 +32,18 @@ public function __invoke(): array
                     \Laminas\View\Renderer\RendererInterface::class => \Ecodev\Felix\Service\RendererFactory::class,
                 ],
             ],
+            'doctrine' => [
+                'event_manager' => [
+                    'orm_default' => [
+                        'listeners' => [
+                            [
+                                'events' => [\Doctrine\ORM\Tools\ToolEvents::postGenerateSchema],
+                                'listener' => \Ecodev\Felix\Service\EnumAutoMigrator::class,
+                            ],
+                        ],
+                    ],
+                ],
+            ],
         ];
     }
 }

src/Service/EnumAutoMigrator.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ecodev\Felix\Service;
+
+use Doctrine\ORM\Tools\Event\GenerateSchemaEventArgs;
+use Ecodev\Felix\DBAL\Types\EnumType;
+
+/**
+ * When we update our enum values in PHP (native or non-native), a DB migration will be created automatically.
+ */
+class EnumAutoMigrator
+{
+    public function postGenerateSchema(GenerateSchemaEventArgs $eventArgs): void
+    {
+        foreach ($eventArgs->getSchema()->getTables() as $table) {
+            foreach ($table->getColumns() as $column) {
+                $type = $column->getType();
+                if ($type instanceof EnumType) {
+                    $hash = md5($type->getQuotedPossibleValues());
+                    $column->setComment("(FelixEnum:$hash)");
+                }
+            }
+        }
+    }
+}