From ec6bc9aaaf650972c86ed1841cdbed17508e1eba Mon Sep 17 00:00:00 2001
From: Jan-Niclas Loosen <mail@jnloos.de>
Date: Mon, 27 Jan 2025 19:35:17 +0100
Subject: [PATCH] rename and add interfaces

---
 Database.php                                  | 44 +++++++++++++++++++
 enums/CascadeTypes.php                        | 21 +++++++++
 enums/CharsetTypes.php                        | 23 ++++++++++
 enums/CollationTypes.php                      | 24 ++++++++++
 enums/ColumnTypes.php                         | 34 ++++++++++++++
 enums/EngineTypes.php                         | 15 +++++++
 .../DatabaseHelper.php                        | 33 +++++++-------
 .../InsertionBuilder.php                      |  2 +-
 .../MigrationBlueprint.php                    |  2 +-
 .../Update.php => interfaces/QueryBuilder.php |  2 +-
 interfaces/TableBlueprint.php                 | 17 +++++++
 .../UpdateBuilder.php                         |  2 +-
 src/interfaces/Table.php                      |  8 ----
 testing.php                                   |  1 +
 14 files changed, 199 insertions(+), 29 deletions(-)
 create mode 100644 Database.php
 create mode 100644 enums/CascadeTypes.php
 create mode 100644 enums/CharsetTypes.php
 create mode 100644 enums/CollationTypes.php
 create mode 100644 enums/ColumnTypes.php
 create mode 100644 enums/EngineTypes.php
 rename src/interfaces/Database.php => interfaces/DatabaseHelper.php (57%)
 rename src/interfaces/Migration.php => interfaces/InsertionBuilder.php (74%)
 rename src/interfaces/Query.php => interfaces/MigrationBlueprint.php (73%)
 rename src/interfaces/Update.php => interfaces/QueryBuilder.php (77%)
 create mode 100644 interfaces/TableBlueprint.php
 rename src/interfaces/Insertion.php => interfaces/UpdateBuilder.php (76%)
 delete mode 100644 src/interfaces/Table.php
 create mode 100644 testing.php

