Merge pull request #7 from mpk-software/bugfix/driver-options

Allow passing the DSN by using `doctine.dbal.options.dsn` for symfony projects
zoilomora · Nov 23, 2020 · 95492eb · 95492eb
2 parents b5d4cbe + ce04c3d
commit 95492eb
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 26 deletions.
diff --git a/README.md b/README.md
@@ -25,7 +25,9 @@ Once the DSN is configured we will have to configure the connection in the follo
 $connection = \Doctrine\DBAL\DriverManager::getConnection(
     [
         'driverClass' => \ZoiloMora\Doctrine\DBAL\Driver\MicrosoftAccess\Driver::class,
-        'dsn' => 'name of the created dsn',
+        'driverOptions' => [
+            'dsn' => 'name of the created dsn',
+        ],
     ]
 );
 ```
@@ -47,8 +49,8 @@ configure the driver as follows:
 $connection = \Doctrine\DBAL\DriverManager::getConnection(
     [
         'driverClass' => \ZoiloMora\Doctrine\DBAL\Driver\MicrosoftAccess\Driver::class,
-        'dsn' => 'name of the created dsn',
         'driverOptions' => [
+            'dsn' => 'name of the created dsn',
             'charset' => 'UTF-8',
         ],
     ]

diff --git a/src/Doctrine/DBAL/Driver/MicrosoftAccess/Driver.php b/src/Doctrine/DBAL/Driver/MicrosoftAccess/Driver.php
@@ -3,9 +3,11 @@
 
 namespace ZoiloMora\Doctrine\DBAL\Driver\MicrosoftAccess;
 
+use Doctrine\DBAL\Connection;
 use Doctrine\DBAL\Exception;
 use Doctrine\DBAL\Platforms\AbstractPlatform;
 use Doctrine\DBAL\Schema\AbstractSchemaManager;
+use PDOException;
 use ZoiloMora\Doctrine\DBAL\Driver\MicrosoftAccess\PDO\Connection as PDOConnection;
 use ZoiloMora\Doctrine\DBAL\Driver\MicrosoftAccess\ODBC\Connection as ODBCConnection;
 use ZoiloMora\Doctrine\DBAL\Platforms\MicrosoftAccessPlatform;
@@ -21,19 +23,19 @@ public function connect(
         $password = null,
         array $driverOptions = []
     ): \Doctrine\DBAL\Driver\Connection {
-        $this->assertRequiredParameters($params);
+        $this->assertRequiredParameters($driverOptions);
 
         try {
             $conn = new PDOConnection(
-                $this->constructPdoDsn($params),
+                $this->constructPdoDsn($driverOptions),
                 $username,
                 $password,
                 $driverOptions,
             );
             $this->odbcConnection = new ODBCConnection(
-                $this->constructOdbcDsn($params),
+                $this->constructOdbcDsn($driverOptions),
             );
-        } catch (\PDOException $e) {
+        } catch (PDOException $e) {
             throw Exception::driverException($this, $e);
         }
 
@@ -45,7 +47,7 @@ public function getName(): string
         return 'pdo_msaccess';
     }
 
-    public function getDatabase(\Doctrine\DBAL\Connection $conn): string
+    public function getDatabase(Connection $conn): string
     {
         return 'unknown';
     }
@@ -55,37 +57,54 @@ public function getDatabasePlatform(): AbstractPlatform
         return new MicrosoftAccessPlatform();
     }
 
-    public function getSchemaManager(\Doctrine\DBAL\Connection $conn): AbstractSchemaManager
+    public function getSchemaManager(Connection $conn): AbstractSchemaManager
     {
         return new MicrosoftAccessSchemaManager($conn, $this->odbcConnection);
     }
 
-    private function assertRequiredParameters(array $params): void
+    /**
+     * @param array $driverOptions
+     * @throws \Exception
+     */
+    private function assertRequiredParameters(array $driverOptions): void
     {
-        if (false === \array_key_exists('dsn', $params)) {
-            throw new \Exception("The parameter 'dsn' is mandatory");
+        $dsn = $this->getDsn($driverOptions);
+
+        if ($dsn === null) {
+            throw new Exception\InvalidArgumentException("The driver option 'dsn' is mandatory");
         }
     }
 
-    protected function constructPdoDsn(array $params): string
+    /**
+     * Get the DSN for the PDO connection.
+     *
+     * @param array $driverOptions
+     * @return string
+     */
+    protected function constructPdoDsn(array $driverOptions): string
     {
-        $dsn = 'odbc:';
-
-        if (isset($params['dsn']) && '' !== $params['dsn']) {
-            return $dsn . $params['dsn'];
-        }
-
-        return $dsn;
+        return 'odbc:' . $this->getDsn($driverOptions);
     }
 
-    protected function constructOdbcDsn(array $params): string
+    /**
+     * Get the DSN for the ODBC connection.
+     *
+     * @param array $driverOptions
+     * @return string
+     */
+    protected function constructOdbcDsn(array $driverOptions): string
     {
-        $dsn = '';
-
-        if (isset($params['dsn']) && '' !== $params['dsn']) {
-            return $dsn . $params['dsn'];
-        }
+        return $this->getDsn($driverOptions);
+    }
 
-        return $dsn;
+    /**
+     * Get the DSN by the driver's parameters and options
+     *
+     * @param array $driverOptions
+     * @return string|null
+     */
+    private function getDsn(array $driverOptions): ?string
+    {
+        return $driverOptions['dsn'] ?? null;
     }
 }