[ ]  Die IBPS Mini Module - Feedback Modul

Funktionsweise des Skriptes
Dieses Skript arbeitet in einer etwas anderen Weise, als die normalen Feedback-Skripte. Um Pflichtangaben des Formulars zu definieren, werden Präfixe vor dem eigentlichen Namen der Variablen in den Formular-Tags gesetzt. Bei der Verarbeitung werden dann diese Tags aus dem Formular der HTML-Seite eingelesen und die übergebenen Daten daraufhin überprüft. Sollte ein Wert nicht der Vorgabe entsprechen, wird der entsprechende Tag im Formular der HTML-Seite gekennzeichnet. Das Skript orientiert dabei am Namen des jeweiligen Formulars. Die Fehlermeldung kann beliebig auf der HTML-Seite des Formulares mit einem Platzhalter positioniert werden.

1. Installation
Die Dateien werden einfach entsprechend den Verzeichnissen entpackt. Es entsteht ein Verzeichnis '_feedback' und ein Unterverzeichnis '_templates'.

2. Konfiguration
Um das Skript funktionsfähig zu machen, müssen folgende Skripteinträge modifiziert werden:

a) Konstanten

HTTP_SERVER		IP-Adresse oder Domain des Servers, auf dem das Skript läuft.
MODULE_DIR		Pfad zum Modulverzeichnis, referenziert vom Root-Verzeichnis, aber ohne führenden Slash.
TEMPLATE_DIR		Pfad zum Template-Verzeichnis, referenziert vom Modulverzeichnis (kann im Regelfalle unverändert bleiben).
ERROR_TEXT		HTML-Code, welcher bei einer Fehlermeldung in die Formularseite eingesetzt wird.
ERROR_MARKER		HTML-Code oder Zeichen, mit dem die Eingabefelder gekennzeichnet werden, die nicht korrekt oder noch nicht bearbeitet worden sind.

b) Variablen

Diese Variablen werden dann genutzt, wenn keine entsprechenden Vorgaben im Formular gemacht wurden.

$defaultSender		Default Absende-E-Mail-Adresse des Skriptes.
$defaultRecipient		Default Empfänger-E-Mail-Adresse des Skriptes.
$defaultReplyTo		Default ReplyTo-E-Mail-Adresse des Skriptes.
$defaultSubject		Default Betreff-Zeile (Subject) der Mail.
$defaultMailTpl		Default Mail-Template.
$defaultErrorPage		Default HTML-Seite, welche bei Versende-Fehlern angezeigt wird.
$defaultSuccessPage		Default HTML-Seite, welche bei erfolgreicher Versendung der Mail angezeigt wird.
$defaultFormPath		Default Pfad der HTML-Seite, welche das Formular enthält.
$defaultFormName		Default Name des Formulars (Analog zum Name-Attribut im FORM-Tag).

3. Integration in die Website
Das Formular besteht aus verschiedenen Komponenten: Input-Tags zur Deklaration wichtiger Variablen,  Input-Tags für frei definierbare Variablen und einem Platzhalter für die Fehlermeldung. Es ist zwingend erforderlich, dass ein Formularname angegeben wird, da sich das Skript bei der Verarbeitung auf diesen Namen bezieht.

a) Input-Tags zur Deklaration wichtiger Variablen

Folgende Variablen dienen dazu die o.g. Defaultwerte zu ersetzen bzw. dem Formular wichtige Angaben zur Verarbeitung zu liefern. Üblicherweise werden diese Angaben in der folgenden Form gemacht:

<INPUT TYPE="hidden" NAME="name_of_variable" VALUE="value_of_variable">

Wenn gewünscht, kann dies natürlich auch durch einen anderen Formular-Tag geschehen.

Mögliche Variablen:

formName		Name des Formulars (Analog zum Name-Attribut im FORM-Tag).
formBase		IP-Adresse oder Domainname des Servers, auf dem die HTML-Seite mit dem Formular abgelegt ist. Form: http://www.yourdomain.com/
formPath		Pfad zur HTML-Seite, welche das Formular enthält. Es wird vom Root-Verzeichnis referenziert, mit führendem Slash.
formSuccessPage		Pfad zur HTML-Seite, welche bei erfolgreicher Verarbeitung angezeigt werden soll. Es wird vom Root-Verzeichnis referenziert, mit eibnem führenden Slash.
formErrorPage		Pfad zur HTML-Seite, welche bei einem Versendefehler angezeigt werden soll. Es wird vom Root-Verzeichnis referenziert, mit einem führenden Slash.
mailTemplate		Pfad zum Mail-Template. Es wird vom Root-Verzeichnis referenziert, mit einem führenden Slash.
recipientEmail		E-Mail-Adresse des Empfängers. Dieser bekommt alle eingebenen Daten des Skriptes zugesandt.
senderEmail		Absender-E-Mail-Adresse für das Skript.
replyTo		ReplyTo-E-Mail-Adresse des Skriptes.
subject		Betreff-Zeile (Subject) der E-Mail.

Zur Sicherheit gegen Eingabefehler bei den E-Mail-Adressen, werden diese vom Skript überprüft. Zu beachten ist, dass bei der Verwendung der Hidden-Input-Tags eine Fehlermeldung erscheinen kann und kein Formularfeld markiert ist. Sollten die Variablen leer oder nicht vorhanden sein, werden diese mit den Defaultwerten besetzt. Aus Sicherheitsgründen ist die Arbeitsweise mit den Defaultwerten zu empfehlen.

