Beispiel-Formularfeld in ReadMe-Datei kopiert und erlaeutert

[form-email.git] / readme.htm

diff --git a/readme.htm b/readme.htm
index 7fd79f4fdee5d38f8d5fa9875211d8c2326413c4..5d9375733e5223ab9bd3956bc96a3b12f138247d 100644 (file)
--- a/readme.htm
+++ b/readme.htm
@@ -67,8 +67,8 @@ p
 }\r
 pre\r
 {\r
 }\r
 pre\r
 {\r

- padding-left: 0.5cm;\r
- padding-right: 0.5cm;\r
+ padding-left: 0.7cm;\r
+ padding-right: 0.7cm;\r

  font-family: 'Courier New', Courier, monospace;\r
  font-size: 10pt;\r
  color: #0000B0;\r
  font-family: 'Courier New', Courier, monospace;\r
  font-size: 10pt;\r
  color: #0000B0;\r


@@ -152,7 +152,7 @@ Weiterhin ist noch ein Feld namens <i>recipient</i> m&ouml;glich. Dieses Feld en
 \r
 <p>Geben Sie zwischen den einfachen Anf&uuml;hrungszeichen die Adresse an, an die die Mail gehen soll. Wenn die Mail an mehrere Empf&auml;nger gehen soll, so trennen Sie die einzelnen E-Mail-Adressen ganz einfach durch Semikolons.</p>\r
 \r
 \r
 <p>Geben Sie zwischen den einfachen Anf&uuml;hrungszeichen die Adresse an, an die die Mail gehen soll. Wenn die Mail an mehrere Empf&auml;nger gehen soll, so trennen Sie die einzelnen E-Mail-Adressen ganz einfach durch Semikolons.</p>\r
 \r

-<p>Das war es im Grunde genommen. Aber <i>Form E-Mail</i> l&auml;sst sich noch weiter konfigurieren. Mehr dazu finden Sie in den n&auml;chsten beiden Abschnitten.</p>\r
+<p>Sie haben nun <i>Form E-Mail</i> f&uuml;r die Standard-Nutzung konfiguriert. <i>Form E-Mail</i> l&auml;sst sich jedoch noch feiner konfigurieren. Mehr dazu finden Sie in den n&auml;chsten Abschnitten.</p>\r

 \r
 <p class="upanddown"><a href="#top">Nach oben</a></p>\r
 \r
 \r
 <p class="upanddown"><a href="#top">Nach oben</a></p>\r
 \r


@@ -433,6 +433,10 @@ Beispiel: <code>array('HTTP_USER_AGENT','REMOTE_ADDR')</code></td>
 <td>Die Mail konnte nicht versendet werden</td>\r
 </tr>\r
 <tr>\r
 <td>Die Mail konnte nicht versendet werden</td>\r
 </tr>\r
 <tr>\r

+<td><code>$err_store_error</code></td>\r
+<td>Die Mail konnte nicht gespeichert werden</td>\r
+</tr>\r
+<tr>\r

 <td><code>$err_only_post</code></td>\r
 <td><i>Form E-Mail</i> darf nur mit <tt>POST</tt> aufgerufen werden</td>\r
 </tr>\r
 <td><code>$err_only_post</code></td>\r
 <td><i>Form E-Mail</i> darf nur mit <tt>POST</tt> aufgerufen werden</td>\r
 </tr>\r


@@ -525,7 +529,7 @@ Wie <i>Form E-Mail</i> diese Formularfelder behandelt, wird &uuml;ber verschiede
 </tr>\r
 <tr>\r
 <td><code>$user_fields['beruf']['check']</code></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
+<td>Geben Sie hier eine selbst definierte PHP-Funktion (als Zeichenkette) an, durch die der Wert gepr&uuml;ft werden soll. Das erste und einzige Argument der Funktion ist der Inhalt des Formularfeldes. Die Funktion muss <code>true</code> zur&uuml;ckgeben, wenn der Wert in Ordnung ist, ansonsten <code>false</code>.</td>\r

 </tr>\r
 </table>\r
 \r
 </tr>\r
 </table>\r
 \r


@@ -567,7 +571,7 @@ Wie <i>Form E-Mail</i> diese Formularfelder behandelt, wird &uuml;ber verschiede
 </tr>\r
 <tr>\r
 <td><code>$user_fields['beruf']['prepare']</code></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
+<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). Das erste und einzige Argument der Funktion ist der Inhalt des Formularfeldes. Die Funktion muss den bearbeiteten Wert zur&uuml;ckgeben.</td>\r

 </tr>\r
 <tr>\r
 <td><code>$user_fields['beruf']['tpl_var']</code></td>\r
 </tr>\r
 <tr>\r
 <td><code>$user_fields['beruf']['tpl_var']</code></td>\r


@@ -577,6 +581,49 @@ Wie <i>Form E-Mail</i> diese Formularfelder behandelt, wird &uuml;ber verschiede
 \r
 <p>Sie m&uuml;ssen die individuellen Formularfelder nun noch in Ihrem Mail-Formular und in den <a href="#templates">Templates</a> erg&auml;nzen.</p>\r
 \r
 \r
 <p>Sie m&uuml;ssen die individuellen Formularfelder nun noch in Ihrem Mail-Formular und in den <a href="#templates">Templates</a> erg&auml;nzen.</p>\r
 \r

