added PdoQuoteDynamicReturnTypeExtension (#30)

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

Author: staabm

README.md

@@ -6,6 +6,7 @@ This extension provides following features:
 * `mysqli->query` knows the array shape of the returned results and therefore can return a generic `mysqli_result`
 * `SyntaxErrorInQueryMethodRule` can inspect sql queries and detect syntax errors - `SyntaxErrorInQueryFunctionRule` can do the same for functions
 * `mysqli_real_escape_string` and `mysqli->real_escape_string` dynamic return type extensions
+* `pdo->quote` dynamic return type extension
 
 [see the unit-testsuite](https://github.com/staabm/phpstan-dba/tree/main/tests/data) to get a feeling about the current featureset.
 

config/extensions.neon

@@ -20,3 +20,8 @@ services:
         tags:
         	- phpstan.broker.dynamicMethodReturnTypeExtension
         	- phpstan.broker.dynamicFunctionReturnTypeExtension
+
+    -
+        class: staabm\PHPStanDba\Extensions\PdoQuoteDynamicReturnTypeExtension
+        tags:
+        	- phpstan.broker.dynamicMethodReturnTypeExtension

src/Extensions/MysqliEscapeStringDynamicReturnTypeExtension.php

@@ -65,7 +65,7 @@ private function inferType(Type $argType): Type
         $intersection = [new StringType()];
 
         if ($argType->isNumericString()->yes()) {
-            // a numeric string is by definition non-empty. therefore don't combine the e accessories
+            // a numeric string is by definition non-empty. therefore don't combine the 2 accessories
             $intersection[] = new AccessoryNumericStringType();
         } elseif ($argType->isNonEmptyString()->yes()) {
             $intersection[] = new AccessoryNonEmptyStringType();

src/Extensions/PdoQuoteDynamicReturnTypeExtension.php

@@ -0,0 +1,79 @@
+<?php
+
+declare(strict_types=1);
+
+namespace staabm\PHPStanDba\Extensions;
+
+use PDO;
+use PhpParser\Node\Expr\MethodCall;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\MethodReflection;
+use PHPStan\Reflection\ParametersAcceptorSelector;
+use PHPStan\Type\Accessory\AccessoryNonEmptyStringType;
+use PHPStan\Type\Accessory\AccessoryNumericStringType;
+use PHPStan\Type\Constant\ConstantBooleanType;
+use PHPStan\Type\Constant\ConstantIntegerType;
+use PHPStan\Type\DynamicMethodReturnTypeExtension;
+use PHPStan\Type\IntersectionType;
+use PHPStan\Type\StringType;
+use PHPStan\Type\Type;
+use PHPStan\Type\TypeCombinator;
+
+final class PdoQuoteDynamicReturnTypeExtension implements DynamicMethodReturnTypeExtension
+{
+    public function getClass(): string
+    {
+        return PDO::class;
+    }
+
+    public function isMethodSupported(MethodReflection $methodReflection): bool
+    {
+        return 'quote' === $methodReflection->getName();
+    }
+
+    public function getTypeFromMethodCall(MethodReflection $methodReflection, MethodCall $methodCall, Scope $scope): Type
+    {
+        $args = $methodCall->getArgs();
+        if (\count($args) < 1) {
+            return ParametersAcceptorSelector::selectSingle($methodReflection->getVariants())->getReturnType();
+        }
+
+        if (1 === \count($args)) {
+            $type = PDO::PARAM_STR;
+        } else {
+            $typeType = $scope->getType($args[1]->value);
+            if (!$typeType instanceof ConstantIntegerType) {
+                return ParametersAcceptorSelector::selectSingle($methodReflection->getVariants())->getReturnType();
+            }
+            $type = $typeType->getValue();
+        }
+
+        $argType = $scope->getType($args[0]->value);
+        $stringType = $this->inferStringType($argType);
+
+        // check for types which are supported by all drivers, therefore cannot return false.
+        if (PDO::PARAM_STR === $type || PDO::PARAM_INT === $type || PDO::PARAM_BOOL === $type) {
+            return $stringType;
+        }
+
+        return TypeCombinator::union($stringType, new ConstantBooleanType(false));
+    }
+
+    private function inferStringType(Type $argType): Type
+    {
+        $intersection = [new StringType()];
+
+        if ($argType->isNumericString()->yes()) {
+            // a numeric string is by definition non-empty. therefore don't combine the 2 accessories
+            $intersection[] = new AccessoryNumericStringType();
+        } elseif ($argType->isNonEmptyString()->yes()) {
+            $intersection[] = new AccessoryNonEmptyStringType();
+        }
+
+        if (\count($intersection) > 1) {
+            return new IntersectionType($intersection);
+        }
+
+        return new StringType();
+    }
+}

tests/data/pdo.php

@@ -128,4 +128,48 @@ public function unsupportedFetchTypes(PDO $pdo)
         $stmt = $pdo->query('SELECT email, adaid, gesperrt, freigabe1u1 FROM ada', PDO::FETCH_OBJ);
         assertType('PDOStatement<array>|false', $stmt);
     }
+
+    /**
+     * @param numeric          $n
+     * @param non-empty-string $nonE
+     * @param numeric-string   $numericString
+     */
+    public function quote(PDO $pdo, int $i, float $f, $n, string $s, $nonE, string $numericString)
+    {
+        assertType('numeric-string', $pdo->quote((string) $i));
+        assertType('numeric-string', $pdo->quote((string) $f));
+        assertType('numeric-string', $pdo->quote((string) $n));
+        assertType('numeric-string', $pdo->quote($numericString));
+        assertType('non-empty-string', $pdo->quote($nonE));
+        assertType('string', $pdo->quote($s));
+
+        assertType('numeric-string', $pdo->quote((string) $i, PDO::PARAM_STR));
+        assertType('numeric-string', $pdo->quote((string) $f, PDO::PARAM_STR));
+        assertType('numeric-string', $pdo->quote((string) $n, PDO::PARAM_STR));
+        assertType('numeric-string', $pdo->quote($numericString, PDO::PARAM_STR));
+        assertType('non-empty-string', $pdo->quote($nonE, PDO::PARAM_STR));
+        assertType('string', $pdo->quote($s, PDO::PARAM_STR));
+
+        assertType('numeric-string', $pdo->quote((string) $i, PDO::PARAM_INT));
+        assertType('numeric-string', $pdo->quote((string) $f, PDO::PARAM_INT));
+        assertType('numeric-string', $pdo->quote((string) $n, PDO::PARAM_INT));
+        assertType('numeric-string', $pdo->quote($numericString, PDO::PARAM_INT));
+        assertType('non-empty-string', $pdo->quote($nonE, PDO::PARAM_INT));
+        assertType('string', $pdo->quote($s, PDO::PARAM_INT));
+
+        assertType('numeric-string', $pdo->quote((string) $i, PDO::PARAM_BOOL));
+        assertType('numeric-string', $pdo->quote((string) $f, PDO::PARAM_BOOL));
+        assertType('numeric-string', $pdo->quote((string) $n, PDO::PARAM_BOOL));
+        assertType('numeric-string', $pdo->quote($numericString, PDO::PARAM_BOOL));
+        assertType('non-empty-string', $pdo->quote($nonE, PDO::PARAM_BOOL));
+        assertType('string', $pdo->quote($s, PDO::PARAM_BOOL));
+
+        // not 100% sure, whether LOB is really not supported across the board
+        assertType('numeric-string|false', $pdo->quote((string) $i, PDO::PARAM_LOB));
+        assertType('numeric-string|false', $pdo->quote((string) $f, PDO::PARAM_LOB));
+        assertType('numeric-string|false', $pdo->quote((string) $n, PDO::PARAM_LOB));
+        assertType('numeric-string|false', $pdo->quote($numericString, PDO::PARAM_LOB));
+        assertType('non-empty-string|false', $pdo->quote($nonE, PDO::PARAM_LOB));
+        assertType('string|false', $pdo->quote($s, PDO::PARAM_LOB));
+    }
 }