final public static function Database::renameConnection

1 database.inc 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.

5 calls to Database::renameConnection()

BackdropUnitTestCase::setUp in core/modules/simpletest/backdrop_web_test_case.php: Sets up unit test environment.
BackdropUnitTestCase::tearDown in core/modules/simpletest/backdrop_web_test_case.php: Clean up any database tables, configuration, or files after each test run.
BackdropWebTestCase::changeDatabasePrefix in core/modules/simpletest/backdrop_web_test_case.php: Changes the database connection to the prefixed one.
BackdropWebTestCase::tearDown in core/modules/simpletest/backdrop_web_test_case.php: Delete created files and temporary files directory, delete the tables created by setUp(), and reset the database prefix.
BackdropWebTestCaseCache::tearDown in core/modules/simpletest/backdrop_web_test_case_cache.php: Reset the database prefix and global config.

File

core/includes/database/database.inc, line 1779: Core systems for the database layer.

Class

Database: Primary front-controller for the database system.

Code

final public static function renameConnection($old_key, $new_key) {
  if (empty(self::$databaseInfo)) {
    self::parseConnectionInfo();
  }

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