connections & engines are created by Driver

nette · website21cz · Aug 28, 2024 · Sep 2, 2024 · Sep 4, 2024 · Mar 1, 2021
commit e511b4456cceaa6aaf94e5245dc87c8aa85c8d5b
diff --git a/src/Database/Connection.php b/src/Database/Connection.php
@@ -49,11 +49,10 @@ class Connection
 
 	public function __construct(
 		private readonly string $dsn,
+		?string $username = null,
 		#[\SensitiveParameter]
-		private readonly ?string $user = null,
-		#[\SensitiveParameter]
-		private readonly ?string $password = null,
-		private readonly array $options = [],
+		?string $password = null,
+		array $options = [],
 	) {
 		if (($options['newDateTime'] ?? null) === false) {
 			$this->rowNormalizer = fn($row, $resultSet) => Helpers::normalizeRow($row, $resultSet, DateTime::class);
@@ -63,7 +62,15 @@ public function __construct(
 		$class = empty($options['driverClass'])
 			? (self::Drivers['pdo-' . $driver] ?? throw new \LogicException("Unknown PDO driver '$driver'."))
 			: $options['driverClass'];
-		$this->driver = new $class;
+		$args = compact('dsn', 'username', 'password', 'options');
+		unset($options['lazy'], $options['newDateTime'], $options['driverClass']);
+		foreach ($options as $key => $value) {
+			if (!is_int($key) && $value !== null) {
+				$args[$key] = $value;
+				unset($args['options'][$key]);
+			}
+		}
+		$this->driver = new $class(...$args);
 	}
 
 
@@ -74,13 +81,11 @@ public function connect(): void
 		}
 
 		try {
-			$this->pdo = new PDO($this->dsn, $this->user, $this->password, $this->options);
+			$this->pdo = $this->driver->connect();
 		} catch (PDOException $e) {
 			throw ConnectionException::from($e);
 		}
 
-		$this->engine = $this->driver->createEngine();
-		$this->engine->initialize($this, $this->options);
 		Arrays::invoke($this->onConnect, $this);
 	}
 
@@ -115,15 +120,13 @@ public function getPdo(): PDO
 	public function getSupplementalDriver(): Drivers\Engine
 	{
 		trigger_error(__METHOD__ . '() is deprecated, use getDriver()', E_USER_DEPRECATED);
-		$this->connect();
-		return $this->engine;
+		return $this->getDatabaseEngine();
 	}
 
 
 	public function getDatabaseEngine(): Drivers\Engine
 	{
-		$this->connect();
-		return $this->engine;
+		return $this->engine ??= $this->driver->createEngine($this);
 	}
 
 
@@ -146,7 +149,7 @@ public function getInsertId(?string $sequence = null): string
 			$res = $this->getPdo()->lastInsertId($sequence);
 			return $res === false ? '0' : $res;
 		} catch (PDOException $e) {
-			throw $this->engine->convertException($e);
+			throw $this->getDatabaseEngine()->convertException($e);
 		}
 	}
 

diff --git a/src/Database/Drivers/Driver.php b/src/Database/Drivers/Driver.php
@@ -15,6 +15,9 @@
  */
 interface Driver
 {
+	/** Establishes a connection to the database. */
+	function connect();
+
 	/** Creates a engine instance for the specific database platform. */
-	function createEngine(): Engine;
+	function createEngine($connection): Engine;
 }
diff --git a/src/Database/Drivers/Engine.php b/src/Database/Drivers/Engine.php
@@ -31,11 +31,6 @@ interface Engine
 	 */
 	function isSupported(string $feature): bool;
 
-	/**
-	 * Initializes connection.
-	 */
-	function initialize(Database\Connection $connection, array $options): void;
-
 	/**
 	 * Converts PDOException to DriverException or its descendant.
 	 */

