public static function Database::addConnectionInfo

1 database.inc public static Database::addConnectionInfo($key, $target, $info)

Adds database connection information for a given key/target.

This method allows the addition of new connection credentials at runtime. Under normal circumstances the preferred way to specify database credentials is via settings.php. However, this method allows them to be added at arbitrary times, such as during unit tests, when connecting to admin-defined third party databases, etc.

If the given key/target pair already exists, this method will be ignored.

Parameters

string $key: The database key.

string $target: The database target name.

array $info: The database connection information, as it would be defined in settings.php. Note that the structure of this array will depend on the database driver it is connecting to.

11 calls to Database::addConnectionInfo()

BackdropUnitTestCase::setUp in core/modules/simpletest/backdrop_web_test_case.php: Sets up unit test environment.
BackdropWebTestCase::changeDatabasePrefix in core/modules/simpletest/backdrop_web_test_case.php: Changes the database connection to the prefixed one.
ConnectionUnitTest::addConnection in core/modules/simpletest/tests/database_test.test: Adds a new database connection info to Database.
ConnectionUnitTest::setUp in core/modules/simpletest/tests/database_test.test: Sets up unit test environment.
DatabaseConnectionTestCase::testConnectionOptions in core/modules/simpletest/tests/database_test.test: Tests the connection options of the active database.

... See full list

File

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

Class

Database: Primary front-controller for the database system.

Code

public static function addConnectionInfo($key, $target, $info) { // phpcs:ignore -- No type hint on $info, add in 2.x.
  if (empty(self::$databaseInfo[$key][$target])) {
    self::$databaseInfo[$key][$target] = $info;
  }
}