Add support for new SqlOutputWalker class in the ORM

phpstan-baseline.neon

@@ -440,6 +440,11 @@ parameters:
 			count: 1
 			path: src/Timestampable/Mapping/Driver/Yaml.php
 
+		-
+			message: "#^Call to an undefined static method Doctrine\\\\ORM\\\\Query\\\\SqlWalker\\:\\:getFinalizer\\(\\)\\.$#"
+			count: 2
+			path: src/Tool/ORM/Walker/CompatSqlOutputWalker.php
+
 		-
 			message: "#^Call to an undefined method Doctrine\\\\Persistence\\\\ObjectManager\\:\\:getUnitOfWork\\(\\)\\.$#"
 			count: 1

src/SoftDeleteable/Query/TreeWalker/SoftDeleteableWalker.php

@@ -18,12 +18,14 @@
 use Doctrine\ORM\Query\AST\SelectStatement;
 use Doctrine\ORM\Query\AST\UpdateStatement;
 use Doctrine\ORM\Query\Exec\AbstractSqlExecutor;
+use Doctrine\ORM\Query\Exec\PreparedExecutorFinalizer;
 use Doctrine\ORM\Query\Exec\SingleTableDeleteUpdateExecutor;
-use Doctrine\ORM\Query\SqlWalker;
+use Doctrine\ORM\Query\Exec\SqlFinalizer;
 use Gedmo\Exception\RuntimeException;
 use Gedmo\Exception\UnexpectedValueException;
 use Gedmo\SoftDeleteable\Query\TreeWalker\Exec\MultiTableDeleteExecutor;
 use Gedmo\SoftDeleteable\SoftDeleteableListener;
+use Gedmo\Tool\ORM\Walker\CompatSqlOutputWalker;
 use Gedmo\Tool\ORM\Walker\SqlWalkerCompat;
 
 /**
@@ -36,7 +38,7 @@
  *
  * @final since gedmo/doctrine-extensions 3.11
  */
-class SoftDeleteableWalker extends SqlWalker
+class SoftDeleteableWalker extends CompatSqlOutputWalker
 {
     use SqlWalkerCompat;
 
@@ -99,21 +101,43 @@
      * @param SelectStatement|UpdateStatement|DeleteStatement $statement
      *
      * @throws UnexpectedValueException when an unsupported AST statement is given
+     *
+     * @phpstan-assert DeleteStatement $statement
      */
     protected function doGetExecutorWithCompat($statement): AbstractSqlExecutor
     {
-        switch (true) {
-            case $statement instanceof DeleteStatement:
-                assert(class_exists($statement->deleteClause->abstractSchemaName));
+        if (!$statement instanceof DeleteStatement) {
+            throw new UnexpectedValueException('SoftDeleteable walker should be used only on delete statement');
+        }
 
-                $primaryClass = $this->getEntityManager()->getClassMetadata($statement->deleteClause->abstractSchemaName);
+        return $this->createDeleteStatementExecutor($statement);
+    }
 
-                return $primaryClass->isInheritanceTypeJoined()
-                    ? new MultiTableDeleteExecutor($statement, $this, $this->meta, $this->getConnection()->getDatabasePlatform(), $this->configuration)
-                    : new SingleTableDeleteUpdateExecutor($statement, $this);
-            default:
-                throw new UnexpectedValueException('SoftDeleteable walker should be used only on delete statement');
+    /**
+     * @param DeleteStatement|UpdateStatement|SelectStatement $AST
+     *
+     * @throws UnexpectedValueException when an unsupported AST statement is given
+     *
+     * @phpstan-assert DeleteStatement $AST
+     */
+    protected function doGetFinalizerWithCompat($AST): SqlFinalizer
+    {
+        if (!$AST instanceof DeleteStatement) {
+            throw new UnexpectedValueException('SoftDeleteable walker should be used only on delete statement');
         }
+
+        return new PreparedExecutorFinalizer($this->createDeleteStatementExecutor($AST));
+    }
+
+    protected function createDeleteStatementExecutor(DeleteStatement $AST): AbstractSqlExecutor
+    {
+        assert(class_exists($AST->deleteClause->abstractSchemaName));
+
+        $primaryClass = $this->getEntityManager()->getClassMetadata($AST->deleteClause->abstractSchemaName);
+
+        return $primaryClass->isInheritanceTypeJoined()
+            ? new MultiTableDeleteExecutor($AST, $this, $this->meta, $this->getConnection()->getDatabasePlatform(), $this->configuration)
+            : new SingleTableDeleteUpdateExecutor($AST, $this);
     }
 
     /**

src/Tool/ORM/Walker/CompatSqlOutputWalker.php

@@ -0,0 +1,59 @@
+<?php
+
+/*
+ * This file is part of the Doctrine Behavioral Extensions package.
+ * (c) Gediminas Morkevicius <gediminas.morkevicius@gmail.com> http://www.gediminasm.org
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Gedmo\Tool\ORM\Walker;
+
+use Doctrine\ORM\Query\SqlOutputWalker;
+use Doctrine\ORM\Query\SqlWalker;
+
+if (class_exists(SqlOutputWalker::class)) {
+    if ((new \ReflectionClass(SqlWalker::class))->getMethod('getExecutor')->hasReturnType()) {
+        /**
+         * Helper trait to address compatibility issues between ORM 2.x and 3.x.
+         *
+         * @internal
+         */
+        abstract class CompatSqlOutputWalker extends SqlOutputWalker
+        {
+            use CompatSqlOutputWalkerForOrm3;
+        }
+    } else {
+        /**
+         * Helper trait to address compatibility issues between ORM 2.x and 3.x.
+         *
+         * @internal
+         */
+        abstract class CompatSqlOutputWalker extends SqlOutputWalker
+        {
+            use CompatSqlOutputWalkerForOrm2;
+        }
+    }
+} else {
+    if ((new \ReflectionClass(SqlWalker::class))->getMethod('getExecutor')->hasReturnType()) {
+        /**
+         * Helper trait to address compatibility issues between ORM 2.x and 3.x.
+         *
+         * @internal
+         */
+        abstract class CompatSqlOutputWalker extends SqlWalker
+        {
+            use CompatSqlOutputWalkerForOrm3;
+        }
+    } else {
+        /**
+         * Helper trait to address compatibility issues between ORM 2.x and 3.x.
+         *
+         * @internal
+         */
+        abstract class CompatSqlOutputWalker extends SqlWalker
+        {
+            use CompatSqlOutputWalkerForOrm2;
+        }
+    }
+}

