Datenbankcode für PHP 8 und jede Engine #

Teil 4, Kapitel 10. Alte Erweiterungen wurden für eine einzige Datenbank geschrieben: MySQL. Exponential 6 unterstützt mehrere, und der Standard für eine neue Installation ist SQLite 3. Dieses Kapitel zeigt, was Sie am Datenbankcode einer alten Erweiterung ändern müssen, damit er unter PHP 8 und auf jeder Engine funktioniert, auf der die Website laufen kann.

Die Engines, auf die eine Erweiterung treffen kann #

Datenbankunterstützung listet die unterstützten Datenbanken in der Reihenfolge auf, die das Projekt bevorzugt: SQLite 3 (der Standard), PostgreSQL, MongoDB, MariaDB, Oracle und MySQL. Ihre Erweiterung wählt nicht; die Website wählt. Code, der nur auf MySQL funktioniert, funktioniert auf einer von sechs.

Die Zeile zu MongoDB ist das stärkste Argument für die Regel dieses Kapitels: Verwenden Sie eZPersistentObject für Ihre eigenen Tabellen. Der MongoDB-Adapter übersetzt die Aufrufe von eZPersistentObject (fetchObjectList(), storeObject(), removeObject()) in MongoDB-Abfragen; Ihr von Hand geschriebenes SQL kann er in nichts übersetzen (MongoDB-Unterstützung im Kernel).

Schritt 1: kein mysql_* und kein eigenes mysqli_* #

Die mysql_*()-Funktionen wurden in PHP 7 entfernt. Sie durch mysqli_*() und eine neue Verbindung zu ersetzen, ist die falsche Lösung: Damit öffnen Sie eine zweite Verbindung, außerhalb der Transaktionen des Kernels, zu einer Datenbank, die vielleicht gar nicht MySQL ist. Verwenden Sie die Verbindung des Kernels:

<?php
$db = eZDB::instance();
$rows = $db->arrayQuery( 'SELECT id, name FROM myoldext_item ORDER BY name' );
foreach ( $rows as $row )
{
    echo $row['id'], ' ', $row['name'], "\n";
}

Die letzte Zeile ist wichtig: Das zweite Argument von arrayQuery() nimmt offset und limit, und jeder Treiber schreibt das richtige SQL für seine Engine.

Schritt 2: Werte in SQL #

Jeder Wert, den Sie in SQL einsetzen, muss je nach Typ abgesichert werden:

<?php
$db = eZDB::instance();
$http = eZHTTPTool::instance();

$id = (int)$http->postVariable( 'ItemID' );
$name = $db->escapeString( (string)$http->postVariable( 'Name' ) );
$ids = array_map( 'intval', (array)$http->postVariable( 'SelectedIDs', array() ) );

$db->query( "UPDATE myoldext_item SET name = '$name' WHERE id = $id" );
if ( $ids )
{
    $rows = $db->arrayQuery( 'SELECT id, name FROM myoldext_item WHERE ' . $db->generateSQLINStatement( $ids, 'id', false, true, 'int' ) );
}

• Ganzzahlen: (int).
• Strings: escapeString(), innerhalb einfacher Anführungszeichen.
• Listen: generateSQLINStatement(), das sehr lange Listen außerdem so aufteilt, wie die Engine es braucht.
• Niemals ein Wert aus der Anfrage ohne eines davon.

Beachten Sie das (string) vor escapeString(): postVariable() liefert null für eine fehlende Variable, und null an String-Funktionen zu übergeben, ist seit PHP 8.1 veraltet (Veraltetes in PHP 8.1 bis 8.5).

Schritt 3: portables SQL #

Wenn Sie reines SQL behalten, beschränken Sie es auf das, was jede SQL-Engine versteht:

Schritt 4: Transaktionen #

Fassen Sie Schreibvorgänge, die zusammengehören, zusammen, damit ein Fehler nichts halb erledigt zurücklässt:

<?php
$db = eZDB::instance();
$db->begin();
$db->query( "DELETE FROM myoldext_item_tag WHERE item_id = $id" );
foreach ( $tagIDs as $tagID )
{
    $db->query( 'INSERT INTO myoldext_item_tag ( item_id, tag_id ) VALUES ( ' . (int)$id . ', ' . (int)$tagID . ' )' );
}
$db->commit();

Der Kernel zählt verschachtelte begin()-Aufrufe, sodass Ihre Transaktion innerhalb einer laufen kann, die der Kernel geöffnet hat (zum Beispiel beim Veröffentlichen), und erst auf der äußersten Ebene committet wird. se7enxweb/expchangeclass hat beim Fork von eZChangeclass ein Rollback per Transaktion hinzugefügt, „damit eine fehlgeschlagene Umwandlung den Inhalt unberührt lässt“ (sein erster Import, Commit 7c3f164).

Schritt 5: Tabellen, Schemas und .dba-Dateien #

Alte Erweiterungen liefern sql/mysql/schema.sql mit und erwarten, dass der Administrator es ausführt. Erweiterungen für Exponential 6 beschreiben ihre Tabellen einmal, in share/db_schema.dba, und die Schemawerkzeuge des Kernels schreiben das SQL für jede Engine. Das ganze Verfahren steht in Datenbankschema und .dba-Dateien.

Wenn Sie zusätzlich Dateien in sql/<engine>/ behalten, geben Sie jeder Engine ihre eigenen: sql/mysql/, sql/postgresql/, sql/sqlite/.

Schritt 6: eZPersistentObject #

Für die eigenen Tabellen einer Erweiterung ersetzt eine Klasse, die eZPersistentObject erweitert, das meiste reine SQL und funktioniert auch auf MongoDB:

<?php
class myOldExtItem extends eZPersistentObject
{
    public static function definition()
    {
        return array(
            'fields' => array(
                'id' => array( 'name' => 'ID', 'datatype' => 'integer', 'default' => 0, 'required' => true ),
                'name' => array( 'name' => 'Name', 'datatype' => 'string', 'default' => '', 'required' => true ),
            ),
            'keys' => array( 'id' ),
            'increment_key' => 'id',
            'class_name' => 'myOldExtItem',
            'sort' => array( 'name' => 'asc' ),
            'name' => 'myoldext_item',
        );
    }

    public static function fetchList( $offset = 0, $limit = 50 )
    {
        return eZPersistentObject::fetchObjectList( self::definition(), null, null, null,
                                                    array( 'offset' => $offset, 'limit' => $limit ) );
    }
}

store(), remove() und fetchObject() kommen aus der Basisklasse. Das vollständige Kapitel ist Persistente Objekte und Ihre eigenen Tabellen.

PHP-8-Details im Datenbankcode #

Auf mehr als einer Engine testen #

Eine Entwicklungsinstallation auf SQLite ist in Minuten eingerichtet und der Standard, testen Sie also zuerst dort: Was auf SQLite und MySQL funktioniert, funktioniert meist überall sonst, außer auf MongoDB. Wenn die Benutzer Ihrer Erweiterung MongoDB einsetzen könnten, testen Sie auch dort, oder schreiben Sie in Ihrer README deutlich, dass die Erweiterung eine SQL-Datenbank braucht.

Verwandte Seiten #

• Zurück: Dynamische Eigenschaften
• Weiter: ezinfo.php und extension.xml modernisieren
• Datenbankunterstützung
• Persistente Objekte und Ihre eigenen Tabellen
• Datenbankschema und .dba-Dateien
• Freie Dokumentation: Diese Seite darf unter der GNU FDL 1.3 frei kopiert, übersetzt und verbessert werden.