# Tutorial 1: Die txt-db-api benutzen

Die API ist sehr einfach zu benutzen. Typischerweise ist eine PHP-Seite welche die API verwendet
folgendermassen aufgebaut:

## 1. Txt-Db-Api Includen

    <?php

    include ("../php-api/txt-db-api.php");

Wichtig ist das der Pfad zu der txt-db-api.php Datei stimmt. Je nachdem wo man die API installiert
hat, und wo sich die bearbeitete PHP Datei befindet könnte dieser auch etwas länger
werden, dafür ist es die einzige Include Anweisung die man benötigt.

## 2. Datenbank-Objekt erzeugen

Wenn man die Installation korrekt ausgeführt hat und von Hand (via FTP) einen entsprechenden
Ordner erzeugt hat, so kann man nun ein Database Objekt erzeugen. Dabei muss im
Konstruktor immer der Name der Datenbank angegeben werden (Achtung Gross-klein schreibung):

    $db = new Database("MeineDatenbank");

##
3. SQL Statements absetzten

Hat man einmal ein Database Objekt so kann man nun darauf beliebig viele
SQL-Statements ausführen. Dies geschieht mit der Methode executeQuery()

    $rs=$db->executeQuery("SELECT name, vorname, plz AS daWohntEr FROM Personen WHERE plz='1234' ORDER BY name; ");

Das ";" am Ende des SQL-Strings ist übrigens freiwillig. Je nach Typ des Statements wird executeQuery() einen anderen Wert
zurückgeben, der dan Ausgewertet werden kann.

## 4. ResultSet Daten anzeigen (Nur bei SELECT Statements)

Falls es ein SELECT Statement war, bekommt man ein ResultSet Objekt zurück, welches die Daten enthält.
Diese Daten können nun auf unterschiedliche Arten abgefragt werden.
Überlicherweise wird man wohl folgende while-Schleife verwenden:

    while($rs->next()) {

Mit next() wird im ResultSet automatisch zur nächsten Reihe gewechselt.
(Vor dem ersten next() aufruf ist die Position nicht am Anfang, sondern 1 vor dem Anfang, somit
gelagt man mit dem ersten next() Aufruf auch zur ersten Reihe (Datensatz)).

Innerhalb dieser Schleife kann man nun bequem mit getCurrentValues/getCurrentValueByName oder getCurrentValueByNr
die Daten der aktuellen Reihe abfragen.

    	list($name,$vorname,$PostLeitZahl)=$rs->getCurrentValues();
    	echo "$name $vorname  kommt aus  $PostLeitZahl";
    }