refactor: allow node mapping in variadic functions to have different patterns, thus opening the path to a combination of node types (compared to the previous single type support) (#349)

Author: martin-georgiev

src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/Arr.php

@@ -17,7 +17,10 @@
  */
 class Arr extends BaseVariadicFunction
 {
-    protected string $commonNodeMapping = 'StringPrimary';
+    protected function getNodeMappingPattern(): array
+    {
+        return ['StringPrimary'];
+    }
 
     protected function customizeFunction(): void
     {

src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/ArrayToJson.php

@@ -26,6 +26,11 @@ class ArrayToJson extends BaseVariadicFunction
 {
     use BooleanValidationTrait;
 
+    protected function getNodeMappingPattern(): array
+    {
+        return ['StringPrimary'];
+    }
+
     protected function customizeFunction(): void
     {
         $this->setFunctionPrototype('array_to_json(%s)');

src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/BaseComparisonFunction.php

@@ -11,5 +11,8 @@
  */
 abstract class BaseComparisonFunction extends BaseVariadicFunction
 {
-    protected string $commonNodeMapping = 'SimpleArithmeticExpression';
+    protected function getNodeMappingPattern(): array
+    {
+        return ['SimpleArithmeticExpression'];
+    }
 }

src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/BaseVariadicFunction.php

@@ -19,18 +19,37 @@
  */
 abstract class BaseVariadicFunction extends BaseFunction
 {
-    protected string $commonNodeMapping = 'StringPrimary';
+    /**
+     * @return array<int|string, string>
+     */
+    abstract protected function getNodeMappingPattern(): array;
 
     /**
      * @throws ParserException
      */
     protected function feedParserWithNodes(Parser $parser): void
     {
+        foreach ($this->getNodeMappingPattern() as $nodeMappingPattern) {
+            try {
+                $this->feedParserWithNodesForNodeMappingPattern($parser, $nodeMappingPattern);
+
+                break;
+            } catch (ParserException) {
+                // swallow and continue with next pattern
+            }
+        }
+
+        $this->validateArguments(...$this->nodes); // @phpstan-ignore-line
+    }
+
+    private function feedParserWithNodesForNodeMappingPattern(Parser $parser, string $nodeMappingPattern): void
+    {
+        $nodeMapping = \explode(',', $nodeMappingPattern);
         $lexer = $parser->getLexer();
 
         try {
             // @phpstan-ignore-next-line
-            $this->nodes[] = $parser->{$this->commonNodeMapping}();
+            $this->nodes[] = $parser->{$nodeMapping[0]}();
             $lookaheadType = DoctrineLexer::getLookaheadType($lexer);
             if ($lookaheadType === null) {
                 throw ParserException::missingLookaheadType();
@@ -40,18 +59,18 @@ protected function feedParserWithNodes(Parser $parser): void
         }
 
         $shouldUseLexer = DoctrineOrm::isPre219();
-
+        $isNodeMappingASimplePattern = \count($nodeMapping) === 1;
+        $nodeIndex = 1;
         while (($shouldUseLexer ? Lexer::T_CLOSE_PARENTHESIS : TokenType::T_CLOSE_PARENTHESIS) !== $lookaheadType) {
             if (($shouldUseLexer ? Lexer::T_COMMA : TokenType::T_COMMA) === $lookaheadType) {
                 $parser->match($shouldUseLexer ? Lexer::T_COMMA : TokenType::T_COMMA);
                 // @phpstan-ignore-next-line
-                $this->nodes[] = $parser->{$this->commonNodeMapping}();
+                $this->nodes[] = $parser->{$nodeMapping[$isNodeMappingASimplePattern ? 0 : $nodeIndex]}();
+                $nodeIndex++;
             }
 
             $lookaheadType = DoctrineLexer::getLookaheadType($lexer);
         }
-
-        $this->validateArguments(...$this->nodes); // @phpstan-ignore-line
     }
 
     public function getSql(SqlWalker $sqlWalker): string

src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/DateAdd.php

@@ -25,6 +25,11 @@ class DateAdd extends BaseVariadicFunction
 {
     use TimezoneValidationTrait;
 
+    protected function getNodeMappingPattern(): array
+    {
+        return ['StringPrimary'];
+    }
+
     protected function customizeFunction(): void
     {
         $this->setFunctionPrototype('date_add(%s)');

src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/DateSubtract.php

@@ -25,6 +25,11 @@ class DateSubtract extends BaseVariadicFunction
 {
     use TimezoneValidationTrait;
 
+    protected function getNodeMappingPattern(): array
+    {
+        return ['StringPrimary'];
+    }
+
     protected function customizeFunction(): void
     {
         $this->setFunctionPrototype('date_subtract(%s)');

src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/JsonBuildObject.php

@@ -17,6 +17,11 @@
  */
 class JsonBuildObject extends BaseVariadicFunction
 {
+    protected function getNodeMappingPattern(): array
+    {
+        return ['StringPrimary'];
+    }
+
     protected function customizeFunction(): void
     {
         $this->setFunctionPrototype('json_build_object(%s)');

src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/JsonbBuildObject.php

@@ -17,6 +17,11 @@
  */
 class JsonbBuildObject extends BaseVariadicFunction
 {
+    protected function getNodeMappingPattern(): array
+    {
+        return ['StringPrimary'];
+    }
+
     protected function customizeFunction(): void
     {
         $this->setFunctionPrototype('jsonb_build_object(%s)');

src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/JsonbInsert.php

@@ -26,6 +26,11 @@ class JsonbInsert extends BaseVariadicFunction
 {
     use BooleanValidationTrait;
 
+    protected function getNodeMappingPattern(): array
+    {
+        return ['StringPrimary'];
+    }
+
     protected function customizeFunction(): void
     {
         $this->setFunctionPrototype('jsonb_insert(%s)');

src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/JsonbPathExists.php

@@ -24,6 +24,11 @@ class JsonbPathExists extends BaseVariadicFunction
 {
     use BooleanValidationTrait;
 
+    protected function getNodeMappingPattern(): array
+    {
+        return ['StringPrimary'];
+    }
+
     protected function customizeFunction(): void
     {
         $this->setFunctionPrototype('jsonb_path_exists(%s)');