refactor: stricter method argument types when handling variadic functions (martin-georgiev#343)

Author: martin-georgiev

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

@@ -4,6 +4,7 @@
 
 namespace MartinGeorgiev\Doctrine\ORM\Query\AST\Functions;
 
+use Doctrine\ORM\Query\AST\Node;
 use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Exception\InvalidArgumentForVariadicFunctionException;
 
 /**
@@ -23,7 +24,7 @@ protected function customizeFunction(): void
         $this->setFunctionPrototype('ARRAY[%s]');
     }
 
-    protected function validateArguments(array $arguments): void
+    protected function validateArguments(Node ...$arguments): void
     {
         $argumentCount = \count($arguments);
         if ($argumentCount === 0) {

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

@@ -51,7 +51,7 @@ protected function feedParserWithNodes(Parser $parser): void
             $lookaheadType = DoctrineLexer::getLookaheadType($lexer);
         }
 
-        $this->validateArguments($this->nodes);
+        $this->validateArguments(...$this->nodes); // @phpstan-ignore-line
     }
 
     public function getSql(SqlWalker $sqlWalker): string
@@ -67,9 +67,7 @@ public function getSql(SqlWalker $sqlWalker): string
     /**
      * Validates the arguments passed to the function.
      *
-     * @param mixed[] $arguments The array of arguments to validate
-     *
      * @throws InvalidArgumentForVariadicFunctionException
      */
-    abstract protected function validateArguments(array $arguments): void;
+    abstract protected function validateArguments(Node ...$arguments): void;
 }

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

@@ -4,6 +4,7 @@
 
 namespace MartinGeorgiev\Doctrine\ORM\Query\AST\Functions;
 
+use Doctrine\ORM\Query\AST\Node;
 use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Exception\InvalidArgumentForVariadicFunctionException;
 
 /**
@@ -21,7 +22,7 @@ protected function customizeFunction(): void
         $this->setFunctionPrototype('greatest(%s)');
     }
 
-    protected function validateArguments(array $arguments): void
+    protected function validateArguments(Node ...$arguments): void
     {
         $argumentCount = \count($arguments);
         if ($argumentCount < 2) {

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

@@ -4,6 +4,7 @@
 
 namespace MartinGeorgiev\Doctrine\ORM\Query\AST\Functions;
 
+use Doctrine\ORM\Query\AST\Node;
 use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Exception\InvalidArgumentForVariadicFunctionException;
 
 /**
@@ -21,7 +22,7 @@ protected function customizeFunction(): void
         $this->setFunctionPrototype('json_build_object(%s)');
     }
 
-    protected function validateArguments(array $arguments): void
+    protected function validateArguments(Node ...$arguments): void
     {
         $argumentCount = \count($arguments);
         if ($argumentCount === 0 || $argumentCount % 2 !== 0) {

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

@@ -4,6 +4,7 @@
 
 namespace MartinGeorgiev\Doctrine\ORM\Query\AST\Functions;
 
+use Doctrine\ORM\Query\AST\Node;
 use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Exception\InvalidArgumentForVariadicFunctionException;
 
 /**
@@ -21,7 +22,7 @@ protected function customizeFunction(): void
         $this->setFunctionPrototype('jsonb_build_object(%s)');
     }
 
-    protected function validateArguments(array $arguments): void
+    protected function validateArguments(Node ...$arguments): void
     {
         $argumentCount = \count($arguments);
         if ($argumentCount === 0 || $argumentCount % 2 !== 0) {

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

@@ -4,6 +4,7 @@
 
 namespace MartinGeorgiev\Doctrine\ORM\Query\AST\Functions;
 
+use Doctrine\ORM\Query\AST\Node;
 use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Exception\InvalidArgumentForVariadicFunctionException;
 
 /**
@@ -21,7 +22,7 @@ protected function customizeFunction(): void
         $this->setFunctionPrototype('least(%s)');
     }
 
-    protected function validateArguments(array $arguments): void
+    protected function validateArguments(Node ...$arguments): void
     {
         $argumentCount = \count($arguments);
         if ($argumentCount < 2) {

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

@@ -4,6 +4,7 @@
 
 namespace MartinGeorgiev\Doctrine\ORM\Query\AST\Functions;
 
+use Doctrine\ORM\Query\AST\Node;
 use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Exception\InvalidArgumentForVariadicFunctionException;
 
 /**
@@ -20,7 +21,7 @@ protected function customizeFunction(): void
         $this->setFunctionPrototype('ROW(%s)');
     }
 
-    protected function validateArguments(array $arguments): void
+    protected function validateArguments(Node ...$arguments): void
     {
         $argumentCount = \count($arguments);
         if ($argumentCount === 0) {

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

@@ -4,6 +4,7 @@
 
 namespace MartinGeorgiev\Doctrine\ORM\Query\AST\Functions;
 
+use Doctrine\ORM\Query\AST\Node;
 use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Exception\InvalidArgumentForVariadicFunctionException;
 
 /**
@@ -21,7 +22,7 @@ protected function customizeFunction(): void
         $this->setFunctionPrototype('to_tsquery(%s)');
     }
 
-    protected function validateArguments(array $arguments): void
+    protected function validateArguments(Node ...$arguments): void
     {
         $argumentCount = \count($arguments);
         if ($argumentCount < 1 || $argumentCount > 2) {

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

@@ -4,6 +4,7 @@
 
 namespace MartinGeorgiev\Doctrine\ORM\Query\AST\Functions;
 
+use Doctrine\ORM\Query\AST\Node;
 use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Exception\InvalidArgumentForVariadicFunctionException;
 
 /**
@@ -23,7 +24,7 @@ protected function customizeFunction(): void
         $this->setFunctionPrototype('to_tsvector(%s)');
     }
 
-    protected function validateArguments(array $arguments): void
+    protected function validateArguments(Node ...$arguments): void
     {
         $argumentCount = \count($arguments);
         if ($argumentCount < 1 || $argumentCount > 2) {

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

@@ -4,6 +4,7 @@
 
 namespace MartinGeorgiev\Doctrine\ORM\Query\AST\Functions;
 
+use Doctrine\ORM\Query\AST\Node;
 use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Exception\InvalidArgumentForVariadicFunctionException;
 
 /**
@@ -22,7 +23,7 @@ protected function customizeFunction(): void
         $this->setFunctionPrototype('unaccent(%s)');
     }
 
-    protected function validateArguments(array $arguments): void
+    protected function validateArguments(Node ...$arguments): void
     {
         $argumentCount = \count($arguments);
         if ($argumentCount < 1 || $argumentCount > 2) {