Alerts

Die Helper-Class Alerts aus dem Namespace \Helpers stellt diverse Methoden zum Umgang mit Benachrichtigungen bereit. Diese sind nachfolgend gelistet.

Funktionen

Funktion Typ Beschreibung
init(): void public static Die Methode initialisiert die Sitzung mit dem benötigten Sitzungs-Schlüssel (Standard: alerts). Dieser enthält nach der Initialisierung ein leeres Array als Wert.
add(string $message, string $type = "default"): void public static Die Methode fügt eine neue Meldung hinzu, die über die Methode render(int $faVersion = 4): string angezeigt werden kann. Pro Aufruf kann immer nur eine Meldung hinzugefügt werden. Durch den mehrfachen Aufruf ist es möglich mehrere Meldungen anzeigen zu lassen. Die Methode kann verschiedene Meldungsarten ($type) mit einem eigenen Text ($message) erzeugen:

  • default Graue Meldung (z.B. für Hinweise)
  • info Blaue Meldung (z.B. für allgemeine Informationen)
  • success Grüne Meldung (z.B. für erfolgreich abgeschlossene Vorgänge)
  • warning Gelbe Meldung (z.B. für Vorgänge, die noch die Aufmerksamkeit des Nutzers benötigen)
  • danger Rote Meldung (z.B. für fehlgeschlagene Vorgänge)
render(int $faVersion = 4): string public static Die Methode erzeugt HTML Code für alle noch nicht angezeigten Meldungen. Sie kann zwischen den Font Awesome Versionen ($faVersion) 4 und 5 unterscheiden. I.d.R. wird diese Methode automatisch im Fußbereich der Anwendung aufgerufen. Wenn es sich um ein eigenes Theme handelt, kann diese Methode an beliebiger Stelle verwendet werden, um alle offenen Meldungen einmalig auszugeben.