Add stubs for mysqli and mysqli_result classes

phpstan · Sep 29, 2023 · e3023e0 · e3023e0
1 parent d25b897
commit e3023e0
Show file tree

Hide file tree

Showing 6 changed files with 75 additions and 3 deletions.
diff --git a/stubs/mysqli.stub b/stubs/mysqli.stub
@@ -1,8 +1,23 @@
 <?php
 
-class mysqli_stmt
+class mysqli
 {
+    /**
+     * @var int<-1,max>|numeric-string
+     */
+    public $affected_rows;
+}
 
+class mysqli_result
+{
+    /**
+     * @var int<0,max>|numeric-string
+     */
+    public $num_rows;
+}
+
+class mysqli_stmt
+{
     /**
      * @var int<-1,max>|numeric-string
      */

diff --git a/tests/PHPStan/Analyser/NodeScopeResolverTest.php b/tests/PHPStan/Analyser/NodeScopeResolverTest.php
@@ -1260,7 +1260,9 @@ public function dataFileAsserts(): iterable
 		yield from $this->gatherAssertTypes(__DIR__ . '/data/callsite-cast-narrowing.php');
 		yield from $this->gatherAssertTypes(__DIR__ . '/data/bug-8775.php');
 		yield from $this->gatherAssertTypes(__DIR__ . '/data/bug-8752.php');
-		yield from $this->gatherAssertTypes(__DIR__ . '/data/mysql-stmt.php');
+		yield from $this->gatherAssertTypes(__DIR__ . '/data/mysqli-affected-rows.php');
+		yield from $this->gatherAssertTypes(__DIR__ . '/data/mysqli-result-num-rows.php');
+		yield from $this->gatherAssertTypes(__DIR__ . '/data/mysqli-stmt-affected-rows-and-num-rows.php');
 		yield from $this->gatherAssertTypes(__DIR__ . '/data/list-shapes.php');
 		yield from $this->gatherAssertTypes(__DIR__ . '/data/bug-3013.php');
 		yield from $this->gatherAssertTypes(__DIR__ . '/data/bug-7607.php');

diff --git a/tests/PHPStan/Analyser/data/mysqli-affected-rows.php b/tests/PHPStan/Analyser/data/mysqli-affected-rows.php
@@ -0,0 +1,15 @@
+<?php
+
+namespace MySqlAffectedRowsType;
+
+use mysqli;
+use function PHPStan\Testing\assertType;
+
+final class Foo {
+	public function bar(): void
+	{
+		$mysqli = new mysqli();
+		$mysqli->query('UPDATE x SET y = 0;');
+		assertType('int<-1, max>|numeric-string', $mysqli->affected_rows);
+	}
+}
diff --git a/tests/PHPStan/Analyser/data/mysqli-result-num-rows.php b/tests/PHPStan/Analyser/data/mysqli-result-num-rows.php
@@ -0,0 +1,15 @@
+<?php
+
+namespace MySQLiResultNumRowsType;
+
+use mysqli;
+use function PHPStan\Testing\assertType;
+
+final class Foo {
+	public function bar(): void
+	{
+		$mysqli = new mysqli();
+		$mysqliResult = $mysqli->query('SELECT x FROM z;');
+		assertType('int<0, max>|numeric-string', $mysqliResult->num_rows);
+	}
+}
diff --git a/tests/PHPStan/Analyser/data/mysql-stmt.php → ...ysqli-stmt-affected-rows-and-num-rows.php b/tests/PHPStan/Analyser/data/mysql-stmt.php → ...ysqli-stmt-affected-rows-and-num-rows.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace MySQLiStmt;
+namespace MySQLiStmtAffectedRowsAndNumRowsTypes;
 
 use mysqli;
 use function PHPStan\Testing\assertType;

diff --git a/tests/PHPStan/Rules/Methods/data/returnTypes.php b/tests/PHPStan/Rules/Methods/data/returnTypes.php
@@ -1256,3 +1256,28 @@ public function doBaz3(): string
 	}
 
 }
+
+interface MySQLiAffectedRowsReturnTypeInterface
+{
+    /**
+     * @return int|numeric-string
+     */
+    function exec(\mysqli $connection, string $sql);
+}
+
+final class MySQLiAffectedRowsReturnType implements MySQLiAffectedRowsReturnTypeInterface
+{
+	/**
+     * @return int<0, max>|numeric-string
+     */
+    function exec(\mysqli $mysqli, string $sql)
+    {
+	    $result = $mysqli->query($sql);
+
+	    if ($result === false || 0 > $mysqli->affected_rows) {
+		    throw new \RuntimeException();
+	    }
+
+		return $mysqli->affected_rows;
+    }
+}