no issue - introduce the BridgeFactory

Author: pounard

CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## Next
+
+* [feature] ⭐️ Add `MakinaCorpus\QueryBuilder\BridgeFactory` for creating
+  standalone connections.
+* [deprecation] ⚠️ Renamed `MakinaCorpus\QueryBuilder\Bridge\Doctrine\DoctrineQueryBuilder`
+  to `MakinaCorpus\QueryBuilder\Bridge\Doctrine\DoctrineBridge`.
+* [deprecation] ⚠️ Renamed `MakinaCorpus\QueryBuilder\Bridge\Pdo\PdoQueryBuilder`
+  to `MakinaCorpus\QueryBuilder\Bridge\Pdo\PdoBridge`.
+
 ## 1.5.5
 
 * [fix] Handle `mysqli` in `Dsn` class.

docs/content/bridges/error.md

@@ -35,10 +35,10 @@ call the `Bridge::disableErrorConverter()` method when initializing the bridge:
 
 ```php
 use Doctrine\DBAL\DriverManager;
-use MakinaCorpus\QueryBuilder\Bridge\Doctrine\DoctrineQueryBuilder;
+use MakinaCorpus\QueryBuilder\Bridge\Doctrine\DoctrineBridge;
 
 $connection = DriverManager::getConnection(['driver' => 'pdo_pgsql', /* ... */]);
-$bridge = new DoctrineQueryBuilder($connection);
+$bridge = new DoctrineBridge($connection);
 
 // Here it is:
 $bridge->disableErrorConverter();

docs/content/introduction/getting-started.md

@@ -116,7 +116,7 @@ Setting it up is easier than standalone setup:
 
 ```php
 use Doctrine\DBAL\DriverManager;
-use MakinaCorpus\QueryBuilder\Bridge\Doctrine\DoctrineQueryBuilder;
+use MakinaCorpus\QueryBuilder\Bridge\Doctrine\DoctrineBridge;
 use MakinaCorpus\QueryBuilder\DatabaseSession;
 
 // Create or fetch your doctrine/dbal connection.
@@ -126,7 +126,7 @@ $connection = DriverManager::getConnection([
 ]);
 
 // Create the query builder.
-$session = new DoctrineQueryBuilder($connection);
+$session = new DoctrineBridge($connection);
 \assert($session instanceof DatabaseSession);
 ```
 
@@ -189,14 +189,14 @@ composer require makinacorpus/query-builder
 Setting it up is easier than standalone setup:
 
 ```php
-use MakinaCorpus\QueryBuilder\Bridge\Pdo\PdoQueryBuilder;
+use MakinaCorpus\QueryBuilder\Bridge\Pdo\PdoBridge;
 use MakinaCorpus\QueryBuilder\DatabaseSession;
 
 // Create or fetch your PDO connection.
 $connection = new \PDO('pgsql:...');
 
 // User facade for you to build SQL queries.
-$session = new PdoQueryBuilder($connection);
+$session = new PdoBridge($connection);
 \assert($session instanceof DatabaseSession);
 ```
 

docs/content/query/result.md

@@ -22,9 +22,9 @@ you can call `Query::executeQuery()` over your queries, for example:
 
 ```php
 use Doctrine\DBAL\DriverManager;
-use MakinaCorpus\QueryBuilder\Bridge\Doctrine\DoctrineQueryBuilder;
+use MakinaCorpus\QueryBuilder\Bridge\Doctrine\DoctrineBridge;
 
-$session = new DoctrineQueryBuilder(
+$session = new DoctrineBridge(
     DriverManager::getConnection([
         'driver' => 'pdo_pgsql',
         // ... driver options.
@@ -46,9 +46,9 @@ You may also directly execute raw SQL code as such:
 
 ```php
 use Doctrine\DBAL\DriverManager;
-use MakinaCorpus\QueryBuilder\Bridge\Doctrine\DoctrineQueryBuilder;
+use MakinaCorpus\QueryBuilder\Bridge\Doctrine\DoctrineBridge;
 
-$session = new DoctrineQueryBuilder(
+$session = new DoctrineBridge(
     DriverManager::getConnection([
         'driver' => 'pdo_pgsql',
         // ... driver options.
@@ -79,10 +79,10 @@ instances:
 
 ```php
 use Doctrine\DBAL\DriverManager;
-use MakinaCorpus\QueryBuilder\Bridge\Doctrine\DoctrineQueryBuilder;
+use MakinaCorpus\QueryBuilder\Bridge\Doctrine\DoctrineBridge;
 use MakinaCorpus\QueryBuilder\Result\ResultRow;
 
-$session = new DoctrineQueryBuilder(
+$session = new DoctrineBridge(
     DriverManager::getConnection([
         'driver' => 'pdo_pgsql',
         // ... driver options.

src/Bridge/Doctrine/DoctrineBridge.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MakinaCorpus\QueryBuilder\Bridge\Doctrine;
+
+class DoctrineBridge extends DoctrineQueryBuilder
+{
+}

src/Bridge/Doctrine/DoctrineQueryBuilder.php

@@ -17,6 +17,10 @@
 use MakinaCorpus\QueryBuilder\Vendor;
 use MakinaCorpus\QueryBuilder\Writer\Writer;
 
+/**
+ * @deprecated This will be removed in 2.0, use DoctrineBridge instead.
+ * @see DoctrineBridge
+ */
 class DoctrineQueryBuilder extends AbstractBridge
 {
     private Connection $connection;
@@ -28,6 +32,10 @@ public function __construct(
         parent::__construct();
 
         $this->connection = $connection;
+
+        if (static::class === self::class) {
+            @\trigger_error(\sprintf("Class '%s' is deprecated and will be removed in 2.0, use '%s' instead.", DoctrineQueryBuilder::class, DoctrineBridge::class));
+        }
     }
 
     /**

src/Bridge/Pdo/PdoBridge.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MakinaCorpus\QueryBuilder\Bridge\Pdo;
+
+class PdoBridge extends PdoQueryBuilder
+{
+}

src/Bridge/Pdo/PdoQueryBuilder.php

@@ -20,6 +20,10 @@
 use MakinaCorpus\QueryBuilder\Result\Result;
 use MakinaCorpus\QueryBuilder\Vendor;
 
+/**
+ * @deprecated This will be removed in 2.0, use PdoBridge instead.
+ * @see PdoBridge
+ */
 class PdoQueryBuilder extends AbstractBridge
 {
     private ?\PDO $connection = null;
@@ -30,6 +34,10 @@ public function __construct(
         parent::__construct();
 
         $this->connection = $connection;
+
+        if (static::class === self::class) {
+            @\trigger_error(\sprintf("Class '%s' is deprecated and will be removed in 2.0, use '%s' instead.", PdoQueryBuilder::class, PdoBridge::class));
+        }
     }
 
     /**