Merge pull request #3295 from acrobat/fix-doctrine-deprecations

[AllBundles] Fix doctrine dbal/orm deprecations
Kunstmaan · Jun 17, 2023 · fd5fb9c · fd5fb9c
2 parents ee194bf + 65109cd
commit fd5fb9c
Show file tree

Hide file tree

Showing 11 changed files with 45 additions and 36 deletions.
diff --git a/src/Kunstmaan/AdminBundle/Helper/Security/Acl/AclHelper.php b/src/Kunstmaan/AdminBundle/Helper/Security/Acl/AclHelper.php
@@ -2,6 +2,7 @@
 
 namespace Kunstmaan\AdminBundle\Helper\Security\Acl;
 
+use Doctrine\DBAL\Platforms\PostgreSQLPlatform;
 use Doctrine\ORM\EntityManager;
 use Doctrine\ORM\Mapping\QuoteStrategy;
 use Doctrine\ORM\Query;
@@ -167,20 +168,17 @@ private function getPermittedAclIdsSQLForUser(Query $query): string
         }
 
         $objectIdentifierColumn = 'o.object_identifier';
-        if ($databasePlatform->getName() === 'postgresql') {
+        if ($databasePlatform instanceof PostgreSQLPlatform) {
             $objectIdentifierColumn .= '::BIGINT';
         }
 
         $selectQuery = <<<SELECTQUERY
 SELECT DISTINCT {$objectIdentifierColumn} as id FROM acl_object_identities as o
 INNER JOIN acl_classes c ON c.id = o.class_id
 LEFT JOIN acl_entries e ON (
-    e.class_id = o.class_id AND (e.object_identity_id = o.id
-    OR {$databasePlatform->getIsNullExpression('e.object_identity_id')})
-)
-LEFT JOIN acl_security_identities s ON (
-s.id = e.security_identity_id
+    e.class_id = o.class_id AND (e.object_identity_id = o.id OR e.object_identity_id IS NULL)
 )
+LEFT JOIN acl_security_identities s ON (s.id = e.security_identity_id)
 WHERE c.class_type = {$rootEntity}
 AND (s.identifier = {$inString})
 AND e.mask & {$mask} > 0

diff --git a/src/Kunstmaan/AdminBundle/Helper/Security/Acl/AclNativeHelper.php b/src/Kunstmaan/AdminBundle/Helper/Security/Acl/AclNativeHelper.php
@@ -2,6 +2,7 @@
 
 namespace Kunstmaan\AdminBundle\Helper\Security\Acl;
 
+use Doctrine\DBAL\Platforms\PostgreSQLPlatform;
 use Doctrine\DBAL\Query\QueryBuilder;
 use Doctrine\ORM\EntityManager;
 use Kunstmaan\AdminBundle\Helper\Security\Acl\Permission\MaskBuilder;
@@ -103,20 +104,17 @@ public function apply(QueryBuilder $queryBuilder, PermissionDefinition $permissi
         }
 
         $objectIdentifierColumn = 'o.object_identifier';
-        if ($databasePlatform->getName() === 'postgresql') {
+        if ($databasePlatform instanceof PostgreSQLPlatform) {
             $objectIdentifierColumn .= '::BIGINT';
         }
 
         $joinTableQuery = <<<SELECTQUERY
 SELECT DISTINCT {$objectIdentifierColumn} as id FROM acl_object_identities as o
 INNER JOIN acl_classes c ON c.id = o.class_id
 LEFT JOIN acl_entries e ON (
-    e.class_id = o.class_id AND (e.object_identity_id = o.id
-    OR {$databasePlatform->getIsNullExpression('e.object_identity_id')})
-)
-LEFT JOIN acl_security_identities s ON (
-s.id = e.security_identity_id
+    e.class_id = o.class_id AND (e.object_identity_id = o.id OR e.object_identity_id IS NULL)
 )
+LEFT JOIN acl_security_identities s ON (s.id = e.security_identity_id)
 WHERE c.class_type = {$rootEntity}
 AND (s.identifier = {$inString})
 AND e.mask & {$mask} > 0

diff --git a/src/Kunstmaan/AdminBundle/Helper/Security/Acl/AclWalker.php b/src/Kunstmaan/AdminBundle/Helper/Security/Acl/AclWalker.php
@@ -2,6 +2,7 @@
 
 namespace Kunstmaan\AdminBundle\Helper\Security\Acl;
 
+use Doctrine\DBAL\Platforms\PostgreSQLPlatform;
 use Doctrine\ORM\Query\SqlWalker;
 
 /**
@@ -23,18 +24,14 @@ public function walkFromClause($fromClause)
         $alias = $this->getQuery()->getHint('acl.entityRootTableDqlAlias');
         $tableAlias = $this->getSQLTableAlias($name, $alias);
         $extraQuery = $this->getQuery()->getHint('acl.extra.query');
+        $tempAclView = <<<tempAclView
+JOIN ({$extraQuery}) ta_ ON {$tableAlias}.id = ta_.id
+tempAclView;
 
-        switch ($this->getConnection()->getDatabasePlatform()->getName()) {
-            case 'postgresql':
-                $tempAclView = <<<tempAclView
+        if ($this->getConnection()->getDatabasePlatform() instanceof PostgreSQLPlatform) {
+            $tempAclView = <<<tempAclView
 JOIN ({$extraQuery}) ta_ ON {$tableAlias}.id = ta_.id::integer
 tempAclView;
-                break;
-            default:
-                $tempAclView = <<<tempAclView
-JOIN ({$extraQuery}) ta_ ON {$tableAlias}.id = ta_.id
-tempAclView;
-                break;
         }
 
         return $sql . ' ' . $tempAclView;

diff --git a/...maan/AdminListBundle/AdminList/Configurator/AbstractDoctrineDBALAdminListConfigurator.php b/...maan/AdminListBundle/AdminList/Configurator/AbstractDoctrineDBALAdminListConfigurator.php
@@ -129,11 +129,11 @@ public function getItems()
     /**
      * Return an iterable statement or int for all items that matches the current filtering
      *
-     * @return \Traversable|int
+     * @return iterable
      */
     public function getIterator()
     {
-        return $this->getQueryBuilder()->execute()->iterateAssociative();
+        return $this->getQueryBuilder()->executeQuery()->iterateAssociative();
     }
 
     /**

diff --git a/...tmaan/AdminListBundle/AdminList/Configurator/AbstractDoctrineORMAdminListConfigurator.php b/...tmaan/AdminListBundle/AdminList/Configurator/AbstractDoctrineORMAdminListConfigurator.php
@@ -125,11 +125,11 @@ public function getItems()
     /**
      * Return an iterator for all items that matches the current filtering
      *
-     * @return \Iterator
+     * @return iterable
      */
     public function getIterator()
     {
-        return $this->getQuery()->iterate();
+        return $this->getQuery()->toIterable();
     }
 
     /**

diff --git a/src/Kunstmaan/AdminListBundle/AdminList/Configurator/ExportListConfiguratorInterface.php b/src/Kunstmaan/AdminListBundle/AdminList/Configurator/ExportListConfiguratorInterface.php
@@ -10,6 +10,7 @@ public function addExportField($name, $header);
 
     public function buildIterator();
 
+    /** @return iterable */
     public function getIterator();
 
     public function buildFilters();

diff --git a/src/Kunstmaan/FormBundle/AdminList/FormSubmissionExportListConfigurator.php b/src/Kunstmaan/FormBundle/AdminList/FormSubmissionExportListConfigurator.php
@@ -96,7 +96,7 @@ public function buildExportFields()
     }
 
     /**
-     * @return \Iterator
+     * @return iterable
      */
     public function getIterator()
     {
@@ -120,7 +120,7 @@ public function buildIterator()
             ->setParameter('node', $this->nodeTranslation->getNode()->getId())
             ->setParameter('lang', $this->nodeTranslation->getLang())
             ->addOrderBy('fs.created', 'DESC');
-        $iterableResult = $qb->getQuery()->iterate();
+        $iterableResult = $qb->getQuery()->toIterable();
         $isHeaderWritten = false;
 
         $collection = new ArrayCollection();

diff --git a/src/Kunstmaan/FormBundle/Tests/AdminList/FormSubmissionExportListConfiguratorTest.php b/src/Kunstmaan/FormBundle/Tests/AdminList/FormSubmissionExportListConfiguratorTest.php
@@ -68,7 +68,7 @@ protected function getMockedEntityManager()
             ->getMock();
 
         $query->expects($this->any())
-            ->method('iterate')
+            ->method('toIterable')
             ->willReturn($submissions);
 
         $methods = [

diff --git a/src/Kunstmaan/NodeBundle/Repository/NodeRepository.php b/src/Kunstmaan/NodeBundle/Repository/NodeRepository.php
@@ -2,6 +2,8 @@
 
 namespace Kunstmaan\NodeBundle\Repository;
 
+use Doctrine\DBAL\Platforms\PostgreSQLPlatform;
+use Doctrine\DBAL\Platforms\SqlitePlatform;
 use Gedmo\Tree\Entity\Repository\NestedTreeRepository;
 use Kunstmaan\AdminBundle\Entity\BaseUser;
 use Kunstmaan\AdminBundle\Helper\Security\Acl\AclHelper;
@@ -266,20 +268,25 @@ public function getAllMenuNodes(
     ) {
         $connection = $this->_em->getConnection();
         $qb = $connection->createQueryBuilder();
-        $databasePlatformName = $connection->getDatabasePlatform()->getName();
+        $databasePlatform = $connection->getDatabasePlatform();
         $createIfStatement = static function (
             $expression,
             $trueValue,
             $falseValue
-        ) use ($databasePlatformName) {
-            switch ($databasePlatformName) {
-                case 'sqlite':
+        ) use ($databasePlatform) {
+            $defaultStatement = 'IF(%s, %s, %s)';
+            if (null === $databasePlatform) {
+                return sprintf($defaultStatement, $expression, $trueValue, $falseValue);
+            }
+
+            switch (get_class($databasePlatform)) {
+                case SqlitePlatform::class:
                     $statement = 'CASE WHEN %s THEN %s ELSE %s END';
                     break;
-                case 'postgresql':
+                case PostgreSQLPlatform::class:
                     return sprintf('COALESCE(%s, %s)', $falseValue, $trueValue);
                 default:
-                    $statement = 'IF(%s, %s, %s)';
+                    $statement = $defaultStatement;
             }
 
             return sprintf($statement, $expression, $trueValue, $falseValue);
@@ -301,7 +308,7 @@ public function getAllMenuNodes(
             ->where('n.deleted = false')
             ->addGroupBy('n.id');
 
-        if ($databasePlatformName === 'postgresql') {
+        if ($databasePlatform instanceof PostgreSQLPlatform) {
             $qb->addGroupBy('t.url')
                 ->addGroupby('t.id')
                 ->addGroupby('v.weight')

diff --git a/src/Kunstmaan/NodeBundle/Tests/Helper/UrlHelperTest.php b/src/Kunstmaan/NodeBundle/Tests/Helper/UrlHelperTest.php
@@ -2,8 +2,10 @@
 
 namespace Kunstmaan\NodeBundle\Tests\Helper;
 
+use Doctrine\DBAL\Configuration;
 use Doctrine\DBAL\Connection;
 use Doctrine\DBAL\DriverManager;
+use Doctrine\DBAL\Schema\DefaultSchemaManagerFactory;
 use Doctrine\DBAL\Schema\Schema;
 use Doctrine\ORM\EntityManager;
 use Kunstmaan\AdminBundle\Helper\DomainConfigurationInterface;
@@ -20,7 +22,12 @@ class UrlHelperTest extends TestCase
 
     protected function setUp(): void
     {
-        $this->connection = DriverManager::getConnection(['driver' => 'pdo_sqlite', 'memory' => true]);
+        $configuration = new Configuration();
+        // NEXT_MAJOR: Remove check when dbal 2 support is removed.
+        if (method_exists($configuration, 'setSchemaManagerFactory')) {
+            $configuration->setSchemaManagerFactory(new DefaultSchemaManagerFactory());
+        }
+        $this->connection = DriverManager::getConnection(['driver' => 'pdo_sqlite', 'memory' => true], $configuration);
         $this->createSchema();
 
         $this->connection->transactional(

diff --git a/src/Kunstmaan/TranslatorBundle/Tests/app/config/config.yml b/src/Kunstmaan/TranslatorBundle/Tests/app/config/config.yml
@@ -28,6 +28,7 @@ doctrine:
             default:
                 driver:   pdo_sqlite
                 path:     "%kernel.cache_dir%/test.db"
+                use_savepoints: true
     orm:
         default_entity_manager:   default
         entity_managers: