The Driver::connect() method signature is redundant

[morozov]

Q	A
BC Break	no
Version	2.10.2

User credentials and driver options are passed to the driver both via individual parameters and as part of $params:

dbal/src/Connection.php

Lines 352 to 356 in 48625f1

	$driverOptions = $this->params['driverOptions'] ?? [];
	$user = $this->params['user'] ?? null;
	$password = $this->params['password'] ?? null;
	$this->_conn = $this->_driver->connect($this->params, $user, $password, $driverOptions);

On the one hand, it's unclear to the implementors of Driver::connect(), whether the parameters should be taken from $params or from the individual parameters. On the other hand, the code components that call connect() need to mimic the behavior of the Connection class:

1. dbal/lib/Doctrine/DBAL/Connections/MasterSlaveConnection.php

   Lines 195 to 198 in d6f232e

   	$user = $connectionParams['user'] ?? null;
   	$password = $connectionParams['password'] ?? null;
   	return $this->_driver->connect($connectionParams, $user, $password, $driverOptions);

2. dbal/tests/Functional/Driver/AbstractDriverTest.php

   Lines 34 to 37 in 3d8c575

   	$user = $params['user'] ?? null;
   	$password = $params['password'] ?? null;
   	$connection = $this->driver->connect($params, $user, $password);

More examples:

3. dbal/tests/Functional/Schema/SchemaManagerFunctionalTestCase.php

   Lines 120 to 123 in 48625f1

   	$user = $params['user'] ?? null;
   	$password = $params['password'] ?? null;
   	$connection = $this->connection->getDriver()->connect($params, $user, $password);

4. dbal/tests/Functional/Schema/SqliteSchemaManagerTest.php

   Lines 53 to 56 in 48625f1

   	$user = $params['user'] ?? null;
   	$password = $params['password'] ?? null;
   	$connection = $this->connection->getDriver()->connect($params, $user, $password);

5. dbal/tests/Doctrine/Tests/DBAL/Functional/Driver/Mysqli/ConnectionTest.php

   Lines 63 to 68 in f88dc28

   	return new MysqliConnection(
   	$params,
   	$params['user'] ?? '',
   	$params['password'] ?? '',
   	$driverOptions
   	);

6. dbal/tests/Doctrine/Tests/DBAL/Driver/PDOPgSql/DriverTest.php

   Lines 96 to 101 in f88dc28

   	return $this->createDriver()->connect(
   	$params,
   	$params['user'] ?? '',
   	$params['password'] ?? '',
   	$driverOptions
   	);

7. dbal/tests/Doctrine/Tests/DBAL/Functional/Driver/PDOSqlsrv/DriverTest.php

   Lines 47 to 52 in f88dc28

   	return $this->connection->getDriver()->connect(
   	$params,
   	$params['user'] ?? '',
   	$params['password'] ?? '',
   	$driverOptions
   	);

By being this verbose, this API doesn't solve any design problem. On the contrary, once a driver receives these parameters individually, it may have to pack them back or regroup otherwise before processing:

1. dbal/lib/Doctrine/DBAL/Driver/IBMDB2/DB2Driver.php

   Lines 17 to 19 in 747b042

   	$params['user'] = $username;
   	$params['password'] = $password;
   	$params['dbname'] = DataSourceName::fromConnectionParameters($params)->toString();

2. dbal/lib/Doctrine/DBAL/Driver/SQLSrv/Driver.php

   Lines 34 to 40 in 4074ae9

   	if ($username !== null) {
   	$driverOptions['UID'] = $username;
   	}
   	if ($password !== null) {
   	$driverOptions['PWD'] = $password;
   	}

3. dbal/lib/Doctrine/DBAL/Driver/SQLAnywhere/Driver.php

   Lines 78 to 84 in 4074ae9

   	';UID=' . $username .
   	';PWD=' . $password .
   	';' . implode(
   	';',
   	array_map(static function ($key, $value) {
   	return $key . '=' . $value;
   	}, array_keys($driverOptions), $driverOptions)

Since Driver::connect() plays the role of an adapter between the DBAL Connection::connect() and the Driver Connection::__construct(), it shouldn't expect Connection::connect() to do any adaptation.

[github-actions]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.