b) Input-Tags für frei definierbare Variablen

Sie können beliebige Variablen verwenden. Eine Einschränkung ist hierbei aber zu machen: Bitte verwenden Sie keine Unterstriche im Variablennamen, da diese für die Präfixe verwendet werden und es sonst zu Fehlern bei der Skriptverarbeitung kommen kann. Die Präfixe dienen dazu bestimmte Formular-Tags als Pflichtfelder zu definieren und deren Eingabeformat vorzugeben.

_  (Unterstrich)		Ein einfacher Unterstrich vor dem Variablennamen definiert dieses Feld als ein Pflichtfeld. Ist dieses Feld nicht ausgefüllt, kommt es zu einer Fehlermeldung. Bsp.: _name
e_ (e Unterstrich)		Dies definiert ein Formularfeld als ein E-Mail-Pflichtfeld. Ist das Format der E-Mail Adresse nicht korrekt oder das Feld leer, kommt es zu einer Fehlermeldung. Bsp.: e_email
n_ (n Unterstrich)		Hiermit wird ein Pflichtfeld definiert, welches nur numerische Werte zuläßt. Bsp.: n_telefonnummer
c_ (c Unterstrich)		Dieser Präfix definiert ein Pflichtfeld, welches nur die Zeichen a-z, A-Z, -, Punkt und Leerzeichen zuläßt. Bsp.: c_vorname

Werden Variablen ohne Präfix geführt, dann werden diese bei der Verarbeitung nicht geprüft.

c) Platzhalter für die Fehlermeldung

Um eine Fehlermeldung auf der HTML-Seite (welche das Formular enthält) zu einzublenden, wenn Formularfelder nicht korrekt ausgefüllt wurden, kann ein Platzhalter beliebig auf dieser HTML-Seite plaziert werden. Das Skript wird den Platzhalter durch einen im Skript definierten Fehlertext ersetzen. Dieser Fehlertext kann auch HTML enthalten.

Der Platzhalter hat folgendes Format:
<%FormErrorText NAME="name_of_form"%>

'name_of_form' muß durch den Namen des Formulares ausgetauscht werden (Name-Attribut des Form-Tags).

d) Identifikator zum Ausführen des Skriptes

Damit das Skript nicht durch einen direkten Aufruf gestartet werden kann, muß noch im Formular die Variable submit eingetragen werden. Der Inhalt der Variablen ist nicht wichtig, da nur auf Existenz geprüft wird.

4. Templates
Die Gestaltung der Templates ist völlig frei. Um die Daten in das Mail-Template einzufügen, werden Platzhalter verwendet. Dabei werden die Variablennamen ohne den Präfix mit <% bzw. %> eingeschlossen. Diese werden dann bei der Verarbeitung durch den entsprechenden Wert der Variablen ersetzt.

Beispiel:
<INPUT TYPE="text" NAME="telefon" SIZE="26" MAXLENGTH="50">
Der Variablenname ist hier 'telefon'. Daraus wird nun der Platzhalter <%telefon%>.

<INPUT TYPE="text" NAME="e_email" SIZE="26" MAXLENGTH="50">
Der Variablenname ist hier 'email' mit dem Präfix 'e_'. Daraus wird nun der Platzhalter <%email%>.

Grundsätzlich ist das Ablageverzeichnis der Templates nicht vorgegeben, wenn die Templates im Formular definiert werden. Werden die Default-Werte vom Skript verwendet, ist das Ablageverzeichnis '_templates' unterhalb vom Modulverzeichnis.

5. Fehler/ Verbesserungen
Sollten Fehler bei Benutzung dieses Skriptes auftreten, bitte uns diese sofort melden (info@ibps-friedrichs.de). Wir werden versuchen diese Fehler so schnell wie möglich zu beseitigen. Bei Verbesserungen am Skript, bitten wir darum uns diese ebenfalls mitzuteilen, damit wir diese für alle anderen Nutzer des Skriptes verfügbar machen können.

6. Nutzung
Das Skript kann frei genutzt bzw. modifiziert werden. Der Copyright-Hinweis muß aber erhalten bleiben. IBPS Friedrichs übernimmt keinerlei Haftung von Schäden, die durch Verwendung dieses Skriptes oder Teilen des Codes entstehen. Der Verkauf des Source-Codes dieses Skriptes ohne schriftliche Einwilligung von IBPS Friedrichs ist nicht erlaubt.

Bitte teilen Sie uns mit, auf welcher Website Sie dieses Skript einsetzen. Wir werden auf unserer Seite einen entsprechenden Link auf Ihre Seite setzen.

7. Versionshinweise

• V 1.03
  • Verarbeitung von Input-Tags, welche Radio-Buttons folgen, ist jetzt korrekt
  • Basispfad wird jetzt korrekt eingetragen
• V 1.02
  • Korrekte Erkennung von Form- und Input-Tags die nicht in Grossbuchstaben geschrieben wurden.
  • Reset- und Submit-Buttons werden nicht mehr ersetzt und als fehlerhafte Eingabe gekennzeichnet.
• V 1.01
  • Bei Select-Feldern werden jetzt ausgewählte Werte bei einer Fehleranzeige gehalten.