Dokumentation mit Beispielen

Einfache Aufrufe

Aufrufe beziehen sich auf ein öffentliches Informationsobjekt eines Users. Ohne Versionsangabe wird standardmäßig die letzte, bzw. aktuellste Version ausgeliefert.

Ein einfacher Beispielaufruf sieht so aus:

<script type="text/javascript" src="/includebase/io-controller/io.php?username=a&object_name=io1&mode=JS"></script>

Falls man auf einen anderen Server als localhost zugreift, muss dieser inklusive http oder https angegeben werden. Wichtig ist, dass mindestens der username und der object_name angegeben werden. In den meisten Fällen wird man den Text in Form eines Javascripts ausgeben wollen, daher wird mit mode=JS gesagt, dass um den Text ein document.write("%TEXT%"); gelegt werden soll.

Test io1: Ähoi Ahoi!
Test io2: ich bin ein io!

Aufruf des Erstellungsdatum einer Version und Anzahl der Versionen

Das Datum einer Version wird mit dem zusätzlichen GET-Parameter get_creationtime angefordert. Im folgenden Beispiel bezieht sich das auf die letzte Version, da dazu keine Angaben gemacht wurden:

<script type="text/javascript" src="/includebase/io-controller/io.php?username=a&object_name=io1&get_creationtime&mode=JS"></script>

Die Anzahl der Versionen eines Informationsobjektes kann mit dem GET-Parameter get_number_of_versions ermittelt werden:

<script type="text/javascript" src="/includebase/io-controller/io.php?username=a&object_name=io1&get_number_of_versions&mode=JS"></script>

Zusammengesetztes Beispiel:

Das Informationsobjekt namens io1 hat in der aktuellen Version 10 den Wert Ähoi Ahoi! und wurde zum Zeitpunkt 2010-03-08 21:03:40 erstellt.

Offset/Versions Kombinationen

Es kann auch direkt eine spezielle Version abgerufen werden. Dazu kann man ausgehend von der Version einen Offset dazuaddieren lassen. Der Offset kann natürlich auch negativ sein. Wird nur Offset angegeben, wird die letzte Version als Basisversion eingesetzt.

Beispiele

<script type="text/javascript" src="/includebase/io-controller/io.php?username=a&object_name=io3&version=2&offset=-1&mode=JS"></script>

Ausgabe: v1

<script type="text/javascript" src="/includebase/io-controller/io.php?username=a&object_name=io3&version=2&mode=JS"></script>

Ausgabe: v2

<script type="text/javascript" src="/includebase/io-controller/io.php?username=a&object_name=io3&offset=-2&mode=JS"></script>

Ausgabe: v1

Datum und Uhrzeit

Ein Informationsobjekt kann auch in Abhängigkeit eines Datums angezeigt werden. So wird die Version des Informationsobjekt angezeigt, die zum angegebenen Datum und Uhrzeit aktuell war. Eingeschaltet wird die Ausgabe durch den GET-Parameter date. Das Format lautet yyyy-mm-dd_hh-nn-ss. y ist eine Jahreszahl, m der Monat, d der Tag, h die Stunde, n die Minute und s die Sekunde. Versions- oder Offsetparameter dürfen in diesem Zusammenhang nicht verwendet werden.

Beispiel:

<script type="text/javascript" src="/includebase/io-controller/io.php?username=a&object_name=io1&date=2010-03-07_13:35:59&mode=JS"></script>

Folgende dynamische Ausgabe ist beispielsweise realisierbar:

Der akademische Titel von <script type="text/javascript" src="/includebase/io-controller/io.php?username=a&object_name=academic_title&mode=JS"></script> <script type="text/javascript" src="/includebase/io-controller/io.php?username=a&object_name=vorname&mode=JS"></script> <script type="text/javascript" src="/includebase/io-controller/io.php?username=a&object_name=name&mode=JS"></script> war am 07. März 2010 um 18:14:10 Uhr <script type="text/javascript" src="/includebase/io-controller/io.php?username=a&object_name=academic_title&date=2010-03-07_18:14:10&mode=JS"></script>.

Ausgabe: Der akademische Titel von Dr.-Ing. Max Mustermann war am 07. März 2010 um 18:14:10 Uhr Dipl.-Inf..

Alle Versionen ausgeben

Es gibt auch eine Möglichkeit alle Versionen eines Informationsobjekts in einer selbstdefinierten Schleife mit Hilfe von Javascript auszugeben. Zum Beispiel für eine News-Seite oder etwas Blogähnliches oder Statusmeldungen.. Dazu muss ein Script am besten im Headbereich inkludiert werden. Zum Beispiel so:

<script type="text/javascript" src="/includebase/io-controller/io.php?username=a&object_name=news&mode=allDataAsJSFunction"></script>

Durch den GET-Parameter mode=allDataAsJSFunction wird ein dynamisch generiertes Java-Script eingebunden. Dieses JavaScript enthält drei Funktionen. Die Funktionen beginnen mit dem Namen des Informationsobjekts gefolgt von einem Unterstrich. Die Funktionen lauten:

[name_des_informationsobjekts]_getNumberOfVersions()
[name_des_informationsobjekts]_information(version)
[name_des_informationsobjekts]_created(version)

Sind die Funktionen inkludiert, kann auf alle Versionen zugegriffen werden. Durch die Funktion getNumberOfVersions() könnten auch alle Versionen mit Hilfe einer For-Schleife in Javascript ausgegeben werden. Zum Beispiel so:

<script>
document.write(news_getNumberOfVersions()+' Objekte<br /><br />');
for (var i=0; i<io2_getNumberOfVersions(); i++){
   document.write(news_created(i+1)+'<br />');
   document.write(news_information(i+1)+'<br /><br />');
}
</script>

Das erzeugt folgende Ausgabe:
3 Objekte

2010-03-07 19:15:09
Es ist 19:15 Uhr

2010-03-07 19:15:23
Jetzt ist es etwas später.

2010-03-07 19:15:35
Noch später!