Zugriff auf Tabellen mit TableAccess [Admidio-Wiki]

Diese Seite ist nicht editierbar. Sie können den Quelltext sehen, jedoch nicht verändern. Kontaktieren Sie den Administrator, wenn Sie glauben, dass hier ein Fehler vorliegt.
====== Zugriff auf Tabellen mit TableAccess ======
==== Wie erstelle ich ein Objekt der Klasse ? ====
Für den Zugriff auf einzelne Datensätze aus Datenbanktabellen stellt Admidio die **TableAccess**-Zugriffsklasse zur Verfügung. Damit wird der Zugriff und die Pflege einzelner Datensätze erheblich vereinfacht. Diese Dokumentation beschreibt Funktionen ab Version 2.2 .

Die Klasse kann auf jede Datenbanktabelle angewandt werden. Willst du zum Beispiel mit einem Datensatz der folgenden Tabelle **MeineTabelle** arbeiten:<code sql>create table adm_MeineTabelle
(
   meine_id            int(11) unsigned not null AUTO_INCREMENT,
   meine_name          varchar(255)     not null,
   meine_geburtstag    datetime,
   meine_adresse       varchar(255)     not null
)</code>, so wird das Objekt wie folgt erstellt: <code php>$meinTabellenObjekt = new TableAccess($gDb, 'MeineTabelle', 'meine', 5);</code> **$gDb** ist dabei das [[de:entwickler:datenbankzugriffsklasse|Admidio-Objekt für den Zugriff auf die Datenbank]]\\ 
**MeineTabelle** ist der Tabellenname der Tabelle auf die Zugegriffen werden soll\\ 
**meine** ist das Spaltenpräfix der Tabelle\\ 
**5** wäre in diesem Fall die Nummer der **meine_id**, die ausgelesen werden soll. Dieser Parameter ist optional und kann auch erst einmal nicht angegeben werden. Dann kann später über folgende Methode der Datensatz eingelesen werden:<code php>$meinTabellenObjekt->readData(5);</code>

