Messagebox

Auf dieser Seite... (ausblenden)

  1.   1.  Parameter
  2.   2.  Messagebox auf der Folgeseite anzeigen
  3.   3.  Funktionshinweise
  4.   4.  Screenshots

Die Messageboxen werden verwendet, um in Stud.IP Statusmeldungen jeglicher Art anzuzeigen. Die folgenden fünf Typen der Messagebox gibt es:

  • exception: Nur für Systemfehler. Wird von unhandledExceptions benutzt.
  • error: Für Fehlermeldungen jeder anderen Art. Fehlende Benutzerrechte, Falsche Eingaben etc.
  • warning: Für sämtliche Dinge, die keine echten Fehler sind aber auch nicht einfach als Information/Hinweis abgetan werden sollten (seit Stud.IP 3.5)
  • info: Für allgemeine Hinweise, keine Ergebnisse bei Suchabfragen
  • success: Für Erfolgsbestätigungen. Speicherung, Änderung usw.

§

1.  Parameter

Es können mindestens 1 bis maximal 3 Parameter übergeben werden. Diese haben folgende Bedeutung:

  • $message: Die Hauptnachricht, die in der MessageBox angezeigt werden soll.
  • [$details]: Der 2. Parameter ist optional für zusätzliche Informationen. Diese müssen als Array übergeben werden.
  • [$closed]: Wenn dieser optionalen Parameter true übergeben wird, werden die zusätzlichen Details zugeklappt angezeigt.

§

2.  Messagebox auf der Folgeseite anzeigen

Im Regelfall möchte man die Statusmeldung nicht auf der aktuellen Seite sondern auf der folgenden Seite anzeigen. Dafür gibt es die Methode PageLayout::postMessage(), der eine MessageBox übergeben wird. Der Einfachheit halber gibt es für alle Typen der MessageBox eine passende post<type>-Methode der Klasse PageLayout, wie beispielsweise PageLayout::postSuccess() oder PageLayout::postError(). Die Parameter der Methoden sind analog zu den oben beschriebenen Parametern der Methoden der Klasse MessageBox.

§

3.  Funktionshinweise

  1. // Beispiel für eine einfache Info-Nachricht
  2. echo MessageBox::info('Nachricht');
  3.  
  4. // Beispiel für eine Error-Nachricht mit zusätzlichen Details
  5. echo MessageBox::error('Nachricht', ['optional details', 'more details']);
  6.  
  7. // Beispiel für eine Success-Nachricht mit zusätzlichen Details, die jedoch zugeklappt sind.
  8. echo MessageBox::success('Nachricht', ['optional details'], true);
  9.  
  10. // Beispiel für eine Success-Nachricht auf der folgenden Seite
  11. PageLayout::postSuccess('Folgende Nutzer wurden angelegt', [
  12.     'Max Mustermann',
  13.     'John Doe',
  14. ]);

§

4.  Screenshots

Letzte Änderung am 28.06.2019 11:41 Uhr von tleilax.