src/Tool/ORM/Walker/CompatSqlOutputWalkerForOrm2.php

@@ -0,0 +1,42 @@
+<?php
+
+/*
+ * This file is part of the Doctrine Behavioral Extensions package.
+ * (c) Gediminas Morkevicius <gediminas.morkevicius@gmail.com> http://www.gediminasm.org
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Gedmo\Tool\ORM\Walker;
+
+use Doctrine\ORM\Query\AST\DeleteStatement;
+use Doctrine\ORM\Query\AST\SelectStatement;
+use Doctrine\ORM\Query\AST\UpdateStatement;
+use Doctrine\ORM\Query\Exec\SqlFinalizer;
+use Doctrine\ORM\Query\SqlOutputWalker;
+
+/**
+ * Helper trait to address compatibility issues between ORM 2.x and 3.x.
+ *
+ * @mixin SqlOutputWalker
+ *
+ * @internal
+ */
+trait CompatSqlOutputWalkerForOrm2
+{
+    /**
+     * @param DeleteStatement|UpdateStatement|SelectStatement $AST
+     */
+    public function getFinalizer($AST): SqlFinalizer
+    {
+        return $this->doGetFinalizerWithCompat($AST);
+    }
+
+    /**
+     * @param DeleteStatement|UpdateStatement|SelectStatement $AST
+     */
+    protected function doGetFinalizerWithCompat($AST): SqlFinalizer
+    {
+        return parent::getFinalizer($AST);
+    }
+}

src/Tool/ORM/Walker/CompatSqlOutputWalkerForOrm3.php

@@ -0,0 +1,39 @@
+<?php
+
+/*
+ * This file is part of the Doctrine Behavioral Extensions package.
+ * (c) Gediminas Morkevicius <gediminas.morkevicius@gmail.com> http://www.gediminasm.org
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Gedmo\Tool\ORM\Walker;
+
+use Doctrine\ORM\Query\AST\DeleteStatement;
+use Doctrine\ORM\Query\AST\SelectStatement;
+use Doctrine\ORM\Query\AST\UpdateStatement;
+use Doctrine\ORM\Query\Exec\SqlFinalizer;
+use Doctrine\ORM\Query\SqlOutputWalker;
+
+/**
+ * Helper trait to address compatibility issues between ORM 2.x and 3.x.
+ *
+ * @mixin SqlOutputWalker
+ *
+ * @internal
+ */
+trait CompatSqlOutputWalkerForOrm3
+{
+    public function getFinalizer(DeleteStatement|UpdateStatement|SelectStatement $AST): SqlFinalizer
+    {
+        return $this->doGetFinalizerWithCompat($AST);
+    }
+
+    /**
+     * @param DeleteStatement|UpdateStatement|SelectStatement $AST
+     */
+    protected function doGetFinalizerWithCompat($AST): SqlFinalizer
+    {
+        return parent::getFinalizer($AST);
+    }
+}

src/Translatable/Query/TreeWalker/TranslationWalker.php

@@ -32,8 +32,10 @@
 use Doctrine\ORM\Query\AST\WhereClause;
 use Doctrine\ORM\Query\Exec\AbstractSqlExecutor;
 use Doctrine\ORM\Query\Exec\SingleSelectExecutor;
-use Doctrine\ORM\Query\SqlWalker;
+use Doctrine\ORM\Query\Exec\SingleSelectSqlFinalizer;
+use Doctrine\ORM\Query\Exec\SqlFinalizer;
 use Gedmo\Exception\RuntimeException;
+use Gedmo\Tool\ORM\Walker\CompatSqlOutputWalker;
 use Gedmo\Tool\ORM\Walker\SqlWalkerCompat;
 use Gedmo\Translatable\Hydrator\ORM\ObjectHydrator;
 use Gedmo\Translatable\Hydrator\ORM\SimpleObjectHydrator;
@@ -54,7 +56,7 @@
  *
  * @final since gedmo/doctrine-extensions 3.11
  */
-class TranslationWalker extends SqlWalker
+class TranslationWalker extends CompatSqlOutputWalker
 {
     use SqlWalkerCompat;
 
@@ -141,6 +143,21 @@
         return new SingleSelectExecutor($statement, $this);
     }
 
+    /**
+     * @param DeleteStatement|UpdateStatement|SelectStatement $AST
+     */
+    protected function doGetFinalizerWithCompat($AST): SqlFinalizer
+    {
+        // If it's not a Select, the TreeWalker ought to skip it, and just return the parent.
+        // @see /~https://github.com/doctrine-extensions/DoctrineExtensions/issues/2013
+        if (!$AST instanceof SelectStatement) {
+            return parent::getFinalizer($AST);
+        }
+        $this->prepareTranslatedComponents();
+
+        return new SingleSelectSqlFinalizer($this->walkSelectStatement($AST));
+    }
+
     protected function doWalkSelectStatementWithCompat(SelectStatement $selectStatement): string
     {
         $result = parent::walkSelectStatement($selectStatement);