Ansehen Datenbankabfragen
Datenbankabfragen sollten in Extensions nie über die normalen SQL-Befehle erfolgen. Gründe:
- die globale Datenbank-Abstraktionsschicht DBAL wird eingbezogen; heisst, die Extension läuft automatisch auch mit anderen Datenbanken als MySQL
- die Verbindung zur Datenbank muss nicht eigens erstellt und beendet werden
- die INSERT-Queries führen automatisch ein FullQuote durch (die Mindest-Absicherung gegen SQL-Injection)
- die verfügbaren Befehle sind zum Teil einfach bequem …
Funktionen aufrufen
Die Klassen müssen nicht initialisiert werden, es reicht, sie über die GLOBALS aufzurufen:
$GLOBALS['TYPO3_DB']->exec_SELECTquery( .... )
Absicherung gegen SQL-Injection
Alle Eingaben, die vom Besucher der Website kommen (also über GET oder POST) müssen vorher abgesichert werden. Das betrifft vor allem die Befehle zum Einfügen in die Datenbank, ausserdem aber auch die Übernahme von Benutzerdaten in die where-Abschnitte der SQL-Abfragen. Auch hier sollten die Typo3-Funktionen benutzt werden, damit die Quotierung für jede Datenbank passend erfolgt. Folgende Funktionen stehen zur Verfügung:
# Quotieren von Zeichenketten
$GLOBALS['TYPO3_DB']->fullQuoteStr( $str, $table );
Parameter
- string: Zeichenkette, die quotiert werden soll
- string: Tabellenname (daraus entnimmt DBAL die korrekte Quotierungstechnik)
# Quotieren von eindimensionalen Arrays:
$GLOBALS['TYPO3_DB']->fullQuoteArray( $arr, $table, $noQuote = FALSE );
Parameter
- array: eindimensionales oder assoziatives Array mit den Daten
- string: Tabellenname (daraus entnimmt DBAL die korrekte Quotierungstechnik)
- string/array: Liste oder Array von Schlüsseln, die nicht quotiert werden sollen. Nur bei assoziativen Datenarrays anwenden!
# kommaseparierte Listen zu Integerlisten umwandeln (über intval() )
$GLOBALS['TYPO3_DB']->cleanIntList( $list )
Parameter
- string: kommaseparierte Liste mit Werten, die Integer sein sollen
# Arraywerte zu Integer umwandeln (über intval() )
$GLOBALS['TYPO3_DB']->cleanIntArray( $arr )
Parameter
- array: Array mit Werten, die Integer sein sollen
Datenbankabfragen
# SELECT-Abfrage
$GLOBALS['TYPO3_DB']->exec_SELECTquery(
$select_fields,
$from_table,
$where_clause,
$groupBy = '',
$orderBy = '',
$limit = ''
)
Parameter
- string: Liste der Felder oder * für alle Felder
- string: Tabelle(n). Es gelten die üblichen SQL-Regeln für Aliase
- string: WHERE-Klausel. Wie in SQL üblich. ACHTUNG: man muss alle GET / POST-Werte hier selbst qotieren! Verwenden Sie $this->fullQuoteStr() – siehe oben. Hier nicht Befehle wie GROUP oder LIMIT verwenden.
- string: Optionale GROUP-Anweisung
- string: Optionale ORDER BY-Anweisung
- string: Optionale LIMIT-Anweisung.
# INSERT-Abfrage
$GLOBALS['TYPO3_DB']->exec_INSERTquery (
$table,
$fields_values,
$no_quote_fields = FALSE
)
Parameter
- string: Tabelle
- array: Feldwerte als array mit key=>value Paaren. Die Werte werden intern quotiert. Typischerweise verwenden Sie ein Array ”$insertFields” mit ‘fieldname’=>‘value’ und übergeben es als Argument.
- string/array: Liste oder Array von Schlüsseln, die nicht quotiert werden sollen; siehe ober bei fullQuoteArray()
# UPDATE-Abfrage
$GLOBALS['TYPO3_DB']->exec_UPDATEquery (
$table,
$where,
$fields_values,
$no_quote_fields = FALSE
)
Parameter
- string: Tabelle
- string: WHERE-Anweisung, typischerweise “uid=xx”. Achtung: Sie müssen alle GET- oder POST-Parameter hier selbst quoten – siehe oben.
- array: Feldwerte als array mit key=>value Paaren. Die Werte werden intern quotiert. Typischerweise verwenden Sie ein Array ”$insertFields” mit ‘fieldname’=>‘value’ und übergeben es als Argument.
- string/array: Liste oder Array von Schlüsseln, die nicht quotiert werden sollen; siehe ober bei fullQuoteArray()
# DELETE-Abfrage
$GLOBALS['TYPO3_DB']->exec_DELETEquery( $table, $where)
Parameter
- string Tabelle
- string WHERE-Anweisung, typischerweise “uid=xx”. Achtung: Sie müssen alle GET- oder POST-Parameter hier selbst quoten – siehe oben.
Spezielle Datenbank-Anweisungen
Die folgende Funktion eignet sich hervorragend zum Auswerten einer n-n Datenverbindung, wie sie zum Beispiel bei der Verwendung von Kategorien anfällt. Bedingung ist allerdings, dass die Verbindung mit einer m_m-Tabelle erfolgt und nicht über ein einzelnes Feld mit kommaseparierter ID-Liste.
# SELECT relational
$GLOBALS['TYPO3_DB']->exec_SELECT_mm_query(
$select,
$local_table,
$mm_table,
$foreign_table,
$whereClause = '',
$groupBy = '',
$orderBy = '',
$limit = ''
)
Parameter
- string: Liste der Felder oder * für alle Felder
- string: Name der lokalen Tabelle
- string: Name der Relationalen m_m-Tabelle
- string: Name der fremden, verknüpften Tabelle
- string: WHERE-Klausel. Wie in SQL üblich. ACHTUNG: man muss alle GET / POST-Werte hier selbst qotieren! Verwenden Sie $this->fullQuoteStr() – siehe oben. Hier nicht Befehle wie GROUP oder LIMIT verwenden. Es muss ein ’ AND ’ eingefügt werden.
- string: Optionale GROUP-Anweisung
- string: Optionale ORDER BY-Anweisung
- string: Optionale LIMIT-Anweisung.
Achtung: Viele Feldnamen in Typo3 sind identisch (uid, pid, hidden etc.). Das kann bei der Auswertung zu Problemen führen, da die Felder nicht eindeutig sind! Es ist deshalb sinnvoll, imm select- und für die Tabellennamen mit Aliasen zu arbeiten:
$GLOBALS['TYPO3_DB']->exec_SELECT_mm_query(
'a.uid as a_uid, b.uid as b_uid',
'tabelle_1 a',
'tabelle_m_m',
'tabelle_2 b',
$whereClause = '',
$groupBy = '',
$orderBy = '',
$limit = ''
)
Ein ganz besondere Funktion ist listQuery(): Sie ermöglicht eine einfache Behandlung von relationalen Verknüpfungen, die nicht über eine dritte m_m-Tabelle laufen sondern über Felder mit kommaseparierten Listen.
$GLOBALS['TYPO3_DB']->listQuery (
$field,
$value,
$table
)
Das Problem derartiger Verknüpfungen ist, dass die Abfrage über LIKE laufen muss, und dabei zusätzlich unterschieden werden muss, auf welcher Seite des gewünschten Wertes das Komma folgt. Kern der Funktion ist diese Zeile:
$where = '('.$field.' LIKE \'%,'.$command.',%\' OR '.$field.' LIKE \''.$command.',%\' OR '.$field.' LIKE \'%,'.$command.'\' OR '.$field.'=\''.$command.'\')';
Parameter
- string: Feldname, der die kommaseparierte Liste enthält
- string: Wert, der gefunden werden soll
- string: Tabelle, in der gesucht wird (für die korrekte Behandlung durch DBAL)
In die gleiche Richtung geht die folgende Funktion, die Srings für die LIKE-Abfrage korrekt für DBAL umsetzt:
$GLOBALS['TYPO3_DB']->escapeStrForLike( $str, $table )
Noch drei weitere Funktionen werden öfter gebraucht:
# Liefert eine Integer zurück mit der Anzahl der betroffenen Datenzeilen, z. B. bei INSERT oder UPDATE
$GLOBALS['TYPO3_DB']->sql_affected_rows( )
# Liefert eine Integer, die uid des zuletzt eingefügten Datensatzes (über INSERT)
$GLOBALS['TYPO3_DB']->sql_insert_id ( )
# Liefert eine Integer, mit der Anzahl der gefundenen Datensätze
$GLOBALS['TYPO3_DB']->t3lib_DB.sql_num_rows ( $res )
Parameter
- pointer: Der Resultpointer einer vorher erfolgten SELECT-Abfrage.
Weiterführende Links
- Typo3 Dokumentation Darin suchen nach »t3lib_DB«.
- t3lib_DB Class Reference (Achtung: geht ausserhalb seines Framesets auf).
Category:Typo3 -> Extensions -> Programmierung