Installation

Upload der Dateien:

Alle Php-Dateien der Txt-Db-Api sind in ein (und das gleiche) Verzeichnis hochzuladen.

Ändern der Datei txt-db-api.php

Die Datei txt-db-api.php ist vor dem upload anzupassen. In dieser Datei sind
die beiden Variabeln $API_HOME_DIR und $DB_DIR auf den richtigen Wert zu
setzten:

$API_HOME_DIR:
Diese Variable muss auf den absoluten oder relativen Pfad zu den Txt-Db-Api Dateien zeigen.
z.B. /home/c-worker.ch/public_html/php-api/
Für mehr Infos zur Pfadangabe siehe unten.

 

$DB_DIR:
Diese Variable muss auf den absoulten oder relativen Pfad zeigen, unter welchem sich die Datenbank
Ordner befinden. Hat man zB einen Datenbank Ordner unter /home/c-worker.ch/dbs/TestDB
so muss man $DB_DIR auf /home/c-worker.ch/dbs/ setzten. Im Ordner /home/c-worker.ch/dbs/
können nun beliebig viele Datenbank-Ordner erzeugt werden.

Wichtig: Die Datei txt-db-api.php ändert sich nicht in neuen Versionen. Ihr braucht also NICHT bei
jeder neuen Version die Datei txt-db-api.php zu überschreiben und zu ändern. Behaltet einfach
die alte! Falls sie sich mal ändern sollte wir das im changelog und unter den news deutlich stehen!

 

Absolute oder relative Pfade für API_HOME_DIR und DB_DIR

Grundsätzlich hat man zwei Möglichkeiten die Verzeichnisse in den $API_HOME_DIR und $DB_DIR Variabeln
anzugeben. Man kann entweder relative (relativ zum Verzeichniss der Datei welche "txt-db-api.php" include't)
oder absolute Verzeichnisse (relativ zum Server root) verwenden.

Wenn man eine absolute Pfadangabe verwendet, so beötigt man nur eine txt-db-api.php - Datei.
Diese sollte man bei den andern Dateien der Text-Db-Api platzieren.
Dies ist auch der Standard-Ort der Datei nach dem extrahieren des Zip-Files.

Falls man eine relative Pfadangabe verwendet, ist es SEHR EMPEHLENSWERT für jedes Projekt eine
eigene txt-db-api.php - Datei zu verwenden. Diese plaziert man dann direkt im Ordner des jeweligen
Projektes. Dies ist deshalb nötig, da unterschiedliche Projekte einen anderen Relativen Pfad zur
API und zum Datanbank-Verzeichniss haben können. Mann muss nun natürlich darauf achten, auch
das entsprechende txt-db-api.php file zu includen, also dasjenige welches nun im Projekt Ordner liegt.
So muss nun jedes Projekt sein eigenes txt-db-api.php file includen, welches im gleichen Pfad wie
das Projekt liegt.
Im Ordner der API (dort wo Database.php, etc.) benötigt man dann eigentlich keine txt-db-api.php Datei mehr.

Natürlich kann man auch bei absoluten Pfaden für jedes Projekt ein eigenes txt-db-api.php File verwenden.
Dies könnte z.B. dann nützlich sein wenn die jeweiligen Projekte einen unterschiedlichen Datenbank-Root
Ordner haben.