Introduce IConnection connection interface

.github/workflows/coding-style.yml

@@ -10,7 +10,7 @@ jobs:
             - uses: actions/checkout@v4
             - uses: shivammathur/setup-php@v2
               with:
-                  php-version: 8.0
+                  php-version: 8.2
                   coverage: none
 
             - run: composer create-project nette/code-checker temp/code-checker ^3 --no-progress
@@ -24,7 +24,7 @@ jobs:
             - uses: actions/checkout@v4
             - uses: shivammathur/setup-php@v2
               with:
-                  php-version: 8.0
+                  php-version: 8.2
                   coverage: none
 
             - run: composer create-project nette/coding-standard temp/coding-standard ^3 --no-progress

.github/workflows/static-analysis.yml

@@ -13,7 +13,7 @@ jobs:
             - uses: actions/checkout@v4
             - uses: shivammathur/setup-php@v2
               with:
-                  php-version: 8.0
+                  php-version: 8.2
                   coverage: none
 
             - run: composer install --no-progress --prefer-dist

.github/workflows/tests.yml

@@ -11,7 +11,7 @@ jobs:
         runs-on: ubuntu-latest
         strategy:
             matrix:
-                php: ['8.0', '8.1', '8.2', '8.3', '8.4']
+                php: ['8.2', '8.3', '8.4']
 
             fail-fast: false
 
@@ -112,7 +112,7 @@ jobs:
 
 
             - name: Save Code Coverage
-              if: ${{ matrix.php == '8.0' }}
+              if: ${{ matrix.php == '8.2' }}
               env:
                   COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
               run: |

composer.json

@@ -11,7 +11,7 @@
 		}
 	],
 	"require": {
-		"php": "8.0 - 8.4"
+		"php": "8.2 - 8.4"
 	},
 	"require-dev": {
 		"tracy/tracy": "^2.9",
@@ -33,7 +33,7 @@
 	},
 	"extra": {
 		"branch-alias": {
-			"dev-master": "5.0-dev"
+			"dev-master": "6.0-dev"
 		}
 	}
 }

examples/using-substitutions.php

@@ -45,7 +45,7 @@ function substFallBack($expr)
 
 
 // define callback
-$dibi->getSubstitutes()->setCallback('substFallBack');
+$dibi->getSubstitutes()->setCallback(substFallBack(...));
 
 // define substitutes as constants
 define('SUBST_ACCOUNT', 'eshop_');

readme.md

