Changed signature for prepareStatementForSqlObject()

Removed unnecessary inline @var casts
Closes #115

Author: simon-mundy

src/RowGateway/AbstractRowGateway.php

@@ -8,7 +8,6 @@
 use Countable;
 // phpcs:ignore SlevomatCodingStandard.Namespaces.UnusedUses.UnusedUse
 use Override;
-use PhpDb\Adapter\Driver\StatementInterface;
 use PhpDb\Sql\Sql;
 use PhpDb\Sql\TableIdentifier;
 use ReturnTypeWillChange;
@@ -125,7 +124,6 @@ public function save(): int
                 }
             }
 
-            /** @var StatementInterface $statement */
             $statement    = $this->sql->prepareStatementForSqlObject($this->sql->update()->set($data)->where($where));
             $result       = $statement->execute();
             $rowsAffected = $result->getAffectedRows();
@@ -145,7 +143,6 @@ public function save(): int
             $insert = $this->sql->insert();
             $insert->values($this->data);
 
-            /** @var StatementInterface $statement */
             $statement = $this->sql->prepareStatementForSqlObject($insert);
 
             $result = $statement->execute();
@@ -166,7 +163,6 @@ public function save(): int
         }
 
         // refresh data
-        /** @var StatementInterface $statement */
         $statement = $this->sql->prepareStatementForSqlObject($this->sql->select()->where($where));
         $result    = $statement->execute();
         $rowData   = $result->current();
@@ -192,7 +188,6 @@ public function delete(): int
 
         // @todo determine if we need to do a select to ensure 1 row will be affected
 
-        /** @var StatementInterface $statement */
         $statement = $this->sql->prepareStatementForSqlObject($this->sql->delete()->where($where));
         $result    = $statement->execute();
 

src/Sql/Sql.php

@@ -6,7 +6,6 @@
 
 use PhpDb\Adapter\AdapterInterface;
 use PhpDb\Adapter\Driver\StatementInterface;
-use PhpDb\Adapter\StatementContainerInterface;
 
 use function sprintf;
 
@@ -109,11 +108,13 @@ public function prepareStatementForSqlObject(
         PreparableSqlInterface $sqlObject,
         ?StatementInterface $statement = null,
         ?AdapterInterface $adapter = null
-    ): ?StatementContainerInterface {
+    ): StatementInterface {
         $adapter   = $adapter ?: $this->adapter;
         $statement = $statement ?: $adapter->getDriver()->createStatement();
 
-        return $this->sqlPlatform->setSubject($sqlObject)->prepareStatement($adapter, $statement);
+        $this->sqlPlatform->setSubject($sqlObject)->prepareStatement($adapter, $statement);
+
+        return $statement;
     }
 
     /**

src/TableGateway/AbstractTableGateway.php

@@ -7,7 +7,6 @@
 use Closure;
 use Override;
 use PhpDb\Adapter\AdapterInterface;
-use PhpDb\Adapter\Driver\StatementInterface;
 use PhpDb\ResultSet\ResultSet;
 use PhpDb\ResultSet\ResultSetInterface;
 use PhpDb\Sql\Delete;
@@ -191,7 +190,6 @@ protected function executeSelect(Select $select): ResultSetInterface
         $this->featureSet->apply(EventFeatureEventsInterface::EVENT_PRE_SELECT, [$select]);
 
         // prepare and execute
-        /** @var StatementInterface $statement */
         $statement = $this->sql->prepareStatementForSqlObject($select);
         $result    = $statement->execute();
 
@@ -249,7 +247,6 @@ protected function executeInsert(Insert $insert): int
             $insert->into($unaliasedTable);
         }
 
-        /** @var StatementInterface $statement */
         $statement             = $this->sql->prepareStatementForSqlObject($insert);
         $result                = $statement->execute();
         $this->lastInsertValue = $this->adapter->getDriver()->getConnection()->getLastGeneratedValue();
@@ -322,7 +319,6 @@ protected function executeUpdate(Update $update): int
             $update->table($unaliasedTable);
         }
 
-        /** @var StatementInterface $statement */
         $statement = $this->sql->prepareStatementForSqlObject($update);
         $result    = $statement->execute();
 
@@ -381,7 +377,6 @@ protected function executeDelete(Delete $delete): int
             $delete->from($unaliasedTable);
         }
 
-        /** @var StatementInterface $statement */
         $statement = $this->sql->prepareStatementForSqlObject($delete);
         $result    = $statement->execute();
 

test/unit/Sql/AbstractSqlFunctionalTestCase.php

@@ -8,7 +8,6 @@
 use PhpDb\Adapter\Driver\DriverInterface;
 use PhpDb\Adapter\Driver\StatementInterface;
 use PhpDb\Adapter\ParameterContainer;
-use PhpDb\Adapter\StatementContainer;
 use PhpDb\Sql;
 use PhpDb\Sql\Ddl\Column\Column;
 use PhpDb\Sql\Ddl\CreateTable;
@@ -279,7 +278,6 @@ public function test(PreparableSqlInterface|SqlInterface $sqlObject, string $pla
 
         if (is_array($expected) && isset($expected['prepare'])) {
             self::assertInstanceOf(PreparableSqlInterface::class, $sqlObject);
-            /** @var StatementInterface|StatementContainer $actual */
             $actual = $sql->prepareStatementForSqlObject($sqlObject);
             self::assertEquals($expected['prepare'], $actual->getSql(), 'prepareStatement()');
             if (isset($expected['parameters'])) {