Improve type definitions for scalar query params

Author: clue

README.md

@@ -202,7 +202,7 @@ given event loop instance.
 
 #### query()
 
-The `query(string $query, array $params = []): PromiseInterface<MysqlResult>` method can be used to
+The `query(string $query, list<string|int|float|bool|null> $params = []): PromiseInterface<MysqlResult>` method can be used to
 perform an async query.
 
 This method returns a promise that will resolve with a `MysqlResult` on
@@ -258,7 +258,7 @@ suited for exposing multiple possible results.
 
 #### queryStream()
 
-The `queryStream(string $sql, array $params = []): ReadableStreamInterface` method can be used to
+The `queryStream(string $sql, list<string|int|float|bool|null> $params = []): ReadableStreamInterface` method can be used to
 perform an async query and stream the rows of the result set.
 
 This method returns a readable stream that will emit each row of the

src/Io/Query.php

@@ -49,17 +49,9 @@ public function __construct($sql)
     /**
      * Binding params for the query, multiple arguments support.
      *
-     * @param  mixed              $param
-     * @return self
+     * @param list<string|int|float|bool|null> $params
+     * @return $this
      */
-    public function bindParams()
-    {
-        $this->builtSql = null;
-        $this->params   = func_get_args();
-
-        return $this;
-    }
-
     public function bindParamsFromArray(array $params)
     {
         $this->builtSql = null;
@@ -68,21 +60,6 @@ public function bindParamsFromArray(array $params)
         return $this;
     }
 
-    /**
-     * Binding params for the query, multiple arguments support.
-     *
-     * @param  mixed              $param
-     * @return self
-     *                                  @deprecated
-     */
-    public function params()
-    {
-        $this->params   = func_get_args();
-        $this->builtSql = null;
-
-        return $this;
-    }
-
     public function escape($str)
     {
         return strtr($str, $this->escapeChars);
@@ -105,13 +82,6 @@ protected function resolveValueForSql($value)
             case 'string':
                 $value = "'" . $this->escape($value) . "'";
                 break;
-            case 'array':
-                $nvalue = [];
-                foreach ($value as $v) {
-                    $nvalue[] = $this->resolveValueForSql($v);
-                }
-                $value = implode(',', $nvalue);
-                break;
             case 'NULL':
                 $value = 'NULL';
                 break;

src/MysqlClient.php

@@ -152,8 +152,8 @@ public function __construct(
      * could allow for possible SQL injection attacks and this API is not
      * suited for exposing multiple possible results.
      *
-     * @param string $sql    SQL statement
-     * @param array  $params Parameters which should be bound to query
+     * @param string $sql SQL statement
+     * @param list<string|int|float|bool|null> $params Parameters which should be bound to query
      * @return PromiseInterface<MysqlResult>
      *     Resolves with a `MysqlResult` on success or rejects with an `Exception` on error.
      */
@@ -229,11 +229,11 @@ public function query($sql, array $params = [])
      * could allow for possible SQL injection attacks and this API is not
      * suited for exposing multiple possible results.
      *
-     * @param string $sql    SQL statement
-     * @param array  $params Parameters which should be bound to query
+     * @param string $sql SQL statement
+     * @param list<string|int|float|bool|null> $params Parameters which should be bound to query
      * @return ReadableStreamInterface
      */
-    public function queryStream($sql, $params = [])
+    public function queryStream($sql, array $params = [])
     {
         if ($this->closed || $this->quitting) {
             throw new Exception('Connection closed');

tests/Io/QueryTest.php

@@ -10,48 +10,48 @@ class QueryTest extends TestCase
     public function testBindParams()
     {
         $query = new Query('select * from test where id = ? and name = ?');
-        $sql   = $query->bindParams(100, 'test')->getSql();
+        $sql   = $query->bindParamsFromArray([100, 'test'])->getSql();
         $this->assertEquals("select * from test where id = 100 and name = 'test'", $sql);
 
-        $query = new Query('select * from test where id in (?) and name = ?');
-        $sql   = $query->bindParams([1, 2], 'test')->getSql();
+        $query = new Query('select * from test where id in (?,?) and name = ?');
+        $sql   = $query->bindParamsFromArray([1, 2, 'test'])->getSql();
         $this->assertEquals("select * from test where id in (1,2) and name = 'test'", $sql);
         /*
         $query = new Query('select * from test where id = :id and name = :name');
-        $sql   = $query->params([':id' => 100, ':name' => 'test'])->getSql();
+        $sql   = $query->bindParamsFromArray([':id' => 100, ':name' => 'test'])->getSql();
         $this->assertEquals("select * from test where id = 100 and name = 'test'", $sql);
 
         $query = new Query('select * from test where id = :id and name = ?');
-        $sql   = $query->params('test', [':id' => 100])->getSql();
+        $sql   = $query->bindParamsFromArray(['test', ':id' => 100])->getSql();
         $this->assertEquals("select * from test where id = 100 and name = 'test'", $sql);
         */
     }
 
     public function testGetSqlReturnsQuestionMarkReplacedWhenBound()
     {
         $query = new Query('select ?');
-        $sql   = $query->bindParams('hello')->getSql();
+        $sql   = $query->bindParamsFromArray(['hello'])->getSql();
         $this->assertEquals("select 'hello'", $sql);
     }
 
     public function testGetSqlReturnsQuestionMarkReplacedWhenBoundFromLastCall()
     {
         $query = new Query('select ?');
-        $sql   = $query->bindParams('foo')->bindParams('bar')->getSql();
+        $sql   = $query->bindParamsFromArray(['foo'])->bindParamsFromArray(['bar'])->getSql();
         $this->assertEquals("select 'bar'", $sql);
     }
 
     public function testGetSqlReturnsQuestionMarkReplacedWithNullValueWhenBound()
     {
         $query = new Query('select ?');
-        $sql   = $query->bindParams(null)->getSql();
+        $sql   = $query->bindParamsFromArray([null])->getSql();
         $this->assertEquals("select NULL", $sql);
     }
 
     public function testGetSqlReturnsQuestionMarkReplacedFromBoundWhenBound()
     {
         $query = new Query('select CONCAT(?, ?)');
-        $sql   = $query->bindParams('hello??', 'world??')->getSql();
+        $sql   = $query->bindParamsFromArray(['hello??', 'world??'])->getSql();
         $this->assertEquals("select CONCAT('hello??', 'world??')", $sql);
     }