final public static function Database::renameConnection

final public static Database::renameConnection($old_key, $new_key)

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.

File

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

Class

Database

Primary front-controller for the database system.

Namespace

Drupal\Core\Database

Code

final public static 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;
  }
}