Replace PdoCacheAdapterDoctrineSchemaSubscriber with DoctrineDbalCacheAdapterSchemaSubscriber

GromNaN · GromNaN · commit ec9d4be043e3 · 2021-10-07T17:39:11.000+02:00
diff --git a/src/Symfony/Bridge/Doctrine/CHANGELOG.md b/src/Symfony/Bridge/Doctrine/CHANGELOG.md
@@ -5,6 +5,7 @@ CHANGELOG
 ---
 
  * Add `DoctrineOpenTransactionLoggerMiddleware` to log when a transaction has been left open
+ * Deprecate `PdoCacheAdapterDoctrineSchemaSubscriber` and add `DoctrineDbalCacheAdapterSchemaSubscriber` instead
 
 5.3
 ---
diff --git a/src/Symfony/Bridge/Doctrine/SchemaListener/DoctrineDbalCacheAdapterSchemaSubscriber.php b/src/Symfony/Bridge/Doctrine/SchemaListener/DoctrineDbalCacheAdapterSchemaSubscriber.php
@@ -0,0 +1,54 @@
+<?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\Common\EventSubscriber;
+use Doctrine\ORM\Tools\Event\GenerateSchemaEventArgs;
+use Doctrine\ORM\Tools\ToolEvents;
+use Symfony\Component\Cache\Adapter\DoctrineDbalAdapter;
+
+/**
+ * Automatically adds the cache table needed for the DoctrineDbalAdapter.
+ *
+ * @author Ryan Weaver <ryan@symfonycasts.com>
+ */
+final class DoctrineDbalCacheAdapterSchemaSubscriber implements EventSubscriber
+{
+    private $dbalAdapters;
+
+    /**
+     * @param iterable|DoctrineDbalAdapter[] $dbalAdapters
+     */
+    public function __construct(iterable $dbalAdapters)
+    {
+        $this->dbalAdapters = $dbalAdapters;
+    }
+
+    public function postGenerateSchema(GenerateSchemaEventArgs $event): void
+    {
+        $dbalConnection = $event->getEntityManager()->getConnection();
+        foreach ($this->dbalAdapters as $dbalAdapter) {
+            $dbalAdapter->configureSchema($event->getSchema(), $dbalConnection);
+        }
+    }
+
+    public function getSubscribedEvents(): array
+    {
+        if (!class_exists(ToolEvents::class)) {
+            return [];
+        }
+
+        return [
+            ToolEvents::postGenerateSchema,
+        ];
+    }
+}
diff --git a/src/Symfony/Bridge/Doctrine/SchemaListener/PdoCacheAdapterDoctrineSchemaSubscriber.php b/src/Symfony/Bridge/Doctrine/SchemaListener/PdoCacheAdapterDoctrineSchemaSubscriber.php
@@ -16,10 +16,13 @@
 use Doctrine\ORM\Tools\ToolEvents;
 use Symfony\Component\Cache\Adapter\PdoAdapter;
 
