|
jr_execute_dialog_function(string functionId, object userParameters, function successCallback, function errorCallback) |
Scroll Zurück Oben Weiter Mehr |
Mit dieser Funktion können PHP-Funktionen des Typs Dialogfunktion auf dem Server ausgeführt und die Rückgaben anschließend clientseitig ausgewertet werden. Während der Ausführung im Rahmen eines AJAX-Requests werden alle Dialogaktionen deaktiviert.
Parameter |
Typ |
Beschreibung |
|---|---|---|
functionId |
string |
Funktionsname der Dialogfunktion |
userParameters |
object |
Optional: Ein Objekt mit benutzerdefinierten Parametern, auf die in der Dialogfunktion mit |
successCallback |
function |
Optional: Angabe einer Callback-Funktion (siehe Beispiele), die ausgeführt werden soll, sofern die Dialogfunktion und der AJAX-Request erfolgreich ausgeführt wurden. Siehe Beschreibung unten für Details. |
errorCallback |
function |
Optional: Angabe einer Callback-Funktion, die im Fehlerfall (siehe Beispiele) ausgeführt werden soll, sofern ein Fehler während der Ausführung der Dialogfunktion oder des AJAX-Requests aufgetreten ist. Siehe Beschreibung unten für Details |
Beispiel:
function executeDialogFunction() {
jr_execute_dialog_function('phpjrexecutedialog', { param1: 'Wert1', param2: 'Wert2' },
successCallback, errorCallback)
}
function successCallback(returnObject) {
var value1 = returnObject.result.return1;
var value2 = returnObject.result.return2;
}
function errorCallback(returnObject) {
alert(returnObject.message);
}
Im Erfolgsfall wird die Funktion successCallback aufgerufen, die in den Parametern der Funktion jr_execute_dialog_function angegeben ist. Diese Funktion besitzt einen Parameter vom Typ object. Dieses Objekt beinhaltet alle Werte, die in der aufgerufenen PHP-Dialogfunktion per $this->setReturnValue(…) gesetzt worden sind. In der successCallback-Funktion kann man mit dem Punkt-Operator auf einzelne Werte zugreifen.
Im Fehlerfall wird die Funktion errorCallback aufgerufen, die in den Parametern der Funktion jr_execute_dialog_function angegeben ist. Diese Funktion besitzt einen Parameter vom Typ object. Dieses Objekt beinhaltet eine Fehlermeldung, die von der aufgerufenen PHP-Dialogfunktion erstellt worden ist. Um die Fehlermeldung in der Funktion zu verwenden, müssen Sie mit dem Punkt-Operator auf das Return-Objekt zugreifen.
Der Funktionsname der aufzurufenden PHP-Dialogfunktion muss dem beim Aufruf von jr_execute_dialog_function für den Parameter functionId übergebenen Wert entsprechen:
Ein ausführliches Beispiel für das Zusammenspiel der Funktion jr_execute_dialog_function mit einer PHP-Dialogfunktion finden Sie im JobRouter-Handbuch für PHP-Funktionen.
Bitte beachten Sie: Wenn in einem Prozess mehrere JavaScript Skripte mit der Funktion jr_execute_dialog_function vorkommen, muss für eindeutige Namen der Callback-Funktionen gesorgt werden. Sonst kann nicht sichergestellt werden, welche Callback-Funktion aufgerufen wird.
