Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Jede PIFA-XML-Datei besteht aus genau einem "pifa"-Element mit genau einem "form"-Element. Optional kann auch genau maximal ein "data"-Element enthalten sein. Das "form"-Element samt Nachfahren beschreibt die Struktur des Formulares, wogegen das "data"-Element die erfaßten Formulardaten dokumentiert.

...

Das "form"-Element dient der Definition des Formulares als solches. Diese Angaben dazu werden als Attribute gespeichert. Zudem enthält es (optional) "field"-Elemente zur Definition der einzelnen Formularfelder welche weiter unten erläutert werden. Das "form"-Element unterstützt folgende Attribute:

AttributWerteBeschreibung
nameZeichenketteDer Name des Formulares, so wie es er im Backend in der linken Navigation ausgegeben wird.
tableZeichenketteDer Name der Datenbank-Tabelle zur Speicherung der Formulardaten.
methodget | postAnfragemethode beim Absenden des Formulares.
timestamptrue | falseOb beim Speichern von Formulardaten auch ein Zeitstempe Zeitstempel erfaßt werden soll. Siehe Setting "pifa/timestamp".

FIELD - Struktur der Formularfelder

Für jedes Formulareld Formularfeld wird genau ein "field"-Element definiert. Einige Angaben zum Formularfeld werden als Attribute, andere als Kindelemente definiertnotiert. Das "field"-Element unterstützt folgende Attribute:

AttributWerteBeschreibung
rankZahl

Die Position des Formularfeldes im Formular.

Info
Die Reihenfolge der Felder in der XML-Datei ist dabei irrelevant. Einzig dieses Attribut entscheidet über die Reihenfolge der Felder im Formular.
typeinputtext, textarea, inputpassword, inputradio, inputcheckbox, select, selectmulti, datepicker, inputfile, processbar, slider, buttonsubmit, buttonreset, buttonback, matrix, paragraph, inputhidden, fieldset_begin, fieldset_endDer Typ des Formularfeldes, der auch den Tabentyp Tabellentyp der Datenbank-Spalte bestimmt.
columnZeichenkette (erlaubt sind hier die Zeichen a-z, A-Z, 0-9 und _ [Unterstrich])Der Name der Datenbank-Spalte zur Speicherung der Formulardaten.
obligatorytrue | falseOb es sich bei diesem Feld um ein Pflichtfeld handelt oder nicht.

...

ElementWerteBeschreibung
labelZeichenkette

Die Beschriftung des Formularfeldes, so wie sie im Frontend ausgegeben wird.

Info
Dieses Element hat ein Attribut "display" (true oder false) mit dem definiert werden kann, ob die Beschriftung im Frontend ausgegeben werden soll oder nicht.
helpZeichenkette

Der optionale Hilfetext zu einem Formularfeld.

Info
Der Wert dieses Elementes muß als CDATA notiert werden!
errorZeichenkette

Die optionale Fehlermeldung zu einem Formularfeld.

Info
Der Wert dieses Elementes muß als CDATA notiert werden!
ruleZeichenkette

Die optionale Validierungsregel zu einem Formularfeld. Hierbei handelt es sich um einen regulären Ausdruck.

Info
Der Wert dieses Elementes muß als CDATA notiert werden!
classes"class"-Elemente

Mit dem Element "classes", das weitere "class"-Elemente enthält, werden die Namen der CSS-Klassen definiert die für ein Formularfeld ausgegeben werden sollen.

Code Block
languagexml
linenumberstrue
<classes>
	<class>foo</class>
	<class>bar</class>
</classes>
options"option"-Elemente

Mit dem Element "classesoptions", das weitere "classoption"-Elemente enthält, werden die Optionen für Formularfelder der Typen inputradio, select und selectmulti definiert. Deren Wert gibt die Beschriftung an, die im Frontend ausgegeben wird, wogegen deren "value"-Attribut den Wert angibt, der in der Datentabelle gespeichert wird.

Code Block
languagexml
linenumberstrue
<options>
	<option value="1">foo</option>
	<option value="1">bar</option>
</options>

Wenn die Optionen higegen aus einer externen Datenquelle bezogen werden sollenWird sollen, wird das "options"-Element mit dem Attribut "source" anstelle von "option"-Elementen notiert. Dieses enthält dann den Namen der Extension-Klasse die zum Bezug der Options verwendet wird.

Code Block
languagexml
linenumberstrue
<options source="YourFancyDataSourceClass" />