diff --git a/src/Database/Drivers/Engines/MSSQLEngine.php b/src/Database/Drivers/Engines/MSSQLEngine.php
@@ -18,12 +18,9 @@
  */
 class MSSQLEngine implements Engine
 {
-	private Nette\Database\Connection $connection;
-
-
-	public function initialize(Nette\Database\Connection $connection, array $options): void
-	{
-		$this->connection = $connection;
+	public function __construct(
+		private readonly Nette\Database\Connection $connection,
+	) {
 	}
 
 

diff --git a/src/Database/Drivers/Engines/MySQLEngine.php b/src/Database/Drivers/Engines/MySQLEngine.php
@@ -18,29 +18,12 @@
  */
 class MySQLEngine implements Engine
 {
-	private Nette\Database\Connection $connection;
-	private bool $convertBoolean;
+	public bool $convertBoolean = true;
 
 
-	/**
-	 * Driver options:
-	 *   - charset => character encoding to set (default is utf8mb4)
-	 *   - sqlmode => see http://dev.mysql.com/doc/refman/5.0/en/server-sql-mode.html
-	 *   - convertBoolean => converts INT(1) to boolean
-	 */
-	public function initialize(Nette\Database\Connection $connection, array $options): void
-	{
-		$this->connection = $connection;
-		$charset = $options['charset'] ?? 'utf8mb4';
-		if ($charset) {
-			$connection->query('SET NAMES ?', $charset);
-		}
-
-		if (isset($options['sqlmode'])) {
-			$connection->query('SET sql_mode=?', $options['sqlmode']);
-		}
-
-		$this->convertBoolean = (bool) ($options['convertBoolean'] ?? true);
+	public function __construct(
+		private readonly Nette\Database\Connection $connection,
+	) {
 	}
 
 

diff --git a/src/Database/Drivers/Engines/ODBCEngine.php b/src/Database/Drivers/Engines/ODBCEngine.php
@@ -18,11 +18,6 @@
  */
 class ODBCEngine implements Engine
 {
-	public function initialize(Nette\Database\Connection $connection, array $options): void
-	{
-	}
-
-
 	public function isSupported(string $feature): bool
 	{
 		return $feature === self::SupportSubselect;

diff --git a/src/Database/Drivers/Engines/OracleEngine.php b/src/Database/Drivers/Engines/OracleEngine.php
@@ -18,14 +18,12 @@
  */
 class OracleEngine implements Engine
 {
-	private Nette\Database\Connection $connection;
-	private string $fmtDateTime;
+	public string $formatDateTime = 'U';
 
 
-	public function initialize(Nette\Database\Connection $connection, array $options): void
-	{
-		$this->connection = $connection;
-		$this->fmtDateTime = $options['formatDateTime'] ?? 'U';
+	public function __construct(
+		private readonly Nette\Database\Connection $connection,
+	) {
 	}
 
 
@@ -65,7 +63,7 @@ public function delimite(string $name): string
 
 	public function formatDateTime(\DateTimeInterface $value): string
 	{
-		return $value->format($this->fmtDateTime);
+		return $value->format($this->formatDateTime);
 	}
 
 

diff --git a/src/Database/Drivers/Engines/PostgreSQLEngine.php b/src/Database/Drivers/Engines/PostgreSQLEngine.php
@@ -18,12 +18,9 @@
  */
 class PostgreSQLEngine implements Engine
 {
-	private Nette\Database\Connection $connection;
-
-
-	public function initialize(Nette\Database\Connection $connection, array $options): void
-	{
-		$this->connection = $connection;
+	public function __construct(
+		private readonly Nette\Database\Connection $connection,
+	) {
 	}
 
 

diff --git a/src/Database/Drivers/Engines/SQLServerEngine.php b/src/Database/Drivers/Engines/SQLServerEngine.php
@@ -18,12 +18,9 @@
  */
 class SQLServerEngine implements Engine
 {
-	private Nette\Database\Connection $connection;
-
-
-	public function initialize(Nette\Database\Connection $connection, array $options): void
-	{
-		$this->connection = $connection;
+	public function __construct(
+		private readonly Nette\Database\Connection $connection,
+	) {
 	}
 
 

diff --git a/src/Database/Drivers/Engines/SQLiteEngine.php b/src/Database/Drivers/Engines/SQLiteEngine.php
@@ -18,14 +18,12 @@
  */
 class SQLiteEngine implements Engine
 {
-	private Nette\Database\Connection $connection;
-	private string $fmtDateTime;
+	public string $formatDateTime = 'U';
 
 
-	public function initialize(Nette\Database\Connection $connection, array $options): void
-	{
-		$this->connection = $connection;
-		$this->fmtDateTime = $options['formatDateTime'] ?? 'U';
+	public function __construct(
+		private readonly Nette\Database\Connection $connection,
+	) {
 	}
 
 
@@ -78,7 +76,7 @@ public function delimite(string $name): string
 
 	public function formatDateTime(\DateTimeInterface $value): string
 	{
-		return $value->format($this->fmtDateTime);
+		return $value->format($this->formatDateTime);
 	}
 
 
@@ -234,7 +232,7 @@ public function getColumnTypes(\PDOStatement $statement): array
 		for ($col = 0; $col < $count; $col++) {
 			$meta = $statement->getColumnMeta($col);
 			if (isset($meta['sqlite:decl_type'])) {
-				$types[$meta['name']] = $this->fmtDateTime === 'U' && in_array($meta['sqlite:decl_type'], ['DATE', 'DATETIME'], strict: true)
+				$types[$meta['name']] = $this->formatDateTime === 'U' && in_array($meta['sqlite:decl_type'], ['DATE', 'DATETIME'], strict: true)
 					? Nette\Database\IStructure::FIELD_UNIX_TIMESTAMP
 					: Nette\Database\Helpers::detectType($meta['sqlite:decl_type']);
 			} elseif (isset($meta['native_type'])) {

diff --git a/src/Database/Drivers/PDO/Driver.php b/src/Database/Drivers/PDO/Driver.php
@@ -17,4 +17,18 @@
  */
 abstract class Driver implements Drivers\Driver
 {
+	public function __construct(
+		protected readonly string $dsn,
+		protected readonly ?string $username = null,
+		#[\SensitiveParameter]
+		protected readonly ?string $password = null,
+		protected readonly array $options = [],
+	) {
+	}
+
+
+	public function connect()
+	{
+		return new \PDO($this->dsn, $this->username, $this->password, $this->options);
+	}
 }
diff --git a/src/Database/Drivers/PDO/MSSQL/Driver.php b/src/Database/Drivers/PDO/MSSQL/Driver.php
@@ -18,8 +18,8 @@
  */
 class Driver extends Drivers\PDO\Driver
 {
-	public function createEngine(): MSSQLEngine
+	public function createEngine($connection): MSSQLEngine
 	{
-		return new MSSQLEngine;
+		return new MSSQLEngine($connection);
 	}
 }
diff --git a/src/Database/Drivers/PDO/MySQL/Driver.php b/src/Database/Drivers/PDO/MySQL/Driver.php
@@ -18,8 +18,39 @@
  */
 class Driver extends Drivers\PDO\Driver
 {
-	public function createEngine(): MySQLEngine
+	private const DefaultCharset = 'utf8mb4';
+
+
+	public function __construct(
+		protected readonly string $dsn,
+		protected readonly ?string $username = null,
+		#[\SensitiveParameter]
+		protected readonly ?string $password = null,
+		protected readonly array $options = [],
+		protected readonly ?string $charset = self::DefaultCharset,
+		protected readonly ?string $sqlmode = null,
+		protected readonly ?bool $convertBoolean = null,
+	) {
+	}
+
+
+	public function connect()
+	{
+		$connection = parent::connect();
+		if ($this->charset) {
+			$connection->query('SET NAMES ' . $connection->quote($this->charset));
+		}
+		if ($this->sqlmode) {
+			$connection->query('SET sql_mode=' . $connection->quote($this->sqlmode));
+		}
+		return $connection;
+	}
+
+
+	public function createEngine($connection): MySQLEngine
 	{
-		return new MySQLEngine;
+		$engine = new MySQLEngine($connection);
+		$engine->convertBoolean = $this->convertBoolean ?? $engine->convertBoolean;
+		return $engine;
 	}
 }
diff --git a/src/Database/Drivers/PDO/OCI/Driver.php b/src/Database/Drivers/PDO/OCI/Driver.php
@@ -18,8 +18,23 @@
  */
 class Driver extends Drivers\PDO\Driver
 {
-	public function createEngine(): OracleEngine
+	public function __construct(
+		protected readonly string $dsn,
+		protected readonly ?string $username = null,
+		#[\SensitiveParameter]
+		protected readonly ?string $password = null,
+		protected readonly array $options = [],
+		protected readonly ?string $formatDateTime = null,
+	) {
+	}
+
+
+	public function createEngine($connection): OracleEngine
 	{
-		return new OracleEngine;
+		$engine = new OracleEngine($connection);
+		if ($this->formatDateTime) {
+			$engine->formatDateTime = $this->formatDateTime;
+		}
+		return $engine;
 	}
 }
diff --git a/src/Database/Drivers/PDO/ODBC/Driver.php b/src/Database/Drivers/PDO/ODBC/Driver.php
@@ -18,7 +18,7 @@
  */
 class Driver extends Drivers\PDO\Driver
 {
-	public function createEngine(): ODBCEngine
+	public function createEngine($connection): ODBCEngine
 	{
 		return new ODBCEngine;
 	}

diff --git a/src/Database/Drivers/PDO/PgSQL/Driver.php b/src/Database/Drivers/PDO/PgSQL/Driver.php
@@ -18,8 +18,8 @@
  */
 class Driver extends Drivers\PDO\Driver
 {
-	public function createEngine(): PostgreSQLEngine
+	public function createEngine($connection): PostgreSQLEngine
 	{
-		return new PostgreSQLEngine;
+		return new PostgreSQLEngine($connection);
 	}
 }
diff --git a/src/Database/Drivers/PDO/SQLSrv/Driver.php b/src/Database/Drivers/PDO/SQLSrv/Driver.php
@@ -18,8 +18,8 @@
  */
 class Driver extends Drivers\PDO\Driver
 {
-	public function createEngine(): SQLServerEngine
+	public function createEngine($connection): SQLServerEngine
 	{
-		return new SQLServerEngine;
+		return new SQLServerEngine($connection);
 	}
 }