diff --git a/Database.php b/Database.php
new file mode 100644
index 0000000..27ab225
--- /dev/null
+++ b/Database.php
@@ -0,0 +1,44 @@
+<?php
+namespace DatabaseHelper;
+
+use DatabaseHelper\interfaces\MigrationBlueprint;
+use DatabaseHelper\interfaces\QueryBuilder;
+use DatabaseHelper\interfaces\TableBlueprint;
+use DatabaseHelper\interfaces\UpdateBuilder;
+
+class Database implements interfaces\DatabaseHelper
+{
+    public static function makeTable(string $tableName): TableBlueprint
+    {
+        // TODO: Implement makeTable() method.
+    }
+
+    public static function makeMigration(TableBlueprint $table): MigrationBlueprint
+    {
+        // TODO: Implement makeMigration() method.
+    }
+
+    public static function makeQuery(TableBlueprint ...$tables): QueryBuilder
+    {
+        // TODO: Implement makeQuery() method.
+    }
+
+    public static function makeInsertion(TableBlueprint ...$tables): QueryBuilder
+    {
+        // TODO: Implement makeInsertion() method.
+    }
+
+    public static function makeUpdate(TableBlueprint ...$tables): UpdateBuilder
+    {
+        // TODO: Implement makeUpdate() method.
+    }
+
+    public static function standardizeTableNames(string &...$tableName): void {
+        global $wpdb;
+        $dbPrefix = $wpdb->prefix;
+
+        foreach ($tableName as &$name)
+            if (!str_starts_with($name, $dbPrefix))
+                $name = $dbPrefix . $name;
+    }
+}
\ No newline at end of file
diff --git a/enums/CascadeTypes.php b/enums/CascadeTypes.php
new file mode 100644
index 0000000..f8f50f0
--- /dev/null
+++ b/enums/CascadeTypes.php
@@ -0,0 +1,21 @@
+<?php
+namespace DatabaseHelper\enums;
+
+enum CascadeTypes
+{
+    case CASCADE;
+    case SET_NULL;
+    case NO_ACTION;
+    case RESTRICT;
+    case SET_DEFAULT;
+
+    public function type(): string {
+        return match ($this) {
+            self::CASCADE => 'CASCADE',
+            self::SET_NULL => 'SET NULL',
+            self::NO_ACTION => 'NO ACTION',
+            self::RESTRICT => 'RESTRICT',
+            self::SET_DEFAULT => 'SET DEFAULT',
+        };
+    }
+}
\ No newline at end of file
diff --git a/enums/CharsetTypes.php b/enums/CharsetTypes.php
new file mode 100644
index 0000000..5781a66
--- /dev/null
+++ b/enums/CharsetTypes.php
@@ -0,0 +1,23 @@
+<?php
+namespace DatabaseHelper\enums;
+
+enum CharsetTypes
+{
+    case UTF8;
+    case UTF8MB4;
+    case LATIN1;
+    case ASCII;
+    case UTF16;
+    case UTF32;
+
+    public function type(): string {
+        return match ($this) {
+            self::UTF8 => 'utf8',
+            self::UTF8MB4 => 'utf8mb4',
+            self::LATIN1 => 'latin1',
+            self::ASCII => 'ascii',
+            self::UTF16 => 'utf16',
+            self::UTF32 => 'utf32',
+        };
+    }
+}
diff --git a/enums/CollationTypes.php b/enums/CollationTypes.php
new file mode 100644
index 0000000..32cf020
--- /dev/null
+++ b/enums/CollationTypes.php
@@ -0,0 +1,24 @@
+<?php
+
+namespace DatabaseHelper\enums;
+
+enum CollationTypes
+{
+    case UTF8_GENERAL_CI;
+    case UTF8MB4_UNICODE_CI;
+    case LATIN1_SWEDISH_CI;
+    case UTF8MB4_BIN;
+    case UTF8_BIN;
+    case UTF8_GENERAL_BIN;
+
+    public function type(): string {
+        return match ($this) {
+            self::UTF8_GENERAL_CI => 'utf8_general_ci',
+            self::UTF8MB4_UNICODE_CI => 'utf8mb4_unicode_ci',
+            self::LATIN1_SWEDISH_CI => 'latin1_swedish_ci',
+            self::UTF8MB4_BIN => 'utf8mb4_bin',
+            self::UTF8_BIN => 'utf8_bin',
+            self::UTF8_GENERAL_BIN => 'utf8_general_bin',
+        };
+    }
+}
diff --git a/enums/ColumnTypes.php b/enums/ColumnTypes.php
new file mode 100644
index 0000000..d098897
--- /dev/null
+++ b/enums/ColumnTypes.php
@@ -0,0 +1,34 @@
+<?php
+namespace DatabaseHelper\enums;
+
+enum ColumnTypes
+{
+    case INT;
+    case FLOAT;
+    case STRING;
+    case BOOL;
+    case ARRAY;
+    case DATE;
+
+    public function cast(mixed $value): mixed {
+        return match ($this) {
+            self::INT => (int) $value,
+            self::FLOAT => (float) $value,
+            self::STRING => (string) $value,
+            self::BOOL => (bool) $value,
+            self::ARRAY => is_array($value) ? $value : json_decode($value, true),
+            self::DATE => $value instanceof \DateTime ? $value : new \DateTime($value),
+        };
+    }
+
+    public function type(): string {
+        return match ($this) {
+            self::INT => 'INTEGER',
+            self::FLOAT => 'FLOAT',
+            self::STRING => 'VARCHAR(255)',
+            self::BOOL => 'BOOLEAN',
+            self::ARRAY => 'JSON',
+            self::DATE => 'DATETIME',
+        };
+    }
+}
diff --git a/enums/EngineTypes.php b/enums/EngineTypes.php
new file mode 100644
index 0000000..1f6293b
--- /dev/null
+++ b/enums/EngineTypes.php
@@ -0,0 +1,15 @@
+<?php
+namespace DatabaseHelper\enums;
+
+enum EngineTypes
+{
+    case INNODB;
+    case MYISAM;
+
+    public function type(): string {
+        return match ($this) {
+            self::INNODB => 'InnoDB',
+            self::MYISAM => 'MyISAM',
+        };
+    }
+}
\ No newline at end of file
diff --git a/src/interfaces/Database.php b/interfaces/DatabaseHelper.php
similarity index 57%
rename from src/interfaces/Database.php
rename to interfaces/DatabaseHelper.php
index ef2546f..fcbf2ab 100644
--- a/src/interfaces/Database.php
+++ b/interfaces/DatabaseHelper.php
@@ -1,51 +1,51 @@
 <?php
 namespace DatabaseHelper\interfaces;
 
