]> git.p6c8.net - form-email.git/blobdiff - readme.htm
Kleine Ergaenzung
[form-email.git] / readme.htm
index 19b225e734b8d317b40866b1bd545215c886abf6..5d8a07990ec5e81dfb2857382e37ca962d5f98dd 100644 (file)
@@ -65,6 +65,14 @@ p
  padding-left: 0.5cm;\r
  padding-right: 0.5cm;\r
 }\r
+pre\r
+{\r
+ padding-left: 0.5cm;\r
+ padding-right: 0.5cm;\r
+ font-family: 'Courier New', Courier, monospace;\r
+ font-size: 10pt;\r
+ color: #0000B0;\r
+}\r
 table\r
 {\r
  font-size: 10pt;\r
@@ -269,6 +277,31 @@ Beispiel: <code>array('HTTP_USER_AGENT','REMOTE_ADDR')</code></td>
 </tr>\r
 </table>\r
 \r
+<p><b>Mails speichern</b></p>\r
+\r
+<table border="1">\r
+<tr>\r
+<td><b>Einstellung</b></td>\r
+<td><b>Beschreibung</b></td>\r
+</tr>\r
+<tr>\r
+<td><code>$store_mails</code></td>\r
+<td>Wenn &gt; 0, speichert <i>Form E-Mail</i> die Mails nach dem Versenden noch auf dem Server als Datei ab.</td>\r
+</tr>\r
+<tr>\r
+<td><code>$store_mails_dir</code></td>\r
+<td>Geben Sie hier das Verzeichnis an, in dem <i>Form E-Mail</i> die Mails speichern soll (Standard ist <i>stored_mails</i>). Die Dateinamen bestehen aus dem Pr&auml;fix, dem Absender, dem Betreff, der Uhrzeit und einem eindeutigen Wert.</td>\r
+</tr>\r
+<tr>\r
+<td><code>$store_mails_prefix</code></td>\r
+<td>Geben Sie hier einen Pr&auml;fix an, der den Dateinamen der gespeicherten Mails vorangestellt werden soll (Standard ist <i>feml_</i>).</td>\r
+</tr>\r
+<tr>\r
+<td><code>$store_mails_max</code></td>\r
+<td>Geben Sie hier die Zahl der Mails an, die maximal aufbewahrt werden sollen. Wenn Sie hier 0 angeben, werden keine Mails gel&ouml;scht. Die Mail-Dateien werden anhand des mit <code>$store_mails_prefix</code> definierten Pr&auml;fixes erkannt.</td>\r
+</tr>\r
+</table>\r
+\r
 <p><b>Captchas</b></p>\r
 \r
 <table border="1">\r
@@ -382,6 +415,18 @@ Beispiel: <code>array('HTTP_USER_AGENT','REMOTE_ADDR')</code></td>
 <td>Der vom Benutzer eingegebene Text ist nicht lang genug</td>\r
 </tr>\r
 <tr>\r
+<td><code>$err_name_long</code></td>\r
+<td>Der vom Benutzer eingegebene Name ist nicht zu lang</td>\r
+</tr>\r
+<tr>\r
+<td><code>$err_subject_long</code></td>\r
+<td>Der vom Benutzer eingegebene Betreff ist zu lang</td>\r
+</tr>\r
+<tr>\r
+<td><code>$err_text_long</code></td>\r
+<td>Der vom Benutzer eingegebene Text ist zu lang</td>\r
+</tr>\r
+<tr>\r
 <td><code>$err_send_error</code></td>\r
 <td>Die Mail konnte nicht versendet werden</td>\r
 </tr>\r
@@ -447,6 +492,87 @@ Beispiel: <code>array('HTTP_USER_AGENT','REMOTE_ADDR')</code></td>
 <p>Seit Version&nbsp;3.5 ist es m&ouml;glich, in <i>Form E-Mail</i> zus&auml;tzlich zu den vorgegebenen Formularfeldern f&uuml;r Name, E-Mail-Adresse, Betreff und Text eigene Formularfelder zu definieren, die dann von <i>Form E-Mail</i> verarbeitet und in die Mail eingef&uuml;gt werden.<br />\r
 Wie <i>Form E-Mail</i> diese Formularfelder behandelt, wird &uuml;ber verschiedene Optionen gesteuert, so ist es m&ouml;glich die L&auml;nge des Inhalts zu pr&uuml;fen, den Inhalt gegen einen regul&auml;ren Ausdruck und gegen eine frei definierbare PHP-Funktion zu pr&uuml;fen und am Ende den Inhalt noch durch eine PHP-Funktion aufzubereiten.</p>\r
 \r
+<p>Die Konfiguration der individuellen Formularfelder geschieht &uuml;ber das PHP-Array <code>$user_fields</code> in <i>config.php</i>. Sie ben&ouml;tigen zun&auml;chst den Namen des Formularfeldes, also das, was Sie im HTML-Formular als Namen angeben. Nehmen wir an, Sie haben folgenden HTML-Code f&uuml;r ein Formularfeld:</p>\r
+\r
+<p><code>&lt;input type=&quot;text&quot; name=&quot;beruf&quot; /&gt;</code></p>\r
+\r
+<p>Der Name des Feldes lautet also <b>beruf</b>. Dies ben&ouml;tigen wir f&uuml;r die weitere Definition.</p>\r
+\r
+<p>Sie k&ouml;nnen nun verschiedene Pr&uuml;fwerte definieren, mit denen <i>Form E-Mail</i> den Inhalt des Formularfeldes &uuml;berpr&uuml;ft und ggf. eine Fehlermeldung ausgibt. Diese werden in der folgenden Tabelle erl&auml;utert (die Tabelle geht der Einfachheit halber weiterhin vom Formularfeld <b>beruf</b> aus - Sie m&uuml;ssen dies nat&uuml;rlich anpassen!):</p>\r
+\r
+<table border="1">\r
+<tr>\r
+<td><b>Einstellung</b></td>\r
+<td><b>Beschreibung</b></td>\r
+</tr>\r
+<tr>\r
+<td><code>$user_fields['beruf']['min']</code></td>\r
+<td>Geben Sie hier an, wie lang der vom Benutzer eingebene Wert mindestens sein muss</td>\r
+</tr>\r
+<tr>\r
+<td><code>$user_fields['beruf']['max']</code></td>\r
+<td>Geben Sie hier an, wie lang der vom Benutzer eingebene Wert h&ouml;chstens sein darf</td>\r
+</tr>\r
+<tr>\r
+<td><code>$user_fields['beruf']['required']</code></td>\r
+<td>Geben Sie hier den Wert 1 an, wenn das Formularfeld ausgef&uuml;llt sein muss. Wenn Sie hier eine 0 oder die Option weglassen, ist das Feld optional.</td>\r
+</tr>\r
+<tr>\r
+<td><code>$user_fields['beruf']['regex']</code></td>\r
+<td>Geben Sie hier einen <a href="http://de.php.net/manual/de/book.pcre.php">Perl-kompatiblen regul&auml;ren Ausdruck</a> zur Pr&uuml;fung des Wertes ein. Der Ausdruck wird direkt an <a href="http://de.php.net/manual/de/function.preg-match.php"><code>preg_match()</code></a> weitergegeben.</td>\r
+</tr>\r
+<tr>\r
+<td><code>$user_fields['beruf']['check']</code></td>\r
+<td>Geben Sie hier eine selbst definierte PHP-Funktion (als Zeichenkette) an, durch die der Wert gepr&uuml;ft werden soll.</td>\r
+</tr>\r
+</table>\r
+\r
+<p>Weiterhin m&uuml;ssen Sie noch diverse Fehlermeldungen definieren (als Unter-Array). Das Definieren dieser Fehlermeldungen ist Pflicht (Sie m&uuml;ssen jedoch nur die Fehlermeldungen zu den Dingen definieren, die auch wirklich gepr&uuml;ft werden).</p>\r
+\r
+<table border="1">\r
+<tr>\r
+<td><b>Einstellung</b></td>\r
+<td><b>Beschreibung</b></td>\r
+</tr>\r
+<tr>\r
+<td><code>$user_fields['beruf']['errors']['too_short']</code></td>\r
+<td>Der vom Benutzer eingegebene Wert ist nicht lang genug</td>\r
+</tr>\r
+<tr>\r
+<td><code>$user_fields['beruf']['errors']['too_long']</code></td>\r
+<td>Der vom Benutzer eingegebene Wert ist zu lang</td>\r
+</tr>\r
+<tr>\r
+<td><code>$user_fields['beruf']['errors']['not_set']</code></td>\r
+<td>Das Formularfeld ist ein Pflichtfeld und es wurde nicht ausgef&uuml;llt.</td>\r
+</tr>\r
+<tr>\r
+<td><code>$user_fields['beruf']['errors']['match_fail']</code></td>\r
+<td>Die &Uuml;berpr&uuml;fung des Wertes durch den regul&auml;ren Ausdruck ist fehlgeschlagen.</td>\r
+</tr>\r
+<tr>\r
+<td><code>$user_fields['beruf']['errors']['check_fail']</code></td>\r
+<td>Die &Uuml;berpr&uuml;fung des Wertes durch die PHP-Funktion ist fehlgeschlagen.</td>\r
+</tr>\r
+</table>\r
+\r
+<p>Zus&auml;tzlich sind noch die folgenden Einstellungen m&ouml;glich:</p>\r
+\r
+<table border="1">\r
+<tr>\r
+<td><b>Einstellung</b></td>\r
+<td><b>Beschreibung</b></td>\r
+</tr>\r
+<tr>\r
+<td><code>$user_fields['beruf']['prepare']</code></td>\r
+<td>Geben Sie hier eine selbst definierte PHP-Funktion (als Zeichenkette) an, die den Wert des Formularfeldes nach den Pr&uuml;fungen noch ver&auml;ndern (bspw. kann man hier Funktionen angeben, die alle Buchstaben in Gro&szlig;buchstaben umwandelt).</td>\r
+</tr>\r
+<tr>\r
+<td><code>$user_fields['beruf']['tpl_var']</code></td>\r
+<td>Geben Sie hier die Template-Variable an, die in den Templates durch den Wert des Formularfeldes ersetzt werden soll. Wenn Sie hier nichts angeben, wird ein Standardwert verwendet (im Fall des Formularfeldes <b>beruf</b> w&auml;re das dann <code>USER_beruf</code>).</td>\r
+</tr>\r
+</table>\r
+\r
 <p class="upanddown"><a href="#top">Nach oben</a></p>\r
 \r
 <h2><a name="templates" id="templates">Templates anpassen</a></h2>\r
@@ -475,6 +601,7 @@ Die Fehlermeldung</li>
 <td><i>mail.txt</i></td>\r
 <td>Legt das Aussehen der Mail fest</td>\r
 <td>\r
+<!-- !!!UNVOLLSTAENDIG!!! -->\r
 <ul>\r
 <li><b>EMAIL</b><br />\r
 Die eingegebene E-Mail-Adresse</li>\r
@@ -488,13 +615,16 @@ Der eingegebene Mail-Text</li>
 Die formatierte Zeitangabe</li>\r
 </ul>\r
 \r
-Zus&auml;tzlich k&ouml;nnen Sie hier durch Variablen, die mit <b>ENV_</b> beginnen, Server-Umgebungsvariablen im Text einf&uuml;gen (siehe auch Konfigurationsvariable <code>$allowed_envs</code>.\r
+Zus&auml;tzlich k&ouml;nnen Sie hier durch Variablen, die mit <b>ENV_</b> beginnen, Server-Umgebungsvariablen im Text einf&uuml;gen (siehe auch Konfigurationsvariable <code>$allowed_envs</code>.<br />\r
+<br />\r
+<b>!!!TODO: Individuelle Formularfelder!!!</b>\r
 </td>\r
 </tr>\r
 <tr>\r
 <td><i>sent.htm</i></td>\r
 <td>Wird angezeigt, wenn die Mail erfolgreich versendet wurde</td>\r
 <td>\r
+<!-- !!!UNVOLLSTAENDIG!!! -->\r
 <ul>\r
 <li><b>EMAIL</b><br />\r
 Die eingegebene E-Mail-Adresse</li>\r
@@ -509,12 +639,14 @@ Der eingegebene Mail-Text</li>
 <li><b>TIME</b><br />\r
 Die formatierte Zeitangabe</li>\r
 </ul>\r
+<b>!!!TODO: Individuelle Formularfelder!!!</b>\r
 </td>\r
 </tr>\r
 <tr>\r
 <td><i>user_error.htm</i></td>\r
 <td>Wird angezeigt, wenn der Benutzer einen Fehler gemacht hat, der sich aber noch beheben l&auml;sst (zum Beispiel wenn ein Formularfeld nicht ausgef&uuml;llt wurde)</td>\r
 <td>\r
+<!-- !!!UNVOLLSTAENDIG!!! -->\r
 <ul>\r
 <li><b>EMAIL</b><br />\r
 Die eingegebene E-Mail-Adresse</li>\r
@@ -530,7 +662,9 @@ Der eingegebene Mail-Text</li>
 \r
 Zus&auml;tzlich ist es m&ouml;glich, einen Bereich, der nur angezeigt werden soll, wenn Captchas aktiviert sind, anzuzeigen, indem Sie diesen in folgenden Block einschlie&szlig;en (der <code>{ELSE}</code>-Teil ist optional):<br />\r
 <br />\r
-<code>{IF CAPTCHA}Captchas sind aktiviert{ELSE}Captchas sind nicht aktiviert{ENDIF}</code>\r
+<code>{IF CAPTCHA}Captchas sind aktiviert{ELSE}Captchas sind nicht aktiviert{ENDIF}</code><br />\r
+<br />\r
+<b>!!!TODO: Individuelle Formularfelder!!!</b>\r
 </td>\r
 </tr>\r
 </table>\r

patrick-canterino.de