symfony · nicolas-grekas · Mar 6, 2023 · Mar 5, 2023
diff --git a/UPGRADE-6.3.md b/UPGRADE-6.3.md
@@ -13,6 +13,13 @@ DependencyInjection
  * Deprecate `PhpDumper` options `inline_factories_parameter` and `inline_class_loader_parameter`, use `inline_factories` and `inline_class_loader` instead
  * Deprecate undefined and numeric keys with `service_locator` config, use string aliases instead
 
+DoctrineBridge
+--------------
+
+ * Deprecate `DoctrineDbalCacheAdapterSchemaSubscriber` in favor of `DoctrineDbalCacheAdapterSchemaListener`
+ * Deprecate `MessengerTransportDoctrineSchemaSubscriber` in favor of `MessengerTransportDoctrineSchemaListener`
+ * Deprecate `RememberMeTokenProviderDoctrineSchemaSubscriber` in favor of `RememberMeTokenProviderDoctrineSchemaListener`
+
 FrameworkBundle
 ---------------
 

diff --git a/src/Symfony/Bridge/Doctrine/CHANGELOG.md b/src/Symfony/Bridge/Doctrine/CHANGELOG.md
@@ -1,6 +1,14 @@
 CHANGELOG
 =========
 
+6.3
+---
+
+ * Add `AbstractSchemaListener`, `LockStoreSchemaListener` and `PdoSessionHandlerSchemaListener`
+ * Deprecate `DoctrineDbalCacheAdapterSchemaSubscriber` in favor of `DoctrineDbalCacheAdapterSchemaListener`
+ * Deprecate `MessengerTransportDoctrineSchemaSubscriber` in favor of `MessengerTransportDoctrineSchemaListener`
+ * Deprecate `RememberMeTokenProviderDoctrineSchemaSubscriber` in favor of `RememberMeTokenProviderDoctrineSchemaListener`
+
 6.2
 ---
 

diff --git a/...hemaListener/AbstractSchemaSubscriber.php → ...SchemaListener/AbstractSchemaListener.php b/...hemaListener/AbstractSchemaSubscriber.php → ...SchemaListener/AbstractSchemaListener.php
@@ -11,27 +11,14 @@
 
 namespace Symfony\Bridge\Doctrine\SchemaListener;
 
-use Doctrine\Common\EventSubscriber;
 use Doctrine\DBAL\Connection;
 use Doctrine\DBAL\Exception\TableNotFoundException;
 use Doctrine\ORM\Tools\Event\GenerateSchemaEventArgs;
-use Doctrine\ORM\Tools\ToolEvents;
 
