atk4 · mvorisek · Aug 16, 2023 · Aug 15, 2023 · Aug 16, 2023 · Aug 16, 2023
diff --git a/bootstrap-types.php b/bootstrap-types.php
@@ -7,7 +7,12 @@
 use Atk4\Data\Type\LocalObjectType;
 use Atk4\Data\Type\MoneyType;
 use Atk4\Data\Type\Types;
+use Doctrine\DBAL\Platforms\SqlitePlatform;
 use Doctrine\DBAL\Types as DbalTypes;
 
+// force Doctrine\DBAL\Platforms\SQLitePlatform class load as in DBAL 3.x it is named with a different case
+// remove once DBAL 3.x support is dropped
+new SqlitePlatform();
+
 DbalTypes\Type::addType(Types::LOCAL_OBJECT, LocalObjectType::class);
 DbalTypes\Type::addType(Types::MONEY, MoneyType::class);
diff --git a/composer.json b/composer.json
@@ -35,13 +35,13 @@
     "require": {
         "php": ">=7.4 <8.3",
         "atk4/core": "dev-develop",
-        "doctrine/dbal": "~3.4.5 || ~3.5.1 || ~3.6.0",
+        "doctrine/dbal": "~3.5.1 || ~3.6.0",
         "mvorisek/atk4-hintable": "~1.9.0"
     },
     "require-release": {
         "php": ">=7.4 <8.3",
         "atk4/core": "~5.0.0",
-        "doctrine/dbal": "~3.4.5 || ~3.5.1 || ~3.6.0",
+        "doctrine/dbal": "~3.5.1 || ~3.6.0",
         "mvorisek/atk4-hintable": "~1.9.0"
     },
     "require-dev": {

diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -36,15 +36,11 @@ parameters:
             path: '*'
             count: 3
 
-        # TODO for DBAL 4.0 upgrade
+        # FC for DBAL 4.0, remove once DBAL 3.x support is dropped
         - 
-            message: '~^Instantiation of deprecated class Doctrine\\DBAL\\Event\\Listeners\\OracleSessionInit:\nUse \{@see \\Doctrine\\DBAL\\Driver\\OCI8\\Middleware\\InitializeSession\} instead\.$~'
-            path: 'src/Persistence/Sql/Oracle/Connection.php'
-            count: 1
-        - 
-            message: '~^(Fetching deprecated class constant postConnect of class Doctrine\\DBAL\\Events\.|Fetching class constant postConnect of deprecated class Doctrine\\DBAL\\Events\.|Parameter \$args of method postConnect\(\) in anonymous class has typehint with deprecated class Doctrine\\DBAL\\Event\\ConnectionEventArgs\.)$~'
-            path: 'src/Persistence/Sql/Sqlite/Connection.php'
-            count: 3
+            message: '~^Class Doctrine\\DBAL\\Platforms\\SqlitePlatform referenced with incorrect case: Doctrine\\DBAL\\Platforms\\SQLitePlatform\.$~'
+            path: '*'
+            count: 33
 
         # TODO these rules are generated, this ignores should be fixed in the code
         # for src/Schema/TestCase.php

diff --git a/src/Persistence/Sql/Connection.php b/src/Persistence/Sql/Connection.php
@@ -5,8 +5,7 @@
 namespace Atk4\Data\Persistence\Sql;
 
 use Atk4\Core\DiContainerTrait;
-use Doctrine\Common\EventManager;
-use Doctrine\DBAL\Configuration as DbalConfiguration;
+use Doctrine\DBAL\Configuration;
 use Doctrine\DBAL\Connection as DbalConnection;
 use Doctrine\DBAL\ConnectionException as DbalConnectionException;
 use Doctrine\DBAL\Driver as DbalDriver;
@@ -226,10 +225,10 @@ private static function getDriverNameFromDbalDriverConnection(DbalDriverConnecti
         return null; // @phpstan-ignore-line
     }
 
-    protected static function createDbalConfiguration(): DbalConfiguration
+    protected static function createDbalConfiguration(): Configuration
     {
-        $dbalConfiguration = new DbalConfiguration();
-        $dbalConfiguration->setMiddlewares([
+        $configuration = new Configuration();
+        $configuration->setMiddlewares([
             new class() implements DbalMiddleware {
                 public function wrap(DbalDriver $driver): DbalDriver
                 {
@@ -238,12 +237,7 @@ public function wrap(DbalDriver $driver): DbalDriver
             },
         ]);
 
-        return $dbalConfiguration;
-    }
-
-    protected static function createDbalEventManager(): EventManager
-    {
-        return new EventManager();
+        return $configuration;
     }
 
     /**
@@ -260,8 +254,7 @@ protected static function connectFromDsn(array $dsn): DbalDriverConnection
 
         $dbalConnection = DriverManager::getConnection(
             $dsn, // @phpstan-ignore-line
-            (static::class)::createDbalConfiguration(),
-            (static::class)::createDbalEventManager()
+            (static::class)::createDbalConfiguration()
         );
 
         return $dbalConnection->getWrappedConnection(); // @phpstan-ignore-line https://github.com/doctrine/dbal/issues/5199
@@ -271,8 +264,7 @@ protected static function connectFromDbalDriverConnection(DbalDriverConnection $
     {
         $dbalConnection = DriverManager::getConnection(
             ['driver' => self::getDriverNameFromDbalDriverConnection($dbalDriverConnection)],
-            (static::class)::createDbalConfiguration(),
-            (static::class)::createDbalEventManager()
+            (static::class)::createDbalConfiguration()
         );
         \Closure::bind(function () use ($dbalConnection, $dbalDriverConnection): void {
             $dbalConnection->_conn = $dbalDriverConnection;

diff --git a/src/Persistence/Sql/DbalDriverMiddleware.php b/src/Persistence/Sql/DbalDriverMiddleware.php
@@ -17,7 +17,7 @@
 use Doctrine\DBAL\Platforms\AbstractPlatform;
 use Doctrine\DBAL\Platforms\OraclePlatform;
 use Doctrine\DBAL\Platforms\PostgreSQLPlatform;
-use Doctrine\DBAL\Platforms\SqlitePlatform;
+use Doctrine\DBAL\Platforms\SQLitePlatform;
 use Doctrine\DBAL\Platforms\SQLServerPlatform;
 use Doctrine\DBAL\Query as DbalQuery;
 use Doctrine\DBAL\Schema\AbstractSchemaManager;
@@ -28,8 +28,8 @@ class DbalDriverMiddleware extends AbstractDriverMiddleware
 {
     protected function replaceDatabasePlatform(AbstractPlatform $platform): AbstractPlatform
     {
-        if ($platform instanceof SqlitePlatform) {
-            $platform = new class() extends SqlitePlatform {
+        if ($platform instanceof SQLitePlatform) {
+            $platform = new class() extends SQLitePlatform {
                 use Sqlite\PlatformTrait;
             };
         } elseif ($platform instanceof PostgreSQLPlatform) {
@@ -64,7 +64,7 @@ public function createDatabasePlatformForVersion($version): AbstractPlatform
      */
     public function getSchemaManager(DbalConnection $connection, AbstractPlatform $platform): AbstractSchemaManager
     {
-        if ($platform instanceof SqlitePlatform) {
+        if ($platform instanceof SQLitePlatform) {
             return new class($connection, $platform) extends SqliteSchemaManager { // @phpstan-ignore-line
                 use Sqlite\SchemaManagerTrait;
             };

diff --git a/src/Persistence/Sql/Expression.php b/src/Persistence/Sql/Expression.php
@@ -11,7 +11,7 @@
 use Doctrine\DBAL\ParameterType;
 use Doctrine\DBAL\Platforms\OraclePlatform;
 use Doctrine\DBAL\Platforms\PostgreSQLPlatform;
-use Doctrine\DBAL\Platforms\SqlitePlatform;
+use Doctrine\DBAL\Platforms\SQLitePlatform;
 use Doctrine\DBAL\Platforms\SQLServerPlatform;
 use Doctrine\DBAL\Result as DbalResult;
 
@@ -287,9 +287,9 @@ protected function escapeStringLiteral(string $value): string
                     $sqlLeft = 'CAST(' . $sqlLeft . ' AS NVARCHAR(MAX))';
                 }
 
-                return ($platform instanceof SqlitePlatform ? '(' : 'CONCAT(')
+                return ($platform instanceof SQLitePlatform ? '(' : 'CONCAT(')
                     . $sqlLeft
-                    . ($platform instanceof SqlitePlatform ? ' || ' : ', ')
+                    . ($platform instanceof SQLitePlatform ? ' || ' : ', ')
                     . $buildConcatSqlFx($partsRight)
                     . ')';
             }

diff --git a/src/Persistence/Sql/Oracle/Connection.php b/src/Persistence/Sql/Oracle/Connection.php
@@ -5,34 +5,63 @@
 namespace Atk4\Data\Persistence\Sql\Oracle;
 
 use Atk4\Data\Persistence\Sql\Connection as BaseConnection;
-use Doctrine\Common\EventManager;
-use Doctrine\DBAL\Event\Listeners\OracleSessionInit;
+use Doctrine\DBAL\Configuration;
+use Doctrine\DBAL\Driver;
+use Doctrine\DBAL\Driver\Connection as DriverConnection;
+use Doctrine\DBAL\Driver\Middleware;
+use Doctrine\DBAL\Driver\Middleware\AbstractDriverMiddleware;
 
 class Connection extends BaseConnection
 {
     protected string $expressionClass = Expression::class;
     protected string $queryClass = Query::class;
 
-    protected static function createDbalEventManager(): EventManager
+    protected static function createDbalConfiguration(): Configuration
     {
-        $evm = parent::createDbalEventManager();
+        $configuration = parent::createDbalConfiguration();
 
         // setup connection globalization to use standard datetime format incl. microseconds support
         // and make comparison of character types case insensitive
-        $dateFormat = 'YYYY-MM-DD';
-        $timeFormat = 'HH24:MI:SS.FF6';
-        $tzFormat = 'TZH:TZM';
-        $evm->addEventSubscriber(new OracleSessionInit([
-            'NLS_DATE_FORMAT' => $dateFormat,
-            'NLS_TIME_FORMAT' => $timeFormat,
-            'NLS_TIMESTAMP_FORMAT' => $dateFormat . ' ' . $timeFormat,
-            'NLS_TIME_TZ_FORMAT' => $timeFormat . ' ' . $tzFormat,
-            'NLS_TIMESTAMP_TZ_FORMAT' => $dateFormat . ' ' . $timeFormat . ' ' . $tzFormat,
-            'NLS_COMP' => 'LINGUISTIC',
-            'NLS_SORT' => 'BINARY_CI',
-        ]));
-
-        return $evm;
+        // based on https://github.com/doctrine/dbal/blob/3.6.5/src/Driver/OCI8/Middleware/InitializeSession.php
+        $initializeSessionMiddleware = new class() implements Middleware {
+            public function wrap(Driver $driver): Driver
+            {
+                return new class($driver) extends AbstractDriverMiddleware {
+                    public function connect(
+                        #[\SensitiveParameter]
+                        array $params
+                    ): DriverConnection {
+                        $connection = parent::connect($params);
+
+                        $dateFormat = 'YYYY-MM-DD';
+                        $timeFormat = 'HH24:MI:SS.FF6';
+                        $tzFormat = 'TZH:TZM';
+
+                        $vars = [];
+                        foreach ([
+                            'NLS_DATE_FORMAT' => $dateFormat,
+                            'NLS_TIME_FORMAT' => $timeFormat,
+                            'NLS_TIMESTAMP_FORMAT' => $dateFormat . ' ' . $timeFormat,
+                            'NLS_TIME_TZ_FORMAT' => $timeFormat . ' ' . $tzFormat,
+                            'NLS_TIMESTAMP_TZ_FORMAT' => $dateFormat . ' ' . $timeFormat . ' ' . $tzFormat,
+                            'NLS_NUMERIC_CHARACTERS' => '.,',
+                            'NLS_COMP' => 'LINGUISTIC',
+                            'NLS_SORT' => 'BINARY_CI',
+                        ] as $k => $v) {
+                            $vars[] = $k . " = '" . $v . "'";
+                        }
+
+                        $connection->exec('ALTER SESSION SET ' . implode(' ', $vars));
+
+                        return $connection;
+                    }
+                };
+            }
+        };
+
+        $configuration->setMiddlewares([...$configuration->getMiddlewares(), $initializeSessionMiddleware]);
+
+        return $configuration;
     }
 
     public function lastInsertId(string $sequence = null): string

diff --git a/src/Persistence/Sql/Sqlite/Connection.php b/src/Persistence/Sql/Sqlite/Connection.php
@@ -5,33 +5,20 @@
 namespace Atk4\Data\Persistence\Sql\Sqlite;
 
 use Atk4\Data\Persistence\Sql\Connection as BaseConnection;
-use Doctrine\Common\EventManager;
-use Doctrine\Common\EventSubscriber;
-use Doctrine\DBAL\Event\ConnectionEventArgs;
-use Doctrine\DBAL\Events;
+use Doctrine\DBAL\Configuration;
+use Doctrine\DBAL\Driver\AbstractSQLiteDriver\Middleware\EnableForeignKeys;
 
 class Connection extends BaseConnection
 {
     protected string $expressionClass = Expression::class;
     protected string $queryClass = Query::class;
 
-    protected static function createDbalEventManager(): EventManager
+    protected static function createDbalConfiguration(): Configuration
     {
-        $evm = parent::createDbalEventManager();
+        $configuration = parent::createDbalConfiguration();
 
-        // setup connection to always check foreign keys
-        $evm->addEventSubscriber(new class() implements EventSubscriber {
-            public function getSubscribedEvents(): array
-            {
-                return [Events::postConnect];
-            }
+        $configuration->setMiddlewares([...$configuration->getMiddlewares(), new EnableForeignKeys()]);
 
-            public function postConnect(ConnectionEventArgs $args): void
-            {
-                $args->getConnection()->executeStatement('PRAGMA foreign_keys = 1');
-            }
-        });
-
-        return $evm;
+        return $configuration;
     }
 }
diff --git a/src/Schema/Migrator.php b/src/Schema/Migrator.php
@@ -20,7 +20,7 @@
 use Doctrine\DBAL\Platforms\MySQLPlatform;
 use Doctrine\DBAL\Platforms\OraclePlatform;
 use Doctrine\DBAL\Platforms\PostgreSQLPlatform;
-use Doctrine\DBAL\Platforms\SqlitePlatform;
+use Doctrine\DBAL\Platforms\SQLitePlatform;
 use Doctrine\DBAL\Platforms\SQLServerPlatform;
 use Doctrine\DBAL\Schema\AbstractAsset;
 use Doctrine\DBAL\Schema\AbstractSchemaManager;
@@ -253,7 +253,7 @@ public function field(string $fieldName, array $options = []): self
         }
 
         if (in_array($type, ['string', 'text'], true)) {
-            if ($this->getDatabasePlatform() instanceof SqlitePlatform) {
+            if ($this->getDatabasePlatform() instanceof SQLitePlatform) {
                 $column->setPlatformOption('collation', 'NOCASE');
             }
         }

diff --git a/src/Schema/TestCase.php b/src/Schema/TestCase.php
@@ -11,7 +11,7 @@
 use Doctrine\DBAL\ParameterType;
 use Doctrine\DBAL\Platforms\AbstractPlatform;
 use Doctrine\DBAL\Platforms\OraclePlatform;
-use Doctrine\DBAL\Platforms\SqlitePlatform;
+use Doctrine\DBAL\Platforms\SQLitePlatform;
 use Doctrine\DBAL\Platforms\SQLServerPlatform;
 
 abstract class TestCase extends BaseTestCase
@@ -114,7 +114,7 @@ function ($matches) use ($platform) {
             $sql
         );
 
-        if ($platform instanceof SqlitePlatform && $convertedSql !== $sql) {
+        if ($platform instanceof SQLitePlatform && $convertedSql !== $sql) {
             self::assertSame($sql, $convertedSql);
         }
 

diff --git a/tests/ExpressionSqlTest.php b/tests/ExpressionSqlTest.php
@@ -7,7 +7,7 @@
 use Atk4\Data\Model;
 use Atk4\Data\Schema\TestCase;
 use Doctrine\DBAL\Platforms\OraclePlatform;
-use Doctrine\DBAL\Platforms\SqlitePlatform;
+use Doctrine\DBAL\Platforms\SQLitePlatform;
 
 class ExpressionSqlTest extends TestCase
 {
@@ -33,7 +33,7 @@ public function testBasic(): void
         $i->addField('total_vat', ['type' => 'float']);
         $i->addExpression('total_gross', ['expr' => '[total_net] + [total_vat]', 'type' => 'float']);
 
-        if ($this->getDatabasePlatform() instanceof SqlitePlatform) {
+        if ($this->getDatabasePlatform() instanceof SQLitePlatform) {
             self::assertSame(
                 'select `id`, `total_net`, `total_vat`, (`total_net` + `total_vat`) `total_gross` from `invoice`',
                 $i->action('select')->render()[0]
@@ -50,7 +50,7 @@ public function testBasic(): void
 
         $i->addExpression('double_total_gross', ['expr' => '[total_gross] * 2', 'type' => 'float']);
 
-        if ($this->getDatabasePlatform() instanceof SqlitePlatform) {
+        if ($this->getDatabasePlatform() instanceof SQLitePlatform) {
             self::assertSame(
                 'select `id`, `total_net`, `total_vat`, (`total_net` + `total_vat`) `total_gross`, ((`total_net` + `total_vat`) * 2) `double_total_gross` from `invoice`',
                 $i->action('select')->render()[0]
@@ -77,7 +77,7 @@ public function testBasicCallback(): void
             return '[total_net] + [total_vat]';
         }, 'type' => 'float']);
 
-        if ($this->getDatabasePlatform() instanceof SqlitePlatform) {
+        if ($this->getDatabasePlatform() instanceof SQLitePlatform) {
             self::assertSame(
                 'select `id`, `total_net`, `total_vat`, (`total_net` + `total_vat`) `total_gross` from `invoice`',
                 $i->action('select')->render()[0]
@@ -107,7 +107,7 @@ public function testQuery(): void
         $i->addField('total_vat', ['type' => 'float']);
         $i->addExpression('sum_net', ['expr' => $i->action('fx', ['sum', 'total_net']), ['type' => 'integer']]);
 
-        if ($this->getDatabasePlatform() instanceof SqlitePlatform) {
+        if ($this->getDatabasePlatform() instanceof SQLitePlatform) {
             self::assertSame(
                 'select `id`, `total_net`, `total_vat`, (select sum(`total_net`) from `invoice`) `sum_net` from `invoice`',
                 $i->action('select')->render()[0]
@@ -141,7 +141,7 @@ public function testExpressions(): void
         $m->addField('surname');
         $m->addField('cached_name');
 
-        if ($this->getDatabasePlatform() instanceof SqlitePlatform || $this->getDatabasePlatform() instanceof OraclePlatform) {
+        if ($this->getDatabasePlatform() instanceof SQLitePlatform || $this->getDatabasePlatform() instanceof OraclePlatform) {
             $concatExpr = '[name] || \' \' || [surname]';
         } else {
             $concatExpr = 'CONCAT([name], \' \', [surname])';