Add $not constructor parameter to AST classes

derrabus · derrabus · commit 59d612b197fb · 2022-12-05T01:39:32.000+01:00
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;
     }
 
     /**
diff --git a/lib/Doctrine/ORM/Query/Parser.php b/lib/Doctrine/ORM/Query/Parser.php
diff --git a/lib/Doctrine/ORM/Query/SqlWalker.php b/lib/Doctrine/ORM/Query/SqlWalker.php
diff --git a/lib/Doctrine/ORM/Tools/Pagination/WhereInWalker.php b/lib/Doctrine/ORM/Tools/Pagination/WhereInWalker.php
diff --git a/phpstan-params.neon b/phpstan-params.neon
diff --git a/psalm.xml b/psalm.xml
diff --git a/tests/Doctrine/Tests/ORM/Query/AST/InExpressionTest.php b/tests/Doctrine/Tests/ORM/Query/AST/InExpressionTest.php

Original file line number	Diff line number	Diff line change
`@@ -23,11 +23,12 @@ class BetweenExpression extends Node`
`23`	`23`	`* @param ArithmeticExpression $leftExpr`
`24`	`24`	`* @param ArithmeticExpression $rightExpr`
`25`	`25`	`*/`
`26`		`- public function __construct($expr, $leftExpr, $rightExpr)`
	`26`	`+ public function __construct($expr, $leftExpr, $rightExpr, bool $not = false)`
`27`	`27`	`{`
`28`	`28`	`$this->expression = $expr;`
`29`	`29`	`$this->leftBetweenExpression = $leftExpr;`
`30`	`30`	`$this->rightBetweenExpression = $rightExpr;`
	`31`	`+ $this->not = $not;`
`31`	`32`	`}`
`32`	`33`
`33`	`34`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -24,10 +24,11 @@ class CollectionMemberExpression extends Node`
`24`	`24`	`* @param mixed $entityExpr`
`25`	`25`	`* @param PathExpression $collValuedPathExpr`
`26`	`26`	`*/`
`27`		`- public function __construct($entityExpr, $collValuedPathExpr)`
	`27`	`+ public function __construct($entityExpr, $collValuedPathExpr, bool $not = false)`
`28`	`28`	`{`
`29`	`29`	`$this->entityExpression = $entityExpr;`
`30`	`30`	`$this->collectionValuedPathExpression = $collValuedPathExpr;`
	`31`	`+ $this->not = $not;`
`31`	`32`	`}`
`32`	`33`
`33`	`34`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -18,9 +18,10 @@ class ConditionalFactor extends Node`
`18`	`18`	`public $conditionalPrimary;`
`19`	`19`
`20`	`20`	`/** @param ConditionalPrimary $conditionalPrimary */`
`21`		`- public function __construct($conditionalPrimary)`
	`21`	`+ public function __construct($conditionalPrimary, bool $not = false)`
`22`	`22`	`{`
`23`	`23`	`$this->conditionalPrimary = $conditionalPrimary;`
	`24`	`+ $this->not = $not;`
`24`	`25`	`}`
`25`	`26`
`26`	`27`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -18,9 +18,10 @@ class EmptyCollectionComparisonExpression extends Node`
`18`	`18`	`public $not;`
`19`	`19`
`20`	`20`	`/** @param PathExpression $expression */`
`21`		`- public function __construct($expression)`
	`21`	`+ public function __construct($expression, bool $not = false)`
`22`	`22`	`{`
`23`	`23`	`$this->expression = $expression;`
	`24`	`+ $this->not = $not;`
`24`	`25`	`}`
`25`	`26`
`26`	`27`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -18,9 +18,10 @@ class ExistsExpression extends Node`
`18`	`18`	`public $subselect;`
`19`	`19`
`20`	`20`	`/** @param Subselect $subselect */`
`21`		`- public function __construct($subselect)`
	`21`	`+ public function __construct($subselect, bool $not = false)`
`22`	`22`	`{`
`23`	`23`	`$this->subselect = $subselect;`
	`24`	`+ $this->not = $not;`
`24`	`25`	`}`
`25`	`26`
`26`	`27`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -4,10 +4,12 @@`
`4`	`4`
`5`	`5`	`namespace Doctrine\ORM\Query\AST;`
`6`	`6`
	`7`	`+use Doctrine\Deprecations\Deprecation;`
	`8`	`+`
`7`	`9`	`/**`
`8`	`10`	`* InExpression ::= ArithmeticExpression ["NOT"] "IN" "(" (Literal {"," Literal}* \| Subselect) ")"`
`9`	`11`	`*`
`10`		`- * @link www.doctrine-project.org`
	`12`	`+ * @deprecated Use {@see InListExpression} or {@see InSubselectExpression} instead.`
`11`	`13`	`*/`
`12`	`14`	`class InExpression extends Node`
`13`	`15`	`{`
`@@ -26,6 +28,17 @@ class InExpression extends Node`
`26`	`28`	`/** @param ArithmeticExpression $expression */`
`27`	`29`	`public function __construct($expression)`
`28`	`30`	`{`
	`31`	`+ if (! $this instanceof InListExpression && ! $this instanceof InSubselectExpression) {`
	`32`	`+ Deprecation::trigger(`
	`33`	`+ 'doctrine/orm',`
	`34`	`+ 'https://github.com/doctrine/orm/pull/10267',`
	`35`	`+ '%s is deprecated, use %s or %s instead.',`
	`36`	`+ self::class,`
	`37`	`+ InListExpression::class,`
	`38`	`+ InSubselectExpression::class`
	`39`	`+ );`
	`40`	`+ }`
	`41`	`+`
`29`	`42`	`$this->expression = $expression;`
`30`	`43`	`}`
`31`	`44`
`@@ -34,6 +47,7 @@ public function __construct($expression)`
`34`	`47`	`*/`
`35`	`48`	`public function dispatch($sqlWalker)`
`36`	`49`	`{`
	`50`	`+ // We still call the deprecated method in order to not break existing custom SQL walkers.`
`37`	`51`	`return $sqlWalker->walkInExpression($this);`
`38`	`52`	`}`
`39`	`53`	`}`
Original file line number	Diff line number	Diff line change
`@@ -30,11 +30,12 @@ class LikeExpression extends Node`
`30`	`30`	`* @param InputParameter\|FunctionNode\|PathExpression\|Literal $stringPattern`
`31`	`31`	`* @param Literal\|null $escapeChar`
`32`	`32`	`*/`
`33`		`- public function __construct($stringExpression, $stringPattern, $escapeChar = null)`
	`33`	`+ public function __construct($stringExpression, $stringPattern, $escapeChar = null, bool $not = false)`
`34`	`34`	`{`
`35`	`35`	`$this->stringExpression = $stringExpression;`
`36`	`36`	`$this->stringPattern = $stringPattern;`
`37`	`37`	`$this->escapeChar = $escapeChar;`
	`38`	`+ $this->not = $not;`
`38`	`39`	`}`
`39`	`40`
`40`	`41`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -18,9 +18,10 @@ class NullComparisonExpression extends Node`
`18`	`18`	`public $expression;`
`19`	`19`
`20`	`20`	`/** @param Node $expression */`
`21`		`- public function __construct($expression)`
	`21`	`+ public function __construct($expression, bool $not = false)`
`22`	`22`	`{`
`23`	`23`	`$this->expression = $expression;`
	`24`	`+ $this->not = $not;`
`24`	`25`	`}`
`25`	`26`
`26`	`27`	`/**`