final public static function Database::renameConnection in Drupal 10

Same name and namespace in other branches

1. 8 core/lib/Drupal/Core/Database/Database.php \Drupal\Core\Database\Database::renameConnection()
2. 9 core/lib/Drupal/Core/Database/Database.php \Drupal\Core\Database\Database::renameConnection()

Rename a connection and its corresponding connection information.

Parameters

string $old_key: The old connection key.

string $new_key: The new connection key.

Return value

bool TRUE in case of success, FALSE otherwise.

8 calls to Database::renameConnection()

InstallerNonDefaultDatabaseDriverTest::testInstalled in core/tests/Drupal/FunctionalTests/Installer/InstallerNonDefaultDatabaseDriverTest.php

Confirms that the installation succeeded.

KernelTestBase::getDatabaseConnectionInfo in core/tests/Drupal/KernelTests/KernelTestBase.php

Returns the Database connection info to be used for this test.

KernelTestBaseDatabaseDriverModuleTest::getDatabaseConnectionInfo in core/tests/Drupal/KernelTests/KernelTestBaseDatabaseDriverModuleTest.php

Returns the Database connection info to be used for this test.

MigrateTestBase::cleanupMigrateConnection in core/modules/migrate/tests/src/Kernel/MigrateTestBase.php

Cleans up the test migrate connection.

MigrateTestBase::createMigrationConnection in core/modules/migrate/tests/src/Kernel/MigrateTestBase.php

Changes the database connection to the prefixed one.

... See full list

File

core/lib/Drupal/Core/Database/Database.php, line 329

Class

Database

Primary front-controller for the database system.

Namespace

Drupal\Core\Database

Code

public static final function renameConnection($old_key, $new_key) {
  if (!empty(self::$databaseInfo[$old_key]) && empty(self::$databaseInfo[$new_key])) {

    // Migrate the database connection information.
    self::$databaseInfo[$new_key] = self::$databaseInfo[$old_key];
    unset(self::$databaseInfo[$old_key]);

    // Migrate over the DatabaseConnection object if it exists.
    if (isset(self::$connections[$old_key])) {
      self::$connections[$new_key] = self::$connections[$old_key];
      unset(self::$connections[$old_key]);
    }
    return TRUE;
  }
  else {
    return FALSE;
  }
}