From c79064000962f77dce657654482cc1cf778f2c40 Mon Sep 17 00:00:00 2001
From: Sergei Morozov <morozov@tut.by>
Date: Thu, 11 Jun 2020 19:34:05 -0700
Subject: [PATCH] Deprecate Driver::getDatabase()

---
 UPGRADE.md                                             | 5 +++++
 lib/Doctrine/DBAL/Driver.php                           | 2 ++
 lib/Doctrine/DBAL/Driver/AbstractDB2Driver.php         | 2 ++
 lib/Doctrine/DBAL/Driver/AbstractMySQLDriver.php       | 2 ++
 lib/Doctrine/DBAL/Driver/AbstractOracleDriver.php      | 2 ++
 lib/Doctrine/DBAL/Driver/AbstractPostgreSQLDriver.php  | 2 ++
 lib/Doctrine/DBAL/Driver/AbstractSQLAnywhereDriver.php | 2 ++
 lib/Doctrine/DBAL/Driver/AbstractSQLServerDriver.php   | 2 ++
 lib/Doctrine/DBAL/Driver/AbstractSQLiteDriver.php      | 2 ++
 9 files changed, 21 insertions(+)

diff --git a/UPGRADE.md b/UPGRADE.md
index 916603a0e46..8dbab7d54a3 100644
--- a/UPGRADE.md
+++ b/UPGRADE.md
@@ -1,5 +1,10 @@
 # Upgrade to 2.11
 
+## Deprecated `Doctrine\DBAL\Driver::getDatabase()`
+
+- The usage of `Doctrine\DBAL\Driver::getDatabase()` is deprecated. Please use `Doctrine\DBAL\Connection::getDatabase()` instead.
+- The behavior of the SQLite connection returning the database file path as the database is deprecated and shouldn't be relied upon.
+
 ## Deprecated `Portability\Connection::PORTABILITY_{PLATFORM}` constants`
 
 The platform-specific portability mode flags are meant to be used only by the portability layer internally to optimize
diff --git a/lib/Doctrine/DBAL/Driver.php b/lib/Doctrine/DBAL/Driver.php
index 57493e633bb..6f8afbf3cf4 100644
--- a/lib/Doctrine/DBAL/Driver.php
+++ b/lib/Doctrine/DBAL/Driver.php
@@ -53,6 +53,8 @@ public function getName();
     /**
      * Gets the name of the database connected to for this driver.
      *
+     * @deprecated Use Connection::getDatabase() instead.
+     *
      * @return string The name of the database.
      */
     public function getDatabase(Connection $conn);
diff --git a/lib/Doctrine/DBAL/Driver/AbstractDB2Driver.php b/lib/Doctrine/DBAL/Driver/AbstractDB2Driver.php
index c6e0565343a..cede8da7eb0 100644
--- a/lib/Doctrine/DBAL/Driver/AbstractDB2Driver.php
+++ b/lib/Doctrine/DBAL/Driver/AbstractDB2Driver.php
@@ -14,6 +14,8 @@ abstract class AbstractDB2Driver implements Driver
 {
     /**
      * {@inheritdoc}
+     *
+     * @deprecated Use Connection::getDatabase() instead.
      */
     public function getDatabase(Connection $conn)
     {
diff --git a/lib/Doctrine/DBAL/Driver/AbstractMySQLDriver.php b/lib/Doctrine/DBAL/Driver/AbstractMySQLDriver.php
index 87a16577100..ded2af9ae83 100644
--- a/lib/Doctrine/DBAL/Driver/AbstractMySQLDriver.php
+++ b/lib/Doctrine/DBAL/Driver/AbstractMySQLDriver.php
@@ -197,6 +197,8 @@ private function getMariaDbMysqlVersionNumber(string $versionString): string
 
     /**
      * {@inheritdoc}
+     *
+     * @deprecated Use Connection::getDatabase() instead.
      */
     public function getDatabase(Connection $conn)
     {
diff --git a/lib/Doctrine/DBAL/Driver/AbstractOracleDriver.php b/lib/Doctrine/DBAL/Driver/AbstractOracleDriver.php
index dcbaaf097f7..bd1802f324e 100644
--- a/lib/Doctrine/DBAL/Driver/AbstractOracleDriver.php
+++ b/lib/Doctrine/DBAL/Driver/AbstractOracleDriver.php
@@ -59,6 +59,8 @@ public function convertException($message, DriverException $exception)
 
     /**
      * {@inheritdoc}
+     *
+     * @deprecated Use Connection::getDatabase() instead.
      */
     public function getDatabase(Connection $conn)
     {
diff --git a/lib/Doctrine/DBAL/Driver/AbstractPostgreSQLDriver.php b/lib/Doctrine/DBAL/Driver/AbstractPostgreSQLDriver.php
index 2b16c5822e1..dfc90fea1ea 100644
--- a/lib/Doctrine/DBAL/Driver/AbstractPostgreSQLDriver.php
+++ b/lib/Doctrine/DBAL/Driver/AbstractPostgreSQLDriver.php
@@ -115,6 +115,8 @@ public function createDatabasePlatformForVersion($version)
 
     /**
      * {@inheritdoc}
+     *
+     * @deprecated Use Connection::getDatabase() instead.
      */
     public function getDatabase(Connection $conn)
     {
diff --git a/lib/Doctrine/DBAL/Driver/AbstractSQLAnywhereDriver.php b/lib/Doctrine/DBAL/Driver/AbstractSQLAnywhereDriver.php
index ff53552d379..456758c10e6 100644
--- a/lib/Doctrine/DBAL/Driver/AbstractSQLAnywhereDriver.php
+++ b/lib/Doctrine/DBAL/Driver/AbstractSQLAnywhereDriver.php
@@ -117,6 +117,8 @@ public function createDatabasePlatformForVersion($version)
 
     /**
      * {@inheritdoc}
+     *
+     * @deprecated Use Connection::getDatabase() instead.
      */
     public function getDatabase(Connection $conn)
     {
diff --git a/lib/Doctrine/DBAL/Driver/AbstractSQLServerDriver.php b/lib/Doctrine/DBAL/Driver/AbstractSQLServerDriver.php
index b624acd2454..78da3a0853c 100644
--- a/lib/Doctrine/DBAL/Driver/AbstractSQLServerDriver.php
+++ b/lib/Doctrine/DBAL/Driver/AbstractSQLServerDriver.php
@@ -58,6 +58,8 @@ public function createDatabasePlatformForVersion($version)
 
     /**
      * {@inheritdoc}
+     *
+     * @deprecated Use Connection::getDatabase() instead.
      */
     public function getDatabase(Connection $conn)
     {
diff --git a/lib/Doctrine/DBAL/Driver/AbstractSQLiteDriver.php b/lib/Doctrine/DBAL/Driver/AbstractSQLiteDriver.php
index 1c0def3a0f3..d0ec0b687bb 100644
--- a/lib/Doctrine/DBAL/Driver/AbstractSQLiteDriver.php
+++ b/lib/Doctrine/DBAL/Driver/AbstractSQLiteDriver.php
@@ -79,6 +79,8 @@ public function convertException($message, DriverException $exception)
 
     /**
      * {@inheritdoc}
+     *
+     * @deprecated Use Connection::getDatabase() instead.
      */
     public function getDatabase(Connection $conn)
     {