support conditional number of placeholders (#187)

Co-authored-by: Markus Staab <[email protected]>

Author: staabm

.phpunit-phpstan-dba.cache

@@ -39,7 +39,16 @@ private function checkErrors(string $queryString, array $parameters): iterable
         $queryReflection = new QueryReflection();
         $placeholderCount = $queryReflection->countPlaceholders($queryString);
 
-        if (0 === \count($parameters)) {
+        $parameterCount = \count($parameters);
+        $minParameterCount = 0;
+        foreach ($parameters as $parameter) {
+            if ($parameter->isOptional) {
+                continue;
+            }
+            ++$minParameterCount;
+        }
+
+        if (0 === $parameterCount && 0 === $minParameterCount) {
             if (0 === $placeholderCount) {
                 return;
             }
@@ -58,7 +67,7 @@ private function checkErrors(string $queryString, array $parameters): iterable
     }
 
     /**
-     * @param non-empty-array<string|int, Parameter> $parameters
+     * @param array<string|int, Parameter> $parameters
      *
      * @return iterable<string>
      */

src/QueryReflection/PlaceholderValidation.php

@@ -69,9 +69,9 @@ public function getResultType(string $queryString, int $fetchType): ?Type
     }
 
     /**
-     * @throws UnresolvableQueryException
-     *
      * @return iterable<string>
+     *
+     * @throws UnresolvableQueryException
      */
     public function resolvePreparedQueryStrings(Expr $queryExpr, Type $parameterTypes, Scope $scope): iterable
     {
@@ -118,9 +118,9 @@ public function resolvePreparedQueryString(Expr $queryExpr, Type $parameterTypes
     }
 
     /**
-     * @throws UnresolvableQueryException
-     *
      * @return iterable<string>
+     *
+     * @throws UnresolvableQueryException
      */
     public function resolveQueryStrings(Expr $queryExpr, Scope $scope): iterable
     {
@@ -203,55 +203,78 @@ public static function getQueryType(string $query): ?string
     /**
      * Resolves prepared statement parameter types.
      *
-     * @throws UnresolvableQueryException
-     *
      * @return array<string|int, Parameter>|null
+     *
+     * @throws UnresolvableQueryException
      */
     public function resolveParameters(Type $parameterTypes): ?array
     {
         $parameters = [];
 
-        if ($parameterTypes instanceof ConstantArrayType) {
-            $keyTypes = $parameterTypes->getKeyTypes();
-            $valueTypes = $parameterTypes->getValueTypes();
-            $optionalKeys = $parameterTypes->getOptionalKeys();
-
-            foreach ($keyTypes as $i => $keyType) {
-                $isOptional = \in_array($i, $optionalKeys, true);
-
-                if ($keyType instanceof ConstantStringType) {
-                    $placeholderName = $keyType->getValue();
-
-                    if ('' === $placeholderName) {
-                        throw new ShouldNotHappenException('Empty placeholder name');
-                    }
-
-                    $param = new Parameter(
-                        $placeholderName,
-                        $valueTypes[$i],
-                        QuerySimulation::simulateParamValueType($valueTypes[$i], true),
-                        $isOptional
-                    );
-
-                    $parameters[$param->name] = $param;
-                } elseif ($keyType instanceof ConstantIntegerType) {
-                    $param = new Parameter(
-                        null,
-                        $valueTypes[$i],
-                        QuerySimulation::simulateParamValueType($valueTypes[$i], true),
-                        $isOptional
-                    );
-
-                    $parameters[$keyType->getValue()] = $param;
-                }
+        if ($parameterTypes instanceof UnionType) {
+            foreach (TypeUtils::getConstantArrays($parameterTypes) as $constantArray) {
+                $parameters = $parameters + $this->resolveConstantArray($constantArray, true);
             }
 
             return $parameters;
         }
 
+        if ($parameterTypes instanceof ConstantArrayType) {
+            return $this->resolveConstantArray($parameterTypes, false);
+        }
+
         return null;
     }
 
+    /**
+     * @return array<string|int, Parameter>
+     *
+     * @throws UnresolvableQueryException
+     */
+    private function resolveConstantArray(ConstantArrayType $parameterTypes, bool $forceOptional): array
+    {
+        $parameters = [];
+
+        $keyTypes = $parameterTypes->getKeyTypes();
+        $valueTypes = $parameterTypes->getValueTypes();
+        $optionalKeys = $parameterTypes->getOptionalKeys();
+
+        foreach ($keyTypes as $i => $keyType) {
+            $isOptional = \in_array($i, $optionalKeys, true);
+            if ($forceOptional) {
+                $isOptional = true;
+            }
+
+            if ($keyType instanceof ConstantStringType) {
+                $placeholderName = $keyType->getValue();
+
+                if ('' === $placeholderName) {
+                    throw new ShouldNotHappenException('Empty placeholder name');
+                }
+
+                $param = new Parameter(
+                    $placeholderName,
+                    $valueTypes[$i],
+                    QuerySimulation::simulateParamValueType($valueTypes[$i], true),
+                    $isOptional
+                );
+
+                $parameters[$param->name] = $param;
+            } elseif ($keyType instanceof ConstantIntegerType) {
+                $param = new Parameter(
+                    null,
+                    $valueTypes[$i],
+                    QuerySimulation::simulateParamValueType($valueTypes[$i], true),
+                    $isOptional
+                );
+
+                $parameters[$keyType->getValue()] = $param;
+            }
+        }
+
+        return $parameters;
+    }
+
     /**
      * @param array<string|int, Parameter> $parameters
      */

src/QueryReflection/QueryReflection.php

@@ -57,6 +57,14 @@ public function testSyntaxErrorInQueryRule(): void
                 'Value :gesperrt is given, but the query does not contain this placeholder.',
                 137,
             ],
+            [
+                'Query expects placeholder :name, but it is missing from values given.',
+                307,
+            ],
+            [
+                'Query expects 2 placeholders, but 0-1 values are given.',
+                307,
+            ],
         ]);
     }
 }

tests/SyntaxErrorInPreparedStatementMethodRuleTest.php

@@ -283,7 +283,8 @@ public function noErrorOnLockedRead(Connection $connection, int $limit, int $off
         ', [':gesperrt' => 1, ':limit' => $limit, ':offset' => $offset]);
     }
 
-    public function noErrorInBug174(Connection $connection, string $name, ?int $gesperrt = null, ?int $adaid = null) {
+    public function noErrorInBug174(Connection $connection, string $name, ?int $gesperrt = null, ?int $adaid = null)
+    {
         $sql = 'SELECT adaid FROM ada WHERE email = :name';
         $args = ['name' => $name];
         if (null !== $gesperrt) {
@@ -293,4 +294,16 @@ public function noErrorInBug174(Connection $connection, string $name, ?int $gesp
 
         $connection->preparedQuery($sql, $args);
     }
+
+    public function conditionalNumberOfPlaceholders(Connection $connection, string $name, ?int $gesperrt = null, ?int $adaid = null)
+    {
+        $sql = 'SELECT adaid FROM ada WHERE email = :name';
+        $args = [];
+        if (null !== $gesperrt) {
+            $sql .= ' AND gesperrt = :gesperrt';
+            $args['gesperrt'] = $gesperrt;
+        }
+
+        $connection->preparedQuery($sql, $args);
+    }
 }