function 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.

1 call to Database::renameConnection()

TestSetupTrait::changeDatabasePrefix in core/lib/Drupal/Core/Test/TestSetupTrait.php

Changes the database connection to the prefixed one.

File

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

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;
    }
}