... |
... |
@@ -86,13
+86,50 @@ |
86 |
86 |
:; jährlich |
87 |
87 |
:: Der Zähler wird jedes Jahr zum unter (2) und (3) gewählten Tag zu der unter (4) gewählten Uhrzeit zurückgesetzt |
88 |
88 |
|
89 |
|
-=== Allgemeine Rückgabewerte === |
|
89 |
+=== Allgemeine Rückgabeparameter === |
90 |
90 |
|
91 |
91 |
{{figure image="dbcounter_plugin_action_return_parameters_de.png"}} |
92 |
92 |
Einstellungen für die Rückgabeparameter, die später über Platzhalter verfügbar sind. |
93 |
93 |
{{/figure}} |
94 |
94 |
|
95 |
|
-Manchmal ist es notwendig, auf den neuen Zählwert zugreifen zu können. Dies kann über Aktionsplatzhalter geschehen, welche auf die Rückgabewerte einer Aktion zugreifen. In den allgemeinen Rückgabewerten kann eingestellt werden, über welchem Schlüssel die Rückgabewerte der Aktion zugegriffen werden kann. Zum Beispiel: |
|
95 |
+Manchmal ist es notwendig, auf den neuen Zählwert zugreifen zu können. Dies kann über Aktionsplatzhalter geschehen, welche auf die Rückgabewerte einer Aktion zugreifen. In den allgemeinen Rückgabeparametern kann eingestellt werden, über welchem Schlüssel die Rückgabeparameter Aktion zugegriffen werden kann. Beispielsweise trage die Zähleraktion den Namen //CountUp//. Dann kann über den Platzhalter //[%$CountUp.RESULT[0].count%]// auf den aktuellen Zählwert zugegriffen werden, falls unter (3) bei den allgemeinen Rückgabeparameter der Wert //count// eingetragen wurde. Folgende Rückgabeparameter sind verfügbar: |
96 |
96 |
|
97 |
|
-* Die Zähleraktion trägt den Namen //CountUp// |
98 |
|
-* |
|
97 |
+; 1 - ResultCode |
|
98 |
+: Ein nummerischer Zahlenwert, der angibt, ob die Zählaktion erfolgreich war oder nicht. Folgende Ergebnisnummern sind möglich: |
|
99 |
+:; 1 (OK) |
|
100 |
+:: Die Zählaktion wurde erfolgreich abgearbeitet. |
|
101 |
+:; 10 (UNKNOWN_ACTION_ERROR) |
|
102 |
+:: Die Zählaktion kann nicht ausgeführt werden, da eine unbekannte Zählaktion ausgewählt wurde. Aktuell werden die Zählaktionen //Hochzählen//, //Herunterzählen// und //Auf den Startwert zurücksetzen// unterstützt. |
|
103 |
+:; 11 (PARSING_ERROR) |
|
104 |
+:: Ein konfigurierter Wert hat nicht den erwarteten Datentyp, etwa wenn für die Schrittweite des Zählers keine syntaktisch korrekte Zahl eingegeben wurde. |
|
105 |
+:; 40 (INTERNAL_ERROR) |
|
106 |
+:: Es ist ein anderer Fehler aufgetreten, der nicht näher klassifiziert werden kann. |
|
107 |
+; 2 - ResultMessage |
|
108 |
+: Eine englische Beschreibung des Resultats (Erfolg oder Fehler). |
|
109 |
+; 3 - Counter |
|
110 |
+: Der neue nummerische Wert des Zählers, nachdem die Zählaktion ausgeführt wurde. |
|
111 |
+; 4 - IsReset |
|
112 |
+: Entweder //true//, falls der Zähler durch die aktuelle Aktion zurückgesetzt wurde; oder //false//, wenn er nicht zurückgesetzt wurde. |
|
113 |
+; 5 - CounterAfterReset |
|
114 |
+: Falls der Zähler zurückgesetzt wurde: Der nummerische Wert des Zählers vor dem Zurücksetzen. |
|
115 |
+ |
|
116 |
+== Systemplatzhalter-Plugin == |
|
117 |
+ |
|
118 |
+{{figure image="dbcounter-plugin-placeholder_de.png"}} |
|
119 |
+Ein Beispiel für den Platzhalter zum Auslesen des Zählwerts. Hier wird ein Zähler ausgelesen, der die Anzahl an Anmeldungen für eine Veranstaltung zählt. Dann wird geprüft, ob der Zählwert die maximale Anzahl an Anmeldungen übersteigt. Basierend auf dieser Prüfung kann dem Nutzer dann ein Fehler angezeigt werden, falls die Veranstaltung bereits ausgebucht ist. Hierbei handelt es sich um eine serverseitige Prüfung zur Validierung, bereits im Formular bei der Anmeldung sollte dem Nutzer natürlich schon die Information gegeben werden, ob überhaupt noch Plätze frei sind. |
|
120 |
+{{/figure}} |
|
121 |
+ |
|
122 |
+Nach Installation des Plugins ist ein neuer Systemplatzhalter verfügbar, über den auf den aktuellen Wert eines Zählers zugegriffen werden kann. Dies ist etwa nützlich, um in einer Aktionsbedingung den Zählwert nutzen und prüfen zu können. Der Platzhalter baut sich nach dem folgenden Schema auf: |
|
123 |
+ |
|
124 |
+{{code}} |
|
125 |
+[%$DBCOUNTER.<Zählername>%] |
|
126 |
+{{/code}} |
|
127 |
+ |
|
128 |
+Um also etwa auf den Zähler mit dem Name //test// zuzugreifen, muss der folgende Platzhalter genutzt werden: |
|
129 |
+ |
|
130 |
+{{code}} |
|
131 |
+[%$DBCOUNTER.test%] |
|
132 |
+{{/code}} |
|
133 |
+ |
|
134 |
+== Servlet-Aktion-Plugin == |
|
135 |
+ |