Use public API instead of @internal

We wrap the foreign APIs in our own classes to ease maintenance.
The new classes will now use public APIs only, to prevent broken state
in minor updates and properly follow semantic versioning.

Resolves: #20

Author: justusmoroni

CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## v2.0.0 - 2025-10-20
 
+### Added
+
+- Support for TYPO3 13.4.19.
+  They modified `@internal` API and it is the fault of this package to use the API.
+  We therefore now move to low level public API of doctrine/dbal instead of TYPO3 internal API.
+  We also encapsulate the access to those APIs for easier maintenance.
+
 ### BREAKING
 
 - Remove support for older dependencies.

Classes/Connection.php

@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Copyright (C) 2025 Daniel Siepmann <coding@daniel-siepmann.de>
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301, USA.
+ */
+
+namespace Codappix\Typo3PhpDatasets;
+
+use TYPO3\CMS\Core\Database\Connection as Typo3Connection;
+
+/**
+ * @internal
+ */
+final readonly class Connection
+{
+    public function __construct(
+        private Typo3Connection $typo3Connection,
+    ) {
+    }
+
+    public function insert(string $tableName, array $record, array $types): void
+    {
+        $this->typo3Connection->insert($tableName, $record, $types);
+    }
+
+    public function getTable(string $tableName): Table
+    {
+        foreach ($this->typo3Connection->createSchemaManager()->listTables() as $table) {
+            if ($table->getObjectName()->toString() === $tableName) {
+                return new Table($table);
+            }
+        }
+
+        throw new \RuntimeException('Could not fetch table details for table: ' . $tableName, 1760939710);
+    }
+}

Classes/ConnectionFactory.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Copyright (C) 2025 Daniel Siepmann <coding@daniel-siepmann.de>
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301, USA.
+ */
+
+namespace Codappix\Typo3PhpDatasets;
+
+use TYPO3\CMS\Core\Database\ConnectionPool;
+use TYPO3\CMS\Core\Utility\GeneralUtility;
+
+final readonly class ConnectionFactory
+{
+    public function createForTable(string $tableName): Connection
+    {
+        return new Connection(
+            GeneralUtility::makeInstance(ConnectionPool::class)->getConnectionForTable($tableName)
+        );
+    }
+}

Classes/PhpDataSet.php

@@ -23,40 +23,32 @@
 
 namespace Codappix\Typo3PhpDatasets;
 
+use Doctrine\DBAL\Schema\Exception\ColumnDoesNotExist;
+use Exception;
 use RuntimeException;
 use TYPO3\CMS\Core\Database\ConnectionPool;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 
+/**
+ * @api
+ */
 class PhpDataSet
 {
+    /**
+     * @api
+     */
     public function import(array $dataSet): void
     {
-        foreach ($dataSet as $tableName => $records) {
-            $connection = $this->getConnectionPool()->getConnectionForTable($tableName);
-
-            if (method_exists($connection, 'getSchemaManager')) {
-                // <= 12
-                $tableDetails = $connection->getSchemaManager()->listTableDetails($tableName);
-            } elseif (method_exists($connection, 'getSchemaInformation')) {
-                // >= 13
-                $tableDetails = $connection->getSchemaInformation()->introspectTable($tableName);
-            } else {
-                throw new RuntimeException('Could not check the schema for table: ' . $tableName, 1707144020);
-            }
+        $connectionFactory = new ConnectionFactory();
 
-            foreach ($records as $record) {
-                $types = [];
-                foreach (array_keys($record) as $columnName) {
-                    $types[] = $tableDetails->getColumn((string)$columnName)->getType()->getBindingType();
-                }
+        foreach ($dataSet as $tableName => $records) {
+            $connection = $connectionFactory->createForTable($tableName);
+            $table = $connection->getTable($tableName);
 
+            foreach ($records as $index => $record) {
+                $types = array_map($table->getTypeForColumn(...), array_keys($record));
                 $connection->insert($tableName, $record, $types);
             }
         }
     }
-
-    private function getConnectionPool(): ConnectionPool
-    {
-        return GeneralUtility::makeInstance(ConnectionPool::class);
-    }
 }

Classes/Table.php

@@ -0,0 +1,56 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Copyright (C) 2025 Daniel Siepmann <coding@daniel-siepmann.de>
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301, USA.
+ */
+
+namespace Codappix\Typo3PhpDatasets;
+
+use Doctrine\DBAL\ParameterType;
+use Doctrine\DBAL\Schema\Exception\ColumnDoesNotExist;
+use Doctrine\DBAL\Schema\Table as DbalTable;
+
+/**
+ * @internal
+ */
+final readonly class Table
+{
+    public function __construct(
+        private DbalTable $dbalTable,
+    ) {
+    }
+
+    public function getTypeForColumn(string $columnName): ParameterType
+    {
+        try {
+            return $this->dbalTable
+                ->getColumn((string)$columnName)
+                ->getType()
+                ->getBindingType()
+            ;
+        } catch (ColumnDoesNotExist $e) {
+            throw new \RuntimeException(sprintf(
+                'Column "%s" does not exist in table: %s',
+                $columnName,
+                $this->dbalTable->getName(),
+            ), 1760941225);
+        }
+    }
+}

Classes/TestingFramework.php

@@ -27,10 +27,13 @@
 use InvalidArgumentException;
 
 /**
- * Only use this within an FunctionalTestCase.
+ * @api
  */
 trait TestingFramework
 {
+    /**
+     * @api
+     */
     protected function importPHPDataSet(string $filePath): void
     {
         $this->ensureFileExists($filePath);
@@ -45,6 +48,7 @@ protected function importPHPDataSet(string $filePath): void
 
     /**
      * Highly inspired by TYPO3 testing framework.
+     * @api
      */
     protected function assertPHPDataSet(string $filePath): void
     {

Tests/Functional/ImportTest.php

@@ -77,7 +77,7 @@ public function failsIfSqlError(): void
         $this->expectExceptionMessageMatches(
             '#Error for PHP data-set "' . __DIR__ . '/Fixtures/WithBrokenSql.php":'
             . PHP_EOL
-            . 'There is no column with name .*none_existing_column.* on table .*pages.*\.#'
+            . 'Column "none_existing_column" does not exist in table: pages#'
         );
         $this->importPHPDataSet(__DIR__ . '/Fixtures/WithBrokenSql.php');
     }