Added interface ResultInterface that all database providers use as …

…return type for queries

CHANGELOG.md

@@ -11,6 +11,7 @@ Types of changes: `Added`, `Changed`, `Deprecate`, `Removed`, `Fixed`, `Secruity
 ### Added
 - Added class `CreateTableBlueprint` to create statements for generating tables in MySQL/MariaDB and SQLite
 - Added test mode to class `Config` so env values can be changed in test runs
+- Added interface `ResultInterface` that all database providers use as return type for queries
 
 ## v2.5.0 - 17.03.2024 - Added statistic for amount and price development
 

framework/Database/Database.php

@@ -3,15 +3,13 @@
 namespace Framework\Database;
 
 use Framework\Config\Config;
-use Framework\Config\ConfigReader;
-use mysqli_result;
 
 class Database
 {
     private static ?MariaDB $mariaDB = null;
 
     /** Execute the SQL generated by the given query build */
-    public static function executeBuilder(QueryBuilder|WhereQueryBuilder $queryBuilder): mysqli_result|bool
+    public static function executeBuilder(QueryBuilder|WhereQueryBuilder $queryBuilder): ResultInterface|bool
     {
         if ($queryBuilder->isWhereEmpty()) {
             return self::unprepared($queryBuilder->build());
@@ -24,8 +22,20 @@ public static function executeBuilder(QueryBuilder|WhereQueryBuilder $queryBuild
         }
     }
 
+    public static function executeBlueprint(BlueprintInterface $blueprint): ResultInterface|bool
+    {
+        $result = false;
+        foreach ($blueprint->build() as $sql) {
+            $result = self::unprepared($sql);
+            if ($result === false) {
+                return false;
+            }
+        }
+        return $result;
+    }
+
     /** Execute the given unprepared query. You should try to avoid unprepared statements if they contain user input! */
-    public static function unprepared(string $query): mysqli_result|bool
+    public static function unprepared(string $query): ResultInterface|bool
     {
         self::getMariaDb();
         self::$mariaDB->connect();
@@ -34,8 +44,12 @@ public static function unprepared(string $query): mysqli_result|bool
         return $result;
     }
 
-    /** Execute the given prepared statement */
-    public static function prepared(string $query, string $colTypes, ...$values): mysqli_result|bool
+    /**
+     * Execute the given prepared statement
+     * 
+     * @param string $colTypes i = int, d = float, s = string
+    */
+    public static function prepared(string $query, string $colTypes, ...$values): ResultInterface|bool
     {
         self::getMariaDb();
         self::$mariaDB->connect();

framework/Database/DatabaseInterface.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Framework\Database;
+
+interface DatabaseInterface
+{
+    /** Open connection to the DB */
+    public function connect(): void;
+
+    /** Close the open connection */
+    public function disconnect(): void;
+
+    /** Execute the given query */
+    public function unprepared(string $query): ResultInterface|false;
+
+    /** Execute the given prepared statement */
+    public function prepared(string $query, string $colTypes, ...$values): ResultInterface|false;
+}

framework/Database/MariaDB.php

@@ -6,9 +6,9 @@
 use mysqli_result;
 
 /** This class simplifies the connection to MariaDB and executing queries. */
-class MariaDB
+class MariaDB implements DatabaseInterface
 {
-    private ?mysqli $mysqli;
+    private ?mysqli $mysqli = null;
 
     public function __construct(
         private string $host,
@@ -43,17 +43,17 @@ public function disconnect(): void
     }
 
     /** Execute the given query */
-    public function unprepared(string $query): mysqli_result|bool
+    public function unprepared(string $query): ResultInterface|false
     {
         if ($this->mysqli === null) {
             return false;
         }
 
-        return $this->mysqli->query($query);
+        return new MariaDbResult($this->mysqli->query($query));
     }
 
     /** Execute the given prepared statement */
-    public function prepared(string $query, string $colTypes, ...$values): mysqli_result|bool
+    public function prepared(string $query, string $colTypes, ...$values): ResultInterface|false
     {
         $stmt = $this->mysqli->prepare($query);
         if ($stmt === false) {
@@ -65,6 +65,6 @@ public function prepared(string $query, string $colTypes, ...$values): mysqli_re
             return false;
         }
 
-        return $stmt->get_result();
+        return new MariaDbResult($stmt->get_result());
     }
 }

framework/Database/MariaDbResult.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Framework\Database;
+
+use mysqli_result;
+
+class MariaDbResult implements ResultInterface
+{
+    public function __construct(
+        private mysqli_result|false $result,
+    ) {
+    }
+
+    public function fetch(): array|false
+    {
+        if ($this->result === false) {
+            return false;
+        }
+
+        $row = $this->result->fetch_assoc();
+        if ($row === null) {
+            return false;
+        }
+        return $row;
+    }
+}

framework/Database/ResultInterface.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Framework\Database;
+
+interface ResultInterface
+{
+    public function fetch(): array|false;
+}