Please enable JavaScript to view this site.

Prozess Designer

Navigation: PHP API > Verwenden von Prozessmeldungen

Prozessmeldung lesen (getMessage)

Scroll Zurück Oben Weiter Mehr

Mit dieser Funktion können Sie Prozessmeldungen auslesen. Sie haben dabei die Möglichkeit optional die Sprache anzugeben, in der Sie die Nachricht erhalten möchten. Zudem können Sie Ersetzungen übergeben, falls die jeweilige Prozessmeldung entsprechende Platzhalter enthält.

Parameter

Typ

Beschreibung

$messageName

string

Name der Prozessmeldung

$languageName

string

Sprache, in der die Meldung ausgegeben werden soll (optional)

$replacements

array

Array mit Ersetzungen für die Platzhalter (optional)

Die Funktion liefert als Rückgabe die Prozessnachricht als String. Im Fehlerfall wird eine JobRouterException geworfen.

Wird keine Sprache angegeben, erfolgt die Rückgabe in der Sprache des Benutzers, der den Schritt gesendet hat. Handelt es sich um einen Systemschritt, erfolgt die Rückgabe in der Standardsprache des Prozesses. Wird als zweiter Parameter eine konkrete Sprache angegeben, erfolgt die Ausgabe in dieser Sprache. Ist die angegebene Sprache für die Prozessmeldung nicht gepflegt, wird eine JobRouterException geworfen.

Wenn eine Prozessmeldung definiert wurde, die Platzhalter enthält (z.B. „Der Wert muss zwischen #{x} und #{y} liegen“) können Sie als dritten Parameter ein assoziatives Array mit Ersetzungen für die einzelnen Platzhalter übergeben. Die Struktur des Arrays muss in diesem Beispiel wie folgt aussehen:

$replacements = array('x' => 100, 'y' => 1000);

Hinweis: Wird die Funktion in einer Boxaktionsfunktion verwendet, werden keine prozessbezogene Variablen in der Prozessmeldung ersetzt (z.B. [jr_incident]).

Beispiele:

Prozessmeldung NACHRICHT1:

Deutsch: 'Hier können Sie Ihre Kommentare eintragen'

Englisch: 'Here you can enter your comments'

 

// Auslesen einer Nachricht in der aktuellen Sprache (Deutsch)

$message = $this->getMessage('NACHRICHT1'); // Hier können Sie Ihre Kommentare eintragen

 

// Auslesen einer Nachricht in Englisch

$message = $this->getMessage('NACHRICHT1', 'english'); // Here you can enter your comments

 

Prozessmeldung NACHRICHT2:

Deutsch: 'Der Wert muss größer #{betrag} sein'

Englisch: 'The value should be greater than #{betrag}'

 

// Auslesen einer Nachricht mit Ersetzung des Platzhalters #{betrag}

$replacements = array('betrag' => 100);

$message = $this->getMessage('NACHRICHT2', '', $replacements); // Der Wert muss größer 100 sein