-interface Database
+interface DatabaseHelper
 {
     /**
      * Initializes a Table instance to represent a database table.
      * This instance can be used to define and finalĺy create database tables.
      *
      * @param string $tableName The name of the table.
-     * @return Table Generated Table instance.
+     * @return TableBlueprint Generated Table instance.
      */
-    public static function makeTable(string $tableName): Table;
+    public static function makeTable(string $tableName): TableBlueprint;
 
     /**
      * Initializes a Migration instance for managing database migrations for the specified table.
      *
-     * @param Table $table The table for which the migration is being created.
-     * @return Migration Generated Migration instance.
+     * @param TableBlueprint $table The table for which the migration is being created.
+     * @return MigrationBlueprint Generated Migration instance.
      */
-    public static function makeMigration(Table $table): Migration;
+    public static function makeMigration(TableBlueprint $table): MigrationBlueprint;
 
     /**
      * Initializes a Query instance to perform operations on the specified tables.
      * When multiple tables are provided, they will be joined automatically for the query.
      *
-     * @param Table ...$tables One or more Table instances.
-     * @return Query Generated Query instance.
+     * @param TableBlueprint ...$tables One or more Table instances.
+     * @return QueryBuilder Generated Query instance.
      */
-    public static function makeQuery(Table ...$tables): Query;
+    public static function makeQuery(TableBlueprint ...$tables): QueryBuilder;
 
     /**
      * Initializes a Query instance specifically for inserting data into the specified tables.
      * When multiple tables are provided, they will be joined automatically for the insertion.
      *
-     * @param Table ...$tables One or more Table instances.
-     * @return Query Generated Query instance.
+     * @param TableBlueprint ...$tables One or more Table instances.
+     * @return QueryBuilder Generated Query instance.
      */
-    public static function makeInsertion(Table ...$tables): Query;
+    public static function makeInsertion(TableBlueprint ...$tables): QueryBuilder;
 
     /**
      * Initializes an Update instance to perform updates on the specified tables.
      * When multiple tables are provided, they will be joined automatically.
      *
-     * @param Table ...$tables One or more Table instances.
-     * @return Update Generated Update instance.
+     * @param TableBlueprint ...$tables One or more Table instances.
+     * @return UpdateBuilder Generated Update instance.
      */
-    public static function makeUpdate(Table ...$tables): Update;
+    public static function makeUpdate(TableBlueprint ...$tables): UpdateBuilder;
 
     /**
      * Standardizes table names by ensuring they include the WordPress database prefix.
@@ -54,6 +54,5 @@ interface Database
      *
      * @param string &...$tableName The table names to standardize.
      */
-    public static function standardizeTableNames(string &...$tableName): string;
-
+    public static function standardizeTableNames(string &...$tableName): void;
 }
diff --git a/src/interfaces/Migration.php b/interfaces/InsertionBuilder.php
similarity index 74%
rename from src/interfaces/Migration.php
rename to interfaces/InsertionBuilder.php
index 7e0e5d5..ff77d2c 100644
--- a/src/interfaces/Migration.php
+++ b/interfaces/InsertionBuilder.php
@@ -2,7 +2,7 @@
 
 namespace DatabaseHelper\interfaces;
 
-interface Migration
+interface InsertionBuilder
 {
     public function exec() : array;
 }
\ No newline at end of file
diff --git a/src/interfaces/Query.php b/interfaces/MigrationBlueprint.php
similarity index 73%
rename from src/interfaces/Query.php
rename to interfaces/MigrationBlueprint.php
index a6965be..35c5d0c 100644
--- a/src/interfaces/Query.php
+++ b/interfaces/MigrationBlueprint.php
@@ -2,7 +2,7 @@
 
 namespace DatabaseHelper\interfaces;
 
-interface Query
+interface MigrationBlueprint
 {
     public function exec() : array;
 }
\ No newline at end of file
diff --git a/src/interfaces/Update.php b/interfaces/QueryBuilder.php
similarity index 77%
rename from src/interfaces/Update.php
rename to interfaces/QueryBuilder.php
index 00499d1..a5479b6 100644
--- a/src/interfaces/Update.php
+++ b/interfaces/QueryBuilder.php
@@ -2,7 +2,7 @@
 
 namespace DatabaseHelper\interfaces;
 
-interface Update
+interface QueryBuilder
 {
     public function exec() : array;
 }
\ No newline at end of file
diff --git a/interfaces/TableBlueprint.php b/interfaces/TableBlueprint.php
new file mode 100644
index 0000000..5b2d9d9
--- /dev/null
+++ b/interfaces/TableBlueprint.php
@@ -0,0 +1,17 @@
+<?php
+namespace DatabaseHelper\interfaces;
+use DatabaseHelper\enums\CascadeTypes;
+use DatabaseHelper\enums\ColumnTypes;
+
+interface TableBlueprint
+{
+    public function column(string $name, ColumnTypes $type, mixed $default = null, bool $nullable = false, bool $unique = false): TableBlueprint;
+
+    public function primaryKey(string $colName, bool $autoIncrement = false): TableBlueprint;
+
+    public function foreignKey(string $colName, TableBlueprint $foreignTable, CascadeTypes $cascade): TableBlueprint;
+
+
+
+    public function exec() : void;
+}
\ No newline at end of file
diff --git a/src/interfaces/Insertion.php b/interfaces/UpdateBuilder.php
similarity index 76%
rename from src/interfaces/Insertion.php
rename to interfaces/UpdateBuilder.php
index 4aff2fe..3b50156 100644
--- a/src/interfaces/Insertion.php
+++ b/interfaces/UpdateBuilder.php
@@ -2,7 +2,7 @@
 
 namespace DatabaseHelper\interfaces;
 
-interface Insertion
+interface UpdateBuilder
 {
     public function exec() : array;
 }
\ No newline at end of file
diff --git a/src/interfaces/Table.php b/src/interfaces/Table.php
deleted file mode 100644
index c00f9d9..0000000
--- a/src/interfaces/Table.php
+++ /dev/null
@@ -1,8 +0,0 @@
-<?php
-
-namespace DatabaseHelper\interfaces;
-
-interface Table
-{
-    public function exec() : void;
-}
\ No newline at end of file
diff --git a/testing.php b/testing.php
new file mode 100644
index 0000000..b3d9bbc
--- /dev/null
+++ b/testing.php
@@ -0,0 +1 @@
+<?php