+trigger_deprecation('symfony/doctrine-bridge', '5.4', 'The "%s" class is deprecated, use "%s" instead.', PdoCacheAdapterDoctrineSchemaSubscriber::class, DoctrineDbalCacheAdapterSchemaSubscriber::class);
+
 /**
  * Automatically adds the cache table needed for the PdoAdapter.
  *
  * @author Ryan Weaver <ryan@symfonycasts.com>
+ * @deprecated since symfony 5.4 use DoctrineDbalCacheAdapterSchemaSubscriber
  */
 final class PdoCacheAdapterDoctrineSchemaSubscriber implements EventSubscriber
 {
diff --git a/src/Symfony/Bridge/Doctrine/Tests/SchemaListener/DoctrineDbalCacheAdapterSchemaSubscriberTest.php b/src/Symfony/Bridge/Doctrine/Tests/SchemaListener/DoctrineDbalCacheAdapterSchemaSubscriberTest.php
@@ -0,0 +1,42 @@
+<?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\Tests\SchemaListener;
+
+use Doctrine\DBAL\Connection;
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\ORM\EntityManagerInterface;
+use Doctrine\ORM\Tools\Event\GenerateSchemaEventArgs;
+use PHPUnit\Framework\TestCase;
+use Symfony\Bridge\Doctrine\SchemaListener\DoctrineDbalCacheAdapterSchemaSubscriber;
+use Symfony\Component\Cache\Adapter\DoctrineDbalAdapter;
+
+class DoctrineDbalCacheAdapterSchemaSubscriberTest extends TestCase
+{
+    public function testPostGenerateSchema()
+    {
+        $schema = new Schema();
+        $dbalConnection = $this->createMock(Connection::class);
+        $entityManager = $this->createMock(EntityManagerInterface::class);
+        $entityManager->expects($this->once())
+            ->method('getConnection')
+            ->willReturn($dbalConnection);
+        $event = new GenerateSchemaEventArgs($entityManager, $schema);
+
+        $pdoAdapter = $this->createMock(DoctrineDbalAdapter::class);
+        $pdoAdapter->expects($this->once())
+            ->method('configureSchema')
+            ->with($schema, $dbalConnection);
+
+        $subscriber = new DoctrineDbalCacheAdapterSchemaSubscriber([$pdoAdapter]);
+        $subscriber->postGenerateSchema($event);
+    }
+}
diff --git a/src/Symfony/Bridge/Doctrine/Tests/SchemaListener/PdoCacheAdapterDoctrineSchemaSubscriberTest.php b/src/Symfony/Bridge/Doctrine/Tests/SchemaListener/PdoCacheAdapterDoctrineSchemaSubscriberTest.php
@@ -19,6 +19,9 @@
 use Symfony\Bridge\Doctrine\SchemaListener\PdoCacheAdapterDoctrineSchemaSubscriber;
 use Symfony\Component\Cache\Adapter\PdoAdapter;
 
+/**
+ * @group legacy
+ */
 class PdoCacheAdapterDoctrineSchemaSubscriberTest extends TestCase
 {
     public function testPostGenerateSchema()

Original file line number	Diff line number	Diff line change
`@@ -16,10 +16,13 @@`
`16`	`16`	`use Doctrine\ORM\Tools\ToolEvents;`
`17`	`17`	`use Symfony\Component\Cache\Adapter\PdoAdapter;`
`18`	`18`
	`19`	`+trigger_deprecation('symfony/doctrine-bridge', '5.4', 'The "%s" class is deprecated, use "%s" instead.', PdoCacheAdapterDoctrineSchemaSubscriber::class, DoctrineDbalCacheAdapterSchemaSubscriber::class);`
	`20`	`+`
`19`	`21`	`/**`
`20`	`22`	`* Automatically adds the cache table needed for the PdoAdapter.`
`21`	`23`	`*`
`22`	`24`	`* @author Ryan Weaver <ryan@symfonycasts.com>`
	`25`	`+ * @deprecated since symfony 5.4 use DoctrineDbalCacheAdapterSchemaSubscriber`
`23`	`26`	`*/`
`24`	`27`	`final class PdoCacheAdapterDoctrineSchemaSubscriber implements EventSubscriber`
`25`	`28`	`{`
Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,9 @@`
`19`	`19`	`use Symfony\Bridge\Doctrine\SchemaListener\PdoCacheAdapterDoctrineSchemaSubscriber;`
`20`	`20`	`use Symfony\Component\Cache\Adapter\PdoAdapter;`
`21`	`21`
	`22`	`+/**`
	`23`	`+ * @group legacy`
	`24`	`+ */`
`22`	`25`	`class PdoCacheAdapterDoctrineSchemaSubscriberTest extends TestCase`
`23`	`26`	`{`
`24`	`27`	`public function testPostGenerateSchema()`