-abstract class AbstractSchemaSubscriber implements EventSubscriber
+abstract class AbstractSchemaListener
 {
     abstract public function postGenerateSchema(GenerateSchemaEventArgs $event): void;
 
-    public function getSubscribedEvents(): array
-    {
-        if (!class_exists(ToolEvents::class)) {
-            return [];
-        }
-
-        return [
-            ToolEvents::postGenerateSchema,
-        ];
-    }
-
     protected function getIsSameDatabaseChecker(Connection $connection): \Closure
     {
         return static function (\Closure $exec) use ($connection): bool {

diff --git a/src/Symfony/Bridge/Doctrine/SchemaListener/DoctrineDbalCacheAdapterSchemaListener.php b/src/Symfony/Bridge/Doctrine/SchemaListener/DoctrineDbalCacheAdapterSchemaListener.php
@@ -0,0 +1,38 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bridge\Doctrine\SchemaListener;
+
+use Doctrine\ORM\Tools\Event\GenerateSchemaEventArgs;
+use Symfony\Component\Cache\Adapter\DoctrineDbalAdapter;
+
+/**
+ * Automatically adds the cache table needed for the DoctrineDbalAdapter of
+ * the Cache component.
+ */
+class DoctrineDbalCacheAdapterSchemaListener extends AbstractSchemaListener
+{
+    /**
+     * @param iterable<mixed, DoctrineDbalAdapter> $dbalAdapters
+     */
+    public function __construct(private iterable $dbalAdapters)
+    {
+    }
+
+    public function postGenerateSchema(GenerateSchemaEventArgs $event): void
+    {
+        $connection = $event->getEntityManager()->getConnection();
+
+        foreach ($this->dbalAdapters as $dbalAdapter) {
+            $dbalAdapter->configureSchema($event->getSchema(), $connection, $this->getIsSameDatabaseChecker($connection));
+        }
+    }
+}
diff --git a/src/Symfony/Bridge/Doctrine/SchemaListener/DoctrineDbalCacheAdapterSchemaSubscriber.php b/src/Symfony/Bridge/Doctrine/SchemaListener/DoctrineDbalCacheAdapterSchemaSubscriber.php
@@ -11,33 +11,30 @@
 
 namespace Symfony\Bridge\Doctrine\SchemaListener;
 
-use Doctrine\ORM\Tools\Event\GenerateSchemaEventArgs;
+use Doctrine\Common\EventSubscriber;
+use Doctrine\ORM\Tools\ToolEvents;
 use Symfony\Component\Cache\Adapter\DoctrineDbalAdapter;
 
+trigger_deprecation('symfony/doctrine-bridge', '6.3', 'The "%s" class is deprecated. Use "%s" instead.', DoctrineDbalCacheAdapterSchemaSubscriber::class, DoctrineDbalCacheAdapterSchemaListener::class);
+
 /**
  * Automatically adds the cache table needed for the DoctrineDbalAdapter of
  * the Cache component.
  *
  * @author Ryan Weaver <ryan@symfonycasts.com>
+ *
+ * @deprecated since Symfony 6.3, use {@link DoctrineDbalCacheAdapterSchemaListener} instead
  */
-final class DoctrineDbalCacheAdapterSchemaSubscriber extends AbstractSchemaSubscriber
+final class DoctrineDbalCacheAdapterSchemaSubscriber extends DoctrineDbalCacheAdapterSchemaListener implements EventSubscriber
 {
-    private $dbalAdapters;
-
-    /**
-     * @param iterable<mixed, DoctrineDbalAdapter> $dbalAdapters
-     */
-    public function __construct(iterable $dbalAdapters)
-    {
-        $this->dbalAdapters = $dbalAdapters;
-    }
-
-    public function postGenerateSchema(GenerateSchemaEventArgs $event): void
+    public function getSubscribedEvents(): array
     {
-        $connection = $event->getEntityManager()->getConnection();
-
-        foreach ($this->dbalAdapters as $dbalAdapter) {
-            $dbalAdapter->configureSchema($event->getSchema(), $connection, $this->getIsSameDatabaseChecker($connection));
+        if (!class_exists(ToolEvents::class)) {
+            return [];
         }
+
+        return [
+            ToolEvents::postGenerateSchema,
+        ];
     }
 }
diff --git a/...emaListener/LockStoreSchemaSubscriber.php → ...chemaListener/LockStoreSchemaListener.php b/...emaListener/LockStoreSchemaSubscriber.php → ...chemaListener/LockStoreSchemaListener.php
@@ -15,7 +15,7 @@
 use Symfony\Component\Lock\PersistingStoreInterface;
 use Symfony\Component\Lock\Store\DoctrineDbalStore;
 
-final class LockStoreSchemaSubscriber extends AbstractSchemaSubscriber
+final class LockStoreSchemaListener extends AbstractSchemaListener
 {
     /**
      * @param iterable<mixed, PersistingStoreInterface> $stores

diff --git a/src/Symfony/Bridge/Doctrine/SchemaListener/MessengerTransportDoctrineSchemaListener.php b/src/Symfony/Bridge/Doctrine/SchemaListener/MessengerTransportDoctrineSchemaListener.php
@@ -0,0 +1,82 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bridge\Doctrine\SchemaListener;
+
+use Doctrine\DBAL\Event\SchemaCreateTableEventArgs;
+use Doctrine\ORM\Tools\Event\GenerateSchemaEventArgs;
+use Symfony\Component\Messenger\Bridge\Doctrine\Transport\DoctrineTransport;
+use Symfony\Component\Messenger\Transport\TransportInterface;
+
+/**
+ * Automatically adds any required database tables to the Doctrine Schema.
+ */
+class MessengerTransportDoctrineSchemaListener extends AbstractSchemaListener
+{
+    private const PROCESSING_TABLE_FLAG = self::class.':processing';
+
+    /**
+     * @param iterable<mixed, TransportInterface> $transports
+     */
+    public function __construct(private iterable $transports)
+    {
+    }
+
+    public function postGenerateSchema(GenerateSchemaEventArgs $event): void
+    {
+        $connection = $event->getEntityManager()->getConnection();
+
+        foreach ($this->transports as $transport) {
+            if (!$transport instanceof DoctrineTransport) {
+                continue;
+            }
+
+            $transport->configureSchema($event->getSchema(), $connection, $this->getIsSameDatabaseChecker($connection));
+        }
+    }
+
+    public function onSchemaCreateTable(SchemaCreateTableEventArgs $event): void
+    {
+        $table = $event->getTable();
+
+        // if this method triggers a nested create table below, allow Doctrine to work like normal
+        if ($table->hasOption(self::PROCESSING_TABLE_FLAG)) {
+            return;
+        }
+
+        foreach ($this->transports as $transport) {
+            if (!$transport instanceof DoctrineTransport) {
+                continue;
+            }
+
+            if (!$extraSql = $transport->getExtraSetupSqlForTable($table)) {
+                continue;
+            }
+
+            // avoid this same listener from creating a loop on this table
+            $table->addOption(self::PROCESSING_TABLE_FLAG, true);
+            $createTableSql = $event->getPlatform()->getCreateTableSQL($table);
+
+            /*
+             * Add all the SQL needed to create the table and tell Doctrine
+             * to "preventDefault" so that only our SQL is used. This is
+             * the only way to inject some extra SQL.
+             */
+            $event->addSql($createTableSql);
+            foreach ($extraSql as $sql) {
+                $event->addSql($sql);
+            }
+            $event->preventDefault();
+
+            return;
+        }
+    }
+}
diff --git a/src/Symfony/Bridge/Doctrine/SchemaListener/MessengerTransportDoctrineSchemaSubscriber.php b/src/Symfony/Bridge/Doctrine/SchemaListener/MessengerTransportDoctrineSchemaSubscriber.php
@@ -11,84 +11,28 @@
 
 namespace Symfony\Bridge\Doctrine\SchemaListener;
 
-use Doctrine\DBAL\Event\SchemaCreateTableEventArgs;
+use Doctrine\Common\EventSubscriber;
 use Doctrine\DBAL\Events;
-use Doctrine\ORM\Tools\Event\GenerateSchemaEventArgs;
-use Symfony\Component\Messenger\Bridge\Doctrine\Transport\DoctrineTransport;
-use Symfony\Component\Messenger\Transport\TransportInterface;
+use Doctrine\ORM\Tools\ToolEvents;
+
+trigger_deprecation('symfony/doctrine-bridge', '6.3', 'The "%s" class is deprecated. Use "%s" instead.', MessengerTransportDoctrineSchemaSubscriber::class, MessengerTransportDoctrineSchemaListener::class);
 
 /**
  * Automatically adds any required database tables to the Doctrine Schema.
  *
  * @author Ryan Weaver <ryan@symfonycasts.com>
+ *
+ * @deprecated since Symfony 6.3, use {@link MessengerTransportDoctrineSchemaListener} instead
  */
-final class MessengerTransportDoctrineSchemaSubscriber extends AbstractSchemaSubscriber
+final class MessengerTransportDoctrineSchemaSubscriber extends MessengerTransportDoctrineSchemaListener implements EventSubscriber
 {
-    private const PROCESSING_TABLE_FLAG = self::class.':processing';
-
-    private iterable $transports;
-
-    /**
-     * @param iterable<mixed, TransportInterface> $transports
-     */
-    public function __construct(iterable $transports)
-    {
-        $this->transports = $transports;
-    }
-
-    public function postGenerateSchema(GenerateSchemaEventArgs $event): void
-    {
-        $connection = $event->getEntityManager()->getConnection();
-
-        foreach ($this->transports as $transport) {
-            if (!$transport instanceof DoctrineTransport) {
-                continue;
-            }
-
-            $transport->configureSchema($event->getSchema(), $connection, $this->getIsSameDatabaseChecker($connection));
-        }
-    }
-
-    public function onSchemaCreateTable(SchemaCreateTableEventArgs $event): void
+    public function getSubscribedEvents(): array
     {
-        $table = $event->getTable();
-
-        // if this method triggers a nested create table below, allow Doctrine to work like normal
-        if ($table->hasOption(self::PROCESSING_TABLE_FLAG)) {
-            return;
-        }
-
-        foreach ($this->transports as $transport) {
-            if (!$transport instanceof DoctrineTransport) {
-                continue;
-            }
-
-            if (!$extraSql = $transport->getExtraSetupSqlForTable($table)) {
-                continue;
-            }
+        $subscribedEvents = [];
 
-            // avoid this same listener from creating a loop on this table
-            $table->addOption(self::PROCESSING_TABLE_FLAG, true);
-            $createTableSql = $event->getPlatform()->getCreateTableSQL($table);
-
-            /*
-             * Add all the SQL needed to create the table and tell Doctrine
-             * to "preventDefault" so that only our SQL is used. This is
-             * the only way to inject some extra SQL.
-             */
-            $event->addSql($createTableSql);
-            foreach ($extraSql as $sql) {
-                $event->addSql($sql);
-            }
-            $event->preventDefault();
-
-            return;
+        if (class_exists(ToolEvents::class)) {
+            $subscribedEvents[] = ToolEvents::postGenerateSchema;
         }
-    }
-
-    public function getSubscribedEvents(): array
-    {
-        $subscribedEvents = parent::getSubscribedEvents();
 
         if (class_exists(Events::class)) {
             $subscribedEvents[] = Events::onSchemaCreateTable;

diff --git a/...ner/PdoSessionHandlerSchemaSubscriber.php → ...tener/PdoSessionHandlerSchemaListener.php b/...ner/PdoSessionHandlerSchemaSubscriber.php → ...tener/PdoSessionHandlerSchemaListener.php
@@ -14,7 +14,7 @@
 use Doctrine\ORM\Tools\Event\GenerateSchemaEventArgs;
 use Symfony\Component\HttpFoundation\Session\Storage\Handler\PdoSessionHandler;
 
-final class PdoSessionHandlerSchemaSubscriber extends AbstractSchemaSubscriber
+final class PdoSessionHandlerSchemaListener extends AbstractSchemaListener
 {
     private PdoSessionHandler $sessionHandler;
 
@@ -25,13 +25,12 @@ public function __construct(\SessionHandlerInterface $sessionHandler)
         }
     }
 
-    public function getSubscribedEvents(): array
-    {
-        return isset($this->sessionHandler) ? parent::getSubscribedEvents() : [];
-    }
-
     public function postGenerateSchema(GenerateSchemaEventArgs $event): void
     {
+        if (!isset($this->sessionHandler)) {
+            return;
+        }
+
         $connection = $event->getEntityManager()->getConnection();
 
         $this->sessionHandler->configureSchema($event->getSchema(), $this->getIsSameDatabaseChecker($connection));