==== Wie kann ich Daten auslesen und ändern ? ====
Ist das Objekt mit einer bestimmten ID eingelesen, so können die Inhalte der einzelnen Spalten wie folgt ausgelesen werden:<code php>$name = $meinTabellenObjekt->getValue('meine_name');
$adresse = $meinTabellenObjekt->getValue('meine_adresse');</code>
Eine Besonderheit gibt es bei Datums- und Zeitspalten. Hier kann als zweiter Parameter das Format (siehe [[http://de.php.net/manual/de/function.date.php|date()]] ) übergeben werden. Wird es nicht übergeben, so wird automatisch das Format aus den Organisationseinstellungen zurückgegeben.<code php>// Format in Organisationseinstellungen z.B. d.m.Y
$geburtstag = $meinTabellenObjekt->getValue('meine_geburtstag');
echo $geburtstag // 20.02.1983
$geburtstag = $meinTabellenObjekt->getValue('meine_geburtstag', 'Y/m/d');
echo $geburtstag // 1983/02/20</code>
Daten ändern und speichern geht dann so:<code php>$meinTabellenObjekt->setValue('meine_name', 'Mustermann');
$meinTabellenObjekt->setValue('meine_adresse', 'Musterstraße 129');
$meinTabellenObjekt->save();</code>
Auch beim Speichern gibt es für Datum- und Zeitfelder eine Besonderheit. Hier **muss** das Datum nach [[http://de.wikipedia.org/wiki/ISO_8601|ISO 8601]] **Y-m-d** //1983-02-20// übergeben werden.

==== Wie lege ich einen neuen Datensatz an ? ====
Einen neuen Datensatz anlegen funktioniert eigentlich genauso, wie einen Datensatz zu verändern. Es darf vorher nur nicht mit einer ID ein Datensatz eingelesen werden. <code php>$meinTabellenObjekt = new TableAccess($gDb, 'MeineTabelle', 'meine');
$meinTabellenObjekt->setValue('meine_name', 'Musterfrau');
$meinTabellenObjekt->setValue('meine_adresse', 'Musterweg 43');
$meinTabellenObjekt->save();</code>Schon ist ein neuer Datensatz angelegt worden. Falls man schon ein Objekt der Tabelle besitzt und kein neues Anlegen möchte/muss, so kann man auch einfach die Methode **clear** auf das vorhandene Objekt anwenden und danach die Daten belegen:<code php>$meinTabellenObjekt->clear();
$meinTabellenObjekt->setValue('meine_name', 'Musterfrau');
$meinTabellenObjekt->setValue('meine_adresse', 'Musterweg 43');
$meinTabellenObjekt->save();</code>

==== Wie kann ich Änderungszeitstempel und Benutzer bequem speichern ? ====
Die **TableAccess**-Klasse kann den Zeitstempel und die Benutzer-ID desjenigen speichern, der den Datensatz angelegt, sowie desjenigen, der ihn als letztes geändert hat. Dazu müssen die entsprechenden Spalten in der Tabelle nur einem bestimmten Namenschema folgen. Die Aktualisierung der Felder wird dann komplett von der Klasse erledigt, sobald die Methode **save()** aufgerufen wird. 
Die Felder müssen wie folgt definiert sein:<code sql>meine_usr_id_create       int(11) unsigned,
meine_timestamp_create    datetime,
meine_usr_id_change       int(11) unsigned,
meine_timestamp_change    datetime</code>Der Spaltenname fängt mit dem Tabellenpräfix an und besitzt dann einen der folgenden Namen **usr_id_create**, **timestamp_create**, **timestamp_change** und **timestamp_change**.

Möchte man die Aktualisierung der Felder an einer bestimmten Stelle nicht vornehmen lassen, so kann man dies durch folgenden Aufruf erreichen: <code php>$meinTabellenObjekt->save(false);</code>

==== Welche Methoden stehen zur Verfügung ? ====
Folgende Methoden stehen durch die TableAccess-Klasse zur Verfügung und können von abgeleiteten Klassen erweitert werden:
  * **readData** liest den entsprechenden Datensatz aus der Datenbank aus. Mit speziellen Übergaben kann hier das SQL-Statement noch verändert werden (Bsp: roles_class.php)
  * **clear** initialisiert alle eingelesenen Daten. Die Methode kann in der spezifischen Klasse abgeleitet werden um dort dann noch weitere Daten zu initialisieren (Bsp: organization_class.php)
  * **setArray** hat man selber die Daten vorher in ein Array eingelesen, kann man dieses Array an die Klasse übergeben und diese arbeitet dann mit den Daten weiter. Macht Sinn, wenn man Daten im Script über eine Schleife einliest, aber auf Methoden der Klasse zugreifen will
  * **setValue** will man einen Wert verändern, sollte dies über diese Methode laufen. Die Methode kann in der spezifischen Klasse abgeleitet werden um dort spezielle Prüfungen z.B. is_numeric auf übergebene Daten anzuwenden (Bsp: roles_class.php)
  * **getValue** gibt einen Wert zurück. Die Methode kann in der spezifischen Klasse abgeleitet werden um dort ggf. noch andere Daten zu setzen (Bsp: users_class.php)
  * **save** die Methode prüft, ob Daten verändert wurden und diese in die Datenbank zurückgeschrieben werden müssen. Die Methode kann in der spezifischen Klasse abgeleitet werden, falls vor einem Update/Insert noch Daten vorbelegt werden sollen/können. Macht z.B. Sinn, wenn der User mit Uhrzeit gespeichert wird, der die letzte Änderung gemacht hat. (Bsp: dates_class.php)
  * **delete** löscht den aktuellen Satz aus der Datenbank. Die Methode kann in der spezifischen Klasse abgeleitet werden, falls vorher noch andere Daten (Referenzen) gelöscht oder verändert werden müssen (Bsp: roles_class.php)

Intern werden alle aus der Tabelle ausgelesenen Daten in einem Array **$db_fields** gespeichert. Wer also an bestimmten Stellen schnellern Zugriff auf alle Daten braucht, kann auch direkt auf das Array zugreifen.