FORM-API-DOC.html
CC-BY-NC SURASTO.de
Ralf Stoffels 2013
Das FORM Plugin
für MozilloCMS erzeugt persistente Formulare. Das heißt,
alle Eingaben bleiben erhalten, auch wenn das Formular verlassen wird. Damit
lassen sich auch Formulare erzeugen, die sich über mehrere Seiten erstrecken.
Die Eingaben werden in PHP Sessionvariablen
gespeichert und jeweils in den Feldern angezeigt, wenn man zu dem Formular
zurückkehrt.
Beispiel:
Verwendung des FORM Plugins
in MozilloCMS Dokumenten
{FORM|BEGIN,background.png}
[ueber2|
Überschrift]
{FORM|INPUT,Eingabe,,5,10,460,110}
{FORM|END}
FORM|BEGIN,<bild-datei>,<PHP-Script-Datei>
Öffnet ein neues Formular.
<PHP-Script-Datei> Die Bild-Datei wird als Hintergrund verwendet. Damit kann man z.B.
Grafiken mit anzeigen als
Hilfestellung im Formular.
Die Grafik wird sooft wiederholt, bis die benötigte Bildgröße des Formulars
gefüllt ist.
Wichtig: Die Bilddatei muss im /dateien Verzeichnis liegen, dass zu der Kategorie gehört,
in dem diese Seite abgelegt ist.
<PHP-Script-Datei> Diese Datei wird eingebunden, so dass alle
ihre Funktionen mit dem Befehl FORM|FUNCTION
aufgerufen
werden können.
Wichtig: Die Datei muss im Verzeichnis
/dateien in derselben Kategorie gespeichert sein, wie
die
Seite, auf der dieser FORM|BEGIN-Befehl verwendet wird.
FORM|BUTTON,<text>,<script>,<X-Position><Y-Position>
Platziert einen Button im Formular. <text> wird im Button angezeigt.
Wichtig: Die Script-Datei muss im
Verzeichnis /dateien in derselben Kategorie
gespeichert sein, wie die Seite, auf der
dieser FORM|BUTTON-Befehl
verwendet wird.
Durch Drücken des Knopfes wird das
angegebene Skript ausgeführt.
<X-Position> Position
in Pixel in x-Richtung im aktuellen Frame. Hiermit kann das Eingabefeld pixelgenau
positioniert werden.
<Y-Position> Dito
in Y-Richtung.
FORM|INPUT,<ID>,<text>,<size>,<maxLength>,<X-Position>,Y-Position>
Erzeugt ein Eingabefeld für
String-Eingaben.
<ID> Es wird eine PHP Session Variable erzeugt mit dem
Inhalt der Eingabe, die
dann von einem
anderen PHP Skript gelesen werden kann. Es wird immer
der letzte
Eingabewert wieder angezeigt. So bleiben die Eingaben auch erhalten,
wenn die Seite
zwischenzeitlich verlassen wird.
<text> Optionaler Fragetext.
Z.B. Adresse:
<size> Breite des Eingabefeldes in Zeichen
<maxLength> Maximale Zeichen dieses Eingabefeldes
<X-Position> Position
in Pixel in x-Richtung im aktuellen Frame. Hiermit kann das Eingabefeld
pixelgenau positioniert werden.
<Y-Position> Dito
in Y-Richtung.
Wenn X- und Y-Position leer gelassen werden, dann
erscheint das Eingabefeld an der aktuellen Stelle im Text.
FORM|SELECT,<ID>,<X-Pos>,<Y-Pos>,<item1>,<item2>,<item3>,…,<itemX>
Selektor Pulldown-Menü
<ID> Es
wird eine PHP Session Variable angelegt, die das Ergebnis der Selektion
speichert.
<X-POS> Pixelposition
im aktuellen Frame in X-Richtung (optional)
<Y-POS> Pixelposition
im aktuellen Frame in Y-Richtung (optional)
<item> Beliebige
Anzahl von Strings, aus denen gewählt werden kann.
FORM|SELECTLIST,<ID>,<X-Pos>,<Y-Pos>,<datei-name>
Selektor Pulldown-Menü bei dem
die Auswahlliste aus einer Datei gelesen wird.
<ID> Es
wird eine PHP Session Variable angelegt, die das Ergebnis der Selektion
speichert.
<X-POS> Pixelposition
im aktuellen Frame in X-Richtung (optional)
<Y-POS> Pixelposition
im aktuellen Frame in Y-Richtung (optional)
<datei-name> Die
Items werden aus einer Datei gelesen. Jede Zeile der Textdatei wird als
einzelnes
Item interpretiert.
FORM|RADIO,<ID>,<X-Pos>,<Y-Pos>,<item1>,<item2>,<item3>,…,<itemX>
Radiobuttons
<ID> Es
wird eine PHP Session Variable angelegt, die das Ergebnis der Selektion
speichert.
<X-POS> Pixelposition
im aktuellen Frame in X-Richtung (optional)
<Y-POS> Pixelposition
im aktuellen Frame in Y-Richtung (optional)
<item> Beliebige
Anzahl von Strings, aus denen gewählt werden kann.
FORM|DISPLAY,<ID>,<X-Pos>,<Y-Pos>
<ID> Es
wird der Inhalt einer PHP Session Variable angezeigt.
<X-POS> Pixelposition
im aktuellen Frame in X-Richtung (optional)
<Y-POS> Pixelposition
im aktuellen Frame in Y-Richtung (optional)
FORM|PLOT,<ID>,<X-Pos>,<Y-Pos>,<X-Size>,<Y-Size>,GRID
<ID> Es
wird der Inhalt einer PHP Session Variable graphisch angezeigt
Namenskonvention:
<ID>_x enthält die x-Werte
<ID>_y enthält die y-Werte
Beispiel: $koord_x = array(1,2,4,6,7,8,9);
$koord_y = array(18,29,34,16,7,48,19);
<X-POS> Pixelposition
im aktuellen Frame in X-Richtung
<Y-POS> Pixelposition
im aktuellen Frame in Y-Richtung
<X-Size> Pixelgröße
des Anzeigebereichs im aktuellen Frame in X-Richtung
<Y-Size> Pixelgröße
des Anzeigebereichs im aktuellen Frame in Y-Richtung
GRID Es
wird ein Gitternetz angezeigt mit 20 Pixel
Gitterabstand (optional)
FORM|FUNCTION
Führt beim Laden der Seite eine PHP Funktion aus. Hierzu muss die entsprechende
PHP-Datei vorher eingebunden
werden. Das geschieht im FORM|BEGIN Befehl (siehe oben).
FORM|END
Ende des Formulars