+<p>Es folgt Beispiel-Konfiguration f&uuml;r ein Formularfeld namens <i>beruf</i>:</p>\r
+\r
+<pre>\r
+$user_fields['beruf']['min'] = 5;\r
+$user_fields['beruf']['max'] = 10;\r
+$user_fields['beruf']['required'] = 1;\r
+$user_fields['beruf']['regex'] = '/^[A-Za-z]+$/';\r
+$user_fields['beruf']['check'] = 'check_beruf';\r
+$user_fields['beruf']['prepare'] = 'prepare_beruf';\r
+$user_fields['beruf']['tpl_var'] = 'BERUF';\r
+\r
+$user_fields['beruf']['errors']['too_short'] = 'Der Beruf muss mind. 5 Zeichen lang sein!';\r
+$user_fields['beruf']['errors']['too_long'] = 'Der Beruf darf höchstens 10 Zeichen lang sein!';\r
+$user_fields['beruf']['errors']['not_set'] = 'Sie haben keinen Beruf eingegeben!';\r
+$user_fields['beruf']['errors']['match_fail'] = 'Der Beruf darf nur aus Buchstaben bestehen!';\r
+$user_fields['beruf']['errors']['check_fail'] = 'Der Beruf sollte keine äöü haben!';\r
+\r
+# Beispiel-Check-Funktion\r
+\r
+function check_beruf($content) {\r
+    if(strpos($content,'ä') !== false) return false;\r
+    if(strpos($content,'ö') !== false) return false;\r
+    if(strpos($content,'ü') !== false) return false;\r
+    \r
+    return true;\r
+}\r
+\r
+# Beispiel-Vorbereitungs-Funktion\r
+\r
+function prepare_beruf($content) {\r
+    return strtolower($content);\r
+}\r
+</pre>\r
+\r
+<p>Das Formularfeld hat die folgenden Eigenschaften:</p>\r
+\r
+<ul>\r
+<li>Der Beruf muss aus mind. 5 Zeichen und max. 10 Zeichen bestehen (<code>min</code> und <code>max</code>)</li>\r
+<li>Es sind nur die Buchstaben A-Z (gro&szlig; und klein) erlaubt (<code>regex</code>)</li>\r
+<li>&Uuml;ber die Pr&uuml;ffunktion <code>check_beruf()</code> wird verhindert, dass &auml;, &ouml; und &uuml; angegeben werden (das wird nat&uuml;rlich auch durch den regul&auml;ren Ausdruck ausgeschlossen, es soll lediglich zur Verdeutlichung dienen)</li>\r
+<li>Durch die Vorbereitungsfunktion <code>prepare_beruf()</code> werden alle Gro&szlig;buchstaben in Kleinbuchstaben umgewandelt</li>\r
+</ul>\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
 <p class="upanddown"><a href="#top">Nach oben</a></p>\r
 \r
 <h2><a name="templates" id="templates">Templates anpassen</a></h2>\r


@@ -618,7 +665,7 @@ Der eingegebene Mail-Text</li>
 Die formatierte Zeitangabe</li>\r
 </ul>\r
 \r
 Die formatierte Zeitangabe</li>\r
 </ul>\r
 \r

-Weiterhin k&ouml;nnen Sie hier die definierten Variablen der <a href="#individuell">individuellen Formularfelder</a> (das, was Sie in <code>tpl_var</code> angegeben) verwenden.<br />\r
+Weiterhin k&ouml;nnen Sie hier die definierten Variablen der <a href="#individuell">individuellen Formularfelder</a> (das, was Sie in <code>tpl_var</code> angegeben haben) verwenden.<br />\r

 <br />\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
 </td>\r
 <br />\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
 </td>\r


@@ -642,7 +689,7 @@ Der eingegebene Mail-Text</li>
 Die formatierte Zeitangabe</li>\r
 </ul>\r
 \r
 Die formatierte Zeitangabe</li>\r
 </ul>\r
 \r

-Weiterhin k&ouml;nnen Sie hier die definierten Variablen der <a href="#individuell">individuellen Formularfelder</a> (das, was Sie in <code>tpl_var</code> angegeben) verwenden.\r
+Weiterhin k&ouml;nnen Sie hier die definierten Variablen der <a href="#individuell">individuellen Formularfelder</a> (das, was Sie in <code>tpl_var</code> angegeben haben) verwenden.\r

 </td>\r
 </tr>\r
 <tr>\r
 </td>\r
 </tr>\r
 <tr>\r


@@ -662,7 +709,7 @@ Der Betreff der Mail</li>
 Der eingegebene Mail-Text</li>\r
 </ul>\r
 \r
 Der eingegebene Mail-Text</li>\r
 </ul>\r
 \r

-Weiterhin k&ouml;nnen Sie hier die definierten Variablen der <a href="#individuell">individuellen Formularfelder</a> (das, was Sie in <code>tpl_var</code> angegeben) verwenden.<br />\r
+Weiterhin k&ouml;nnen Sie hier die definierten Variablen der <a href="#individuell">individuellen Formularfelder</a> (das, was Sie in <code>tpl_var</code> angegeben haben) verwenden.<br />\r

 <br />\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
 <br />\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