Add $not constructor parameter to AST classes (#10267)

doctrine · Dec 5, 2022 · 5a8541b · 5a8541b
1 parent fa18e13
commit 5a8541b
Show file tree

Hide file tree

Showing 18 changed files with 251 additions and 72 deletions.
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -1,5 +1,13 @@
 # Upgrade to 2.14
 
+## Deprecated `Doctrine\ORM\Query\AST\InExpression`
+
+The AST parser will create a `InListExpression` or a `InSubselectExpression` when
+encountering an `IN ()` DQL expression instead of a generic `InExpression`.
+
+As a consequence, `SqlWalker::walkInExpression()` has been deprecated in favor of
+`SqlWalker::walkInListExpression()` and `SqlWalker::walkInSubselectExpression()`.
+
 ## Deprecated constructing a `CacheKey` without `$hash`
 
 The `Doctrine\ORM\Cache\CacheKey` class has an explicit constructor now with

diff --git a/lib/Doctrine/ORM/Query/AST/BetweenExpression.php b/lib/Doctrine/ORM/Query/AST/BetweenExpression.php
@@ -23,11 +23,12 @@ class BetweenExpression extends Node
      * @param ArithmeticExpression $leftExpr
      * @param ArithmeticExpression $rightExpr
      */
-    public function __construct($expr, $leftExpr, $rightExpr)
+    public function __construct($expr, $leftExpr, $rightExpr, bool $not = false)
     {
         $this->expression             = $expr;
         $this->leftBetweenExpression  = $leftExpr;
         $this->rightBetweenExpression = $rightExpr;
+        $this->not                    = $not;
     }
 
     /**

diff --git a/lib/Doctrine/ORM/Query/AST/CollectionMemberExpression.php b/lib/Doctrine/ORM/Query/AST/CollectionMemberExpression.php
@@ -24,10 +24,11 @@ class CollectionMemberExpression extends Node
      * @param mixed          $entityExpr
      * @param PathExpression $collValuedPathExpr
      */
-    public function __construct($entityExpr, $collValuedPathExpr)
+    public function __construct($entityExpr, $collValuedPathExpr, bool $not = false)
     {
         $this->entityExpression               = $entityExpr;
         $this->collectionValuedPathExpression = $collValuedPathExpr;
+        $this->not                            = $not;
     }
 
     /**

diff --git a/lib/Doctrine/ORM/Query/AST/ConditionalFactor.php b/lib/Doctrine/ORM/Query/AST/ConditionalFactor.php
@@ -18,9 +18,10 @@ class ConditionalFactor extends Node
     public $conditionalPrimary;
 
     /** @param ConditionalPrimary $conditionalPrimary */
-    public function __construct($conditionalPrimary)
+    public function __construct($conditionalPrimary, bool $not = false)
     {
         $this->conditionalPrimary = $conditionalPrimary;
+        $this->not                = $not;
     }
 
     /**

diff --git a/lib/Doctrine/ORM/Query/AST/EmptyCollectionComparisonExpression.php b/lib/Doctrine/ORM/Query/AST/EmptyCollectionComparisonExpression.php
@@ -18,9 +18,10 @@ class EmptyCollectionComparisonExpression extends Node
     public $not;
 
     /** @param PathExpression $expression */
-    public function __construct($expression)
+    public function __construct($expression, bool $not = false)
     {
         $this->expression = $expression;
+        $this->not        = $not;
     }
 
     /**

diff --git a/lib/Doctrine/ORM/Query/AST/ExistsExpression.php b/lib/Doctrine/ORM/Query/AST/ExistsExpression.php
@@ -18,9 +18,10 @@ class ExistsExpression extends Node
     public $subselect;
 
     /** @param Subselect $subselect */
-    public function __construct($subselect)
+    public function __construct($subselect, bool $not = false)
     {
         $this->subselect = $subselect;
+        $this->not       = $not;
     }
 
     /**

diff --git a/lib/Doctrine/ORM/Query/AST/InExpression.php b/lib/Doctrine/ORM/Query/AST/InExpression.php
@@ -4,10 +4,12 @@
 
 namespace Doctrine\ORM\Query\AST;
 
+use Doctrine\Deprecations\Deprecation;
+
 /**
  * InExpression ::= ArithmeticExpression ["NOT"] "IN" "(" (Literal {"," Literal}* | Subselect) ")"
  *
- * @link    www.doctrine-project.org
+ * @deprecated Use {@see InListExpression} or {@see InSubselectExpression} instead.
  */
 class InExpression extends Node
 {
@@ -26,6 +28,17 @@ class InExpression extends Node
     /** @param ArithmeticExpression $expression */
     public function __construct($expression)
     {
+        if (! $this instanceof InListExpression && ! $this instanceof InSubselectExpression) {
+            Deprecation::trigger(
+                'doctrine/orm',
+                'https://github.com/doctrine/orm/pull/10267',
+                '%s is deprecated, use %s or %s instead.',
+                self::class,
+                InListExpression::class,
+                InSubselectExpression::class
+            );
+        }
+
         $this->expression = $expression;
     }
 
@@ -34,6 +47,7 @@ public function __construct($expression)
      */
     public function dispatch($sqlWalker)
     {
+        // We still call the deprecated method in order to not break existing custom SQL walkers.
         return $sqlWalker->walkInExpression($this);
     }
 }
diff --git a/lib/Doctrine/ORM/Query/AST/InListExpression.php b/lib/Doctrine/ORM/Query/AST/InListExpression.php
@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\ORM\Query\AST;
+
+class InListExpression extends InExpression
+{
+    /** @var non-empty-list<mixed> */
+    public $literals;
+
+    /** @param non-empty-list<mixed> $literals */
+    public function __construct(ArithmeticExpression $expression, array $literals, bool $not = false)
+    {
+        $this->literals = $literals;
+        $this->not      = $not;
+
+        parent::__construct($expression);
+    }
+}
diff --git a/lib/Doctrine/ORM/Query/AST/InSubselectExpression.php b/lib/Doctrine/ORM/Query/AST/InSubselectExpression.php
@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\ORM\Query\AST;
+
+class InSubselectExpression extends InExpression
+{
+    /** @var Subselect */
+    public $subselect;
+
+    public function __construct(ArithmeticExpression $expression, Subselect $subselect, bool $not = false)
+    {
+        $this->subselect = $subselect;
+        $this->not       = $not;
+
+        parent::__construct($expression);
+    }
+}
diff --git a/lib/Doctrine/ORM/Query/AST/InstanceOfExpression.php b/lib/Doctrine/ORM/Query/AST/InstanceOfExpression.php
@@ -4,6 +4,10 @@
 
 namespace Doctrine\ORM\Query\AST;
 
+use Doctrine\Deprecations\Deprecation;
+
+use function func_num_args;
+
 /**
  * InstanceOfExpression ::= IdentificationVariable ["NOT"] "INSTANCE" ["OF"] (InstanceOfParameter | "(" InstanceOfParameter {"," InstanceOfParameter}* ")")
  * InstanceOfParameter  ::= AbstractSchemaName | InputParameter
@@ -18,13 +22,27 @@ class InstanceOfExpression extends Node
     /** @var string */
     public $identificationVariable;
 
-    /** @var mixed[] */
+    /** @var non-empty-list<InputParameter|string> */
     public $value;
 
-    /** @param string $identVariable */
-    public function __construct($identVariable)
+    /**
+     * @param string                                $identVariable
+     * @param non-empty-list<InputParameter|string> $value
+     */
+    public function __construct($identVariable, array $value = [], bool $not = false)
     {
+        if (func_num_args() < 2) {
+            Deprecation::trigger(
+                'doctrine/orm',
+                'https://github.com/doctrine/orm/pull/10267',
+                'Not passing a value for $value to %s() is deprecated.',
+                __METHOD__
+            );
+        }
+
         $this->identificationVariable = $identVariable;
+        $this->value                  = $value;
+        $this->not                    = $not;
     }
 
     /**

diff --git a/lib/Doctrine/ORM/Query/AST/LikeExpression.php b/lib/Doctrine/ORM/Query/AST/LikeExpression.php
@@ -30,11 +30,12 @@ class LikeExpression extends Node
      * @param InputParameter|FunctionNode|PathExpression|Literal $stringPattern
      * @param Literal|null                                       $escapeChar
      */
-    public function __construct($stringExpression, $stringPattern, $escapeChar = null)
+    public function __construct($stringExpression, $stringPattern, $escapeChar = null, bool $not = false)
     {
         $this->stringExpression = $stringExpression;
         $this->stringPattern    = $stringPattern;
         $this->escapeChar       = $escapeChar;
+        $this->not              = $not;
     }
 
     /**

diff --git a/lib/Doctrine/ORM/Query/AST/NullComparisonExpression.php b/lib/Doctrine/ORM/Query/AST/NullComparisonExpression.php
@@ -18,9 +18,10 @@ class NullComparisonExpression extends Node
     public $expression;
 
     /** @param Node $expression */
-    public function __construct($expression)
+    public function __construct($expression, bool $not = false)
     {
         $this->expression = $expression;
+        $this->not        = $not;
     }
 
     /**