Add database interface

src/Database/Database.php

@@ -13,19 +13,8 @@
 use Smile\GdprDump\Database\Metadata\MysqlMetadata;
 use UnexpectedValueException;
 
-/**
- * Wrapper that stores the following objects:
- * - connection: the Doctrine connection.
- * - driver: allows to retrieve the DSN that was used to connect to the database.
- * - metadata: allows to fetch the database metadata (table names, foreign key constraints).
- *
- * We use a custom abstraction layer for database metadata, because the Doctrine schema manager
- * crashes when used with databases that use custom Doctrine types (e.g. OroCommerce).
- */
-final class Database
+final class Database implements DatabaseInterface
 {
-    public const DRIVER_MYSQL = 'pdo_mysql';
-
     private Connection $connection;
     private DriverInterface $driver;
     private MetadataInterface $metadata;
@@ -53,31 +42,31 @@ public function __construct(array $connectionParams)
     }
 
     /**
-     * Get the doctrine connection.
+     * @inheritdoc
      */
     public function getConnection(): Connection
     {
         return $this->connection;
     }
 
     /**
-     * Get the database driver.
+     * @inheritdoc
      */
     public function getDriver(): DriverInterface
     {
         return $this->driver;
     }
 
     /**
-     * Get the database metadata.
+     * @inheritdoc
      */
     public function getMetadata(): MetadataInterface
     {
         return $this->metadata;
     }
 
     /**
-     * Get the connection parameters (host, port, user...).
+     * @inheritdoc
      */
     public function getConnectionParams(): ParameterBag
     {

src/Database/DatabaseInterface.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Smile\GdprDump\Database;
+
+use Doctrine\DBAL\Connection;
+use Smile\GdprDump\Database\Driver\DriverInterface;
+use Smile\GdprDump\Database\Metadata\MetadataInterface;
+
+/**
+ * Wrapper that stores the following objects:
+ * - connection: the Doctrine connection.
+ * - driver: allows to retrieve the DSN that was used to connect to the database.
+ * - metadata: allows to fetch the database metadata (table names, foreign key constraints).
+ *
+ * We use a custom abstraction layer for database metadata, because the Doctrine schema manager
+ * crashes when used with databases that use custom Doctrine types (e.g. OroCommerce).
+ */
+interface DatabaseInterface
+{
+    public const DRIVER_MYSQL = 'pdo_mysql';
+
+    /**
+     * Get the doctrine connection.
+     */
+    public function getConnection(): Connection;
+
+    /**
+     * Get the database driver.
+     */
+    public function getDriver(): DriverInterface;
+
+    /**
+     * Get the database metadata.
+     */
+    public function getMetadata(): MetadataInterface;
+
+    /**
+     * Get the connection parameters (host, port, user...).
+     */
+    public function getConnectionParams(): ParameterBag;
+}

src/Database/ParameterBag.php

@@ -10,7 +10,7 @@ final class ParameterBag
 {
     private array $params;
     private array $defaults = [
-        Database::DRIVER_MYSQL => ['host' => 'localhost', 'user' => 'root'],
+        DatabaseInterface::DRIVER_MYSQL => ['host' => 'localhost', 'user' => 'root'],
     ];
 
     /**
@@ -52,7 +52,7 @@ private function prepareParams(array $params): array
 
         // Set the driver
         if (!isset($params['driver'])) {
-            $params['driver'] = Database::DRIVER_MYSQL;
+            $params['driver'] = DatabaseInterface::DRIVER_MYSQL;
         }
 
         if (isset($this->defaults[$params['driver']])) {

src/Dumper/Event/DumpEvent.php

@@ -5,7 +5,7 @@
 namespace Smile\GdprDump\Dumper\Event;
 
 use Druidfi\Mysqldump\Mysqldump;
-use Smile\GdprDump\Database\Database;
+use Smile\GdprDump\Database\DatabaseInterface;
 use Smile\GdprDump\Dumper\Config\DumperConfigInterface;
 use Symfony\Contracts\EventDispatcher\Event;
 
@@ -16,7 +16,7 @@ final class DumpEvent extends Event
 {
     public function __construct(
         private Mysqldump $dumper,
-        private Database $database,
+        private DatabaseInterface $database,
         private DumperConfigInterface $config,
         private array $context
     ) {
@@ -33,7 +33,7 @@ public function getConfig(): DumperConfigInterface
     /**
      * Get the database wrapper.
      */
-    public function getDatabase(): Database
+    public function getDatabase(): DatabaseInterface
     {
         return $this->database;
     }