@@ -34,7 +34,7 @@ Install Dibi via Composer:
 composer require dibi/dibi
 ```
 
-The Dibi 5.0 requires PHP version 8.0 and supports PHP up to 8.4.
+The Dibi 5.0 requires PHP version 8.2 and supports PHP up to 8.4.
 
 
 Usage

src/Dibi/Bridges/Tracy/Panel.php

@@ -35,8 +35,8 @@ public function __construct(
 	public function register(Dibi\Connection $connection): void
 	{
 		Tracy\Debugger::getBar()->addPanel($this);
-		Tracy\Debugger::getBlueScreen()->addPanel([self::class, 'renderException']);
-		$connection->onEvent[] = [$this, 'logEvent'];
+		Tracy\Debugger::getBlueScreen()->addPanel(self::renderException(...));
+		$connection->onEvent[] = $this->logEvent(...);
 	}
 
 

src/Dibi/Connection.php

@@ -21,13 +21,25 @@
  */
 class Connection implements IConnection
 {
+	private const Drivers = [
+		'firebird' => Drivers\Ibase\Connection::class,
+		'mysqli' => Drivers\MySQLi\Connection::class,
+		'odbc' => Drivers\ODBC\Connection::class,
+		'oracle' => Drivers\OCI8\Connection::class,
+		'pdo' => Drivers\PDO\Connection::class,
+		'postgre' => Drivers\PgSQL\Connection::class,
+		'sqlite3' => Drivers\SQLite3\Connection::class,
+		'sqlite' => Drivers\SQLite3\Connection::class,
+		'sqlsrv' => Drivers\SQLSrv\Connection::class,
+	];
+
 	/** function (Event $event); Occurs after query is executed */
 	public ?array $onEvent = [];
 	private array $config;
 
 	/** @var string[]  resultset formats */
 	private array $formats;
-	private ?Driver $driver = null;
+	private ?Drivers\Connection $driver = null;
 	private ?Translator $translator = null;
 
 	/** @var array<string, callable(object): Expression | null> */
@@ -120,17 +132,16 @@ public function __destruct()
 	 */
 	final public function connect(): void
 	{
-		if ($this->config['driver'] instanceof Driver) {
+		if ($this->config['driver'] instanceof Drivers\Connection) {
 			$this->driver = $this->config['driver'];
 			$this->translator = new Translator($this);
 			return;
 
-		} elseif (is_subclass_of($this->config['driver'], Driver::class)) {
+		} elseif (is_subclass_of($this->config['driver'], Drivers\Connection::class)) {
 			$class = $this->config['driver'];
 
 		} else {
-			$class = preg_replace(['#\W#', '#sql#'], ['_', 'Sql'], ucfirst(strtolower($this->config['driver'])));
-			$class = "Dibi\\Drivers\\{$class}Driver";
+			$class = self::Drivers[strtolower($this->config['driver'])] ?? throw new Exception("Unknown driver '{$this->config['driver']}'.");
 			if (!class_exists($class)) {
 				throw new Exception("Unable to create instance of Dibi driver '$class'.");
 			}
@@ -196,7 +207,7 @@ final public function getConfig(?string $key = null, $default = null): mixed
 	/**
 	 * Returns the driver and connects to a database in lazy mode.
 	 */
-	final public function getDriver(): Driver
+	final public function getDriver(): Drivers\Connection
 	{
 		if (!$this->driver) {
 			$this->connect();
@@ -284,7 +295,7 @@ final public function nativeQuery(#[Language('SQL')] string $sql): Result
 			throw $e;
 		}
 
-		$res = $this->createResultSet($res ?: new Drivers\NoDataResult(max(0, $this->driver->getAffectedRows())));
+		$res = $this->createResultSet($res ?: new Drivers\Dummy\Result(max(0, $this->driver->getAffectedRows())));
 		if ($event) {
 			$this->onEvent($event->done($res));
 		}
@@ -448,7 +459,7 @@ public function transaction(callable $callback): mixed
 	/**
 	 * Result set factory.
 	 */
-	public function createResultSet(ResultDriver $resultDriver): Result
+	public function createResultSet(Drivers\Result $resultDriver): Result
 	{
 		return (new Result($resultDriver, $this->config['result']['normalize'] ?? true))
 			->setFormats($this->formats);

src/Dibi/DataSource.php

@@ -15,8 +15,8 @@
  */
 class DataSource implements IDataSource
 {
-	private Connection $connection;
-	private string $sql;
+	private readonly IConnection $connection;
+	private readonly string $sql;
 	private ?Result $result = null;
 	private ?int $count = null;
 	private ?int $totalCount = null;
@@ -30,7 +30,7 @@ class DataSource implements IDataSource
 	/**
 	 * @param  string  $sql  command or table or view name, as data source
 	 */
-	public function __construct(string $sql, Connection $connection)
+	public function __construct(string $sql, IConnection $connection)
 	{
 		$this->sql = strpbrk($sql, " \t\r\n") === false
 			? $connection->getDriver()->escapeIdentifier($sql) // table name
@@ -99,7 +99,7 @@ public function applyLimit(int $limit, ?int $offset = null): static
 	}
 
 
-	final public function getConnection(): Connection
+	final public function getConnection(): IConnection
 	{
 		return $this->connection;
 	}

src/Dibi/Drivers/Connection.php

@@ -0,0 +1,97 @@
+<?php
+
+/**
+ * This file is part of the Dibi, smart database abstraction layer (https://dibiphp.com)
+ * Copyright (c) 2005 David Grudl (https://davidgrudl.com)
+ */
+
+declare(strict_types=1);
+
+namespace Dibi\Drivers;
+
+use Dibi\DriverException;
+use Dibi\Exception;
+
+
+/**
+ * Database connection driver.
+ */
+interface Connection
+{
+	/**
+	 * Disconnects from a database.
+	 * @throws Exception
+	 */
+	function disconnect(): void;
+
+	/**
+	 * Internal: Executes the SQL query.
+	 * @throws DriverException
+	 */
+	function query(string $sql): ?Result;
+
+	/**
+	 * Gets the number of affected rows by the last INSERT, UPDATE or DELETE query.
+	 */
+	function getAffectedRows(): ?int;
+
+	/**
+	 * Retrieves the ID generated for an AUTO_INCREMENT column by the previous INSERT query.
+	 */
+	function getInsertId(?string $sequence): ?int;
+
+	/**
+	 * Begins a transaction (if supported).
+	 * @throws DriverException
+	 */
+	function begin(?string $savepoint = null): void;
+
+	/**
+	 * Commits statements in a transaction.
+	 * @throws DriverException
+	 */
+	function commit(?string $savepoint = null): void;
+
+	/**
+	 * Rollback changes in a transaction.
+	 * @throws DriverException
+	 */
+	function rollback(?string $savepoint = null): void;
+
+	/**
+	 * Returns the connection resource.
+	 */
+	function getResource(): mixed;
+
+	/**
+	 * Returns the connection reflector.
+	 */
+	function getReflector(): Engine;
+
+	/**
+	 * Encodes data for use in a SQL statement.
+	 */
+	function escapeText(string $value): string;
+
+	function escapeBinary(string $value): string;
+
+	function escapeIdentifier(string $value): string;
+
+	function escapeBool(bool $value): string;
+
+	function escapeDate(\DateTimeInterface $value): string;
+
+	function escapeDateTime(\DateTimeInterface $value): string;
+
+	function escapeDateInterval(\DateInterval $value): string;
+
+	/**
+	 * Encodes string for use in a LIKE statement.
+	 */
+	function escapeLike(string $value, int $pos): string;
+
+	/**
+	 * Injects LIMIT/OFFSET to the SQL query.
+	 */
+	function applyLimit(string &$sql, ?int $limit, ?int $offset): void;
+}

src/Dibi/Drivers/DummyDriver.php → src/Dibi/Drivers/Dummy/Connection.php

@@ -7,22 +7,23 @@
 
 declare(strict_types=1);
 
-namespace Dibi\Drivers;
+namespace Dibi\Drivers\Dummy;
 
 use Dibi;
+use Dibi\Drivers;
 
 
 /**
  * The dummy driver for testing purposes.
  */
-class DummyDriver implements Dibi\Driver, Dibi\ResultDriver, Dibi\Reflector
+class Connection implements Drivers\Connection, Drivers\Result, Drivers\Engine
 {
 	public function disconnect(): void
 	{
 	}
 
 
-	public function query(string $sql): ?Dibi\ResultDriver
+	public function query(string $sql): ?Result
 	{
 		return null;
 	}
@@ -64,7 +65,7 @@ public function getResource(): mixed
 	/**
 	 * Returns the connection reflector.
 	 */
-	public function getReflector(): Dibi\Reflector
+	public function getReflector(): Drivers\Engine
 	{
 		return $this;
 	}

src/Dibi/Drivers/NoDataResult.php → src/Dibi/Drivers/Dummy/Result.php

@@ -7,18 +7,18 @@
 
 declare(strict_types=1);
 
-namespace Dibi\Drivers;
+namespace Dibi\Drivers\Dummy;
 
-use Dibi;
+use Dibi\Drivers;
 
 
 /**
  * The driver for no result set.
  */
-class NoDataResult implements Dibi\ResultDriver
+class Result implements Drivers\Result
 {
 	public function __construct(
-		private int $rows,
+		private readonly int $rows,
 	) {
 	}
 

src/Dibi/Drivers/Engine.php

@@ -0,0 +1,40 @@
+<?php
+
+/**
+ * This file is part of the Dibi, smart database abstraction layer (https://dibiphp.com)
+ * Copyright (c) 2005 David Grudl (https://davidgrudl.com)
+ */
+
+declare(strict_types=1);
+
+namespace Dibi\Drivers;
+
+
+/**
+ * Engine-specific behaviors.
+ */
+interface Engine
+{
+	/**
+	 * Returns list of tables.
+	 * @return array of {name [, (bool) view ]}
+	 */
+	function getTables(): array;
+
+	/**
+	 * Returns metadata for all columns in a table.
+	 * @return array of {name, nativetype [, table, fullname, (int) size, (bool) nullable, (mixed) default, (bool) autoincrement, (array) vendor ]}
+	 */
+	function getColumns(string $table): array;
+
+	/**
+	 * Returns metadata for all indexes in a table.
+	 * @return array of {name, (array of names) columns [, (bool) unique, (bool) primary ]}
+	 */
+	function getIndexes(string $table): array;
+
+	/**
+	 * Returns metadata for all foreign keys in a table.
+	 */
+	function getForeignKeys